DOCS-3106: Document CLI usability improvements #3960
Conversation
viambot
added
the
safe to build
✅ Deploy Preview for viam-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
This generally looks good to me, waiting on the changes Naomi asked for before I approve.
I would also ask @stuqdog for a review, since he introduced profiles and made the machine/part flag changes
| viam profiles remove --profile-name=<name-of-profile-to-remove> | ||
| ``` | ||
|
|
||
| Examples: |
There was a problem hiding this comment.
These examples are great for showing how to create and store profiles, but don't highlight how to actually use these profiles. Might be useful to have an example of something like viam --profile=<name-of-profile-to-use> machines list?
| @@ -1191,45 +1244,42 @@ Examples: | |||
| viam machines list | |||
|
|
|||
| # get machine status | |||
| viam machines status --machine=123 --organization="Robot's Org" --location=myLoc | |||
| viam machines status --machine=123 --location=myLoc | |||
There was a problem hiding this comment.
I'm a little unclear about why we don't include organization anymore here, but we include it immediately above? Is the goal for one to be all flags and the other to be only mandatory flags? If so, we can probably get rid of location here as well.
| | `--organization` | Organization name or ID that the machine belongs to | `list`, `status`, `logs`, `part` | **Required** | | ||
| | `--location` | Location name or ID that the machine belongs to or to list machines in | `list`, `status`, `logs`, `part` | **Required** | | ||
| | `--organization` | Organization name or ID that the machine belongs to | `list`, `status`, `logs`, `part` | Optional | | ||
| | `--location` | Location name or ID that the machine belongs to or to list machines in | `list`, `status`, `logs`, `part` | Optional | |
There was a problem hiding this comment.
I'm not sure what command this all is so I may be wrong, but machine below is still listed as Required but we also have part as a flag. I think if part is useful information then machine becomes optional (because machine can often be inferred from part, provided it's given as a part-id).
No description provided.