Skip to content
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.

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

cmd: add dvc update --to-remote docs #2175

Merged
merged 2 commits into from
Feb 18, 2021
Merged
Changes from 1 commit
Commits
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
15 changes: 13 additions & 2 deletions content/docs/command-reference/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ repositories</abbr>, and the corresponding import stage `.dvc` files.
## Synopsis

```usage
usage: dvc update [-h] [-q | -v] [--rev <commit>] [-R]
targets [targets ...]
usage: dvc update [-h] [-q | -v] [--rev <commit>] [-R] [--to-remote]
[-r <name>] [-j <number>] targets [targets ...]

positional arguments:
targets Import stage .dvc files to update. Using -R, directories
Expand Down Expand Up @@ -49,6 +49,17 @@ $ dvc update --rev master
directory and its subdirectories for import stage `.dvc` files to inspect. If
there are no directories among the targets, this option is ignored.

- `--to-remote` - sync the changes directly on the remote storage, rather than
shcheklein marked this conversation as resolved.
Show resolved Hide resolved
on the local <abbr>workspace</abbr>.
shcheklein marked this conversation as resolved.
Show resolved Hide resolved

- `-r <name>`, `--remote <name>` - name of the
[remote storage](/doc/command-reference/remote) (can only be used with
`--to-remote`).

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from the source. The default value is `4 * cpu_count()`. For SSH remotes, the
default is `4`. Using more jobs may speed up the operation.

- `-h`, `--help` - prints the usage/help message, and exit.

- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no
Expand Down