Skip to content

Update cp docs: permissions preserved by default #5180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
btshrewsbury-viam merged 3 commits into from
Jul 13, 2026
Merged

Update cp docs: permissions preserved by default #5180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1c05147
Update cp docs: permissions preserved by default
claude Jul 11, 2026
eed378e
Merge branch 'main' into claude/update-cp-preserve-permissions-2026-0…
btshrewsbury-viam Jul 13, 2026
beec185
Address review: use umask terminology per code author
claude Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/cli/manage-your-fleet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,8 @@ Copy a directory recursively:
viam machines part cp --part=<part-id> -r ./local-dir machine:/home/user/
```

Preserve file permissions and timestamps:
File permissions are preserved by default, respecting the destination `umask`.
Use `--preserve` to also keep modification timestamps and force exact permission bits (overriding the destination `umask`):

```sh {class="command-line" data-prompt="$"}
viam machines part cp --part=<part-id> -r --preserve ./local-dir machine:/home/user/
Expand Down
6 changes: 3 additions & 3 deletions docs/cli/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1260,7 +1260,7 @@ viam machines part cp --part=123 my_file machine:/home/user/
# Recursively copy a directory to a machine:
viam machines part cp --part=123 -r my_dir machine:/home/user/

# Copy multiple files to a machine with recursion and keep original permissions and metadata for the files:
# Copy multiple files to a machine with recursion and preserve exact permissions and timestamps:
viam machines part cp --part=123 -r -p my_dir my_file machine:/home/user/some/existing/dir/

# Copy a single file from a machine to a local destination:
Expand All @@ -1269,7 +1269,7 @@ viam machines part cp --part=123 machine:my_file ~/Downloads/
# Recursively copy a directory from a machine to a local destination:
viam machines part cp --part=123 -r machine:my_dir ~/Downloads/

# Copy multiple files from the machine to a local destination with recursion and keep original permissions and metadata for the files:
# Copy multiple files from the machine to a local destination with recursion and preserve exact permissions and timestamps:
viam machines part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/existing/dir/
```

Expand All @@ -1278,7 +1278,7 @@ viam machines part cp --part=123 -r -p machine:my_dir machine:my_file ~/some/exi
| -------- | ----------- | --------- |
| `--part` | Part ID for which the command is being issued. | **Required** |
| `--recursive`, `-r` | Recursively copy files. Default: `false`. | Optional |
| `--preserve`, `-p` | Preserve modification times and file mode bits from the source files. Default: `false`. | Optional |
| `--preserve`, `-p` | Preserve modification times and set exact file permissions from the source, overriding the destination `umask`. File permissions are always transferred by default; this flag additionally preserves timestamps and forces exact permission bits. Default: `false`. | Optional |

### `machines part tunnel`

Expand Down
Loading