DOCS-3430: Add viam machines part cp command #3905
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
npentrel
commented
Jan 23, 2025
JessamyT
reviewed
Jan 23, 2025
| @@ -1190,6 +1191,24 @@ viam.service.vision.v1.VisionService.GetClassificationsFromCamera | |||
|
|
|||
| # restart a part of a specified machine | |||
| viam machines part restart --machine=123 --part=456 | |||
|
|
|||
There was a problem hiding this comment.
Is there a reason these examples use a space and not an = like the other examples in this code block? Seems they should be consistent with above as well as with the template where you have =<> if both work?
docs/dev/tools/cli.md
Outdated
| @@ -1201,7 +1220,7 @@ viam machines part restart --machine=123 --part=456 | |||
| | `api-key` | Work with an api-key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) | | |||
| | `status` | Retrieve machine status for a specified machine | - | | |||
| | `logs` | Retrieve logs for a specified machine | - | | |||
| | `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell`, `restart` (see [positional arguments: part](#positional-arguments-part)) | | |||
| | `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell`, `restart` (see [positional arguments: part](#positional-arguments-part)), `cp` | | |||
There was a problem hiding this comment.
Suggested change
| | `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell`, `restart` (see [positional arguments: part](#positional-arguments-part)), `cp` | | |
| | `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell`, `restart`, `cp` (see [positional arguments: part](#positional-arguments-part)) | |
I think? And cp should be added to positional args: part?
docs/dev/tools/cli.md
Outdated
| @@ -1190,6 +1191,24 @@ viam.service.vision.v1.VisionService.GetClassificationsFromCamera | |||
|
|
|||
| # restart a part of a specified machine | |||
| viam machines part restart --machine=123 --part=456 | |||
|
|
|||
| # Copy a single file to the machine with a new name: | |||
There was a problem hiding this comment.
Sounds ambiguous as to whether it's the same machine name or file name or directory name. Same comment on the two below.
docs/dev/tools/cli.md
Outdated
| viam machine part cp --organization "org" --location "location" --machine "m1" --part "m1-main" my_file machine:/home/user/ | ||
|
|
||
| # Recursively copy a directory to the machine with the same name: | ||
| viam machine part cp --part "m1-main" -r my_dir machine:/home/user/ |
There was a problem hiding this comment.
If you're using a part name instead of a part ID, per the Slack thread don't you need to pass organization and location? Maybe just make all of these IDs instead of names?
Co-authored-by: JessamyT <[email protected]>
|
You can view a rendered version of the docs from this PR at https://docs-test.viam.dev/3905 |
Co-authored-by: JessamyT <[email protected]>
JessamyT
approved these changes
Jan 24, 2025
docs/dev/tools/cli.md
Outdated
| @@ -1247,6 +1267,8 @@ viam machines part restart --machine=123 --part=456 | |||
| | `--machine-id` | The machine to create an API key for | `api-key` | **Required** | | |||
| | `--name` | The optional name of the API key | `api-key` | Optional | | |||
| | `--org-id` | The optional organization ID to attach the key to | `api-key` | Optional | | |||
| | `--recursive`, `-r` | Preserve modification times and file mode bits from the source files. Default: `false`. | `part cp` | Optional | | |||
There was a problem hiding this comment.
It looks like these two descriptions are swapped
Co-authored-by: JessamyT <[email protected]>
npentrel
commented
Jan 24, 2025
|
🔎💬 Inkeep AI search and chat service is syncing content for source 'Viam Docs (https://docs.viam.com)' |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.