diff --git a/check-help-output.zsh b/check-help-output.zsh new file mode 100755 index 0000000000..bf5364d556 --- /dev/null +++ b/check-help-output.zsh @@ -0,0 +1,60 @@ +#!/bin/zsh + +HELP_TEXT_DIR=help-text +COMMAND_REF_DIR=content/docs/command-reference/ + +# runs the installed dvc, this may be modified to run a particular version in a particular directory +DVC=dvc + +if [ ! -d $HELP_TEXT_DIR ] ; then + mkdir -p $HELP_TEXT_DIR +fi + +# dvc --help + +$DVC --help > ${HELP_TEXT_DIR}/dvc-help.txt + +check_output_diff () { + cmd=$1 + subcmd=$2 + out_f=${HELP_TEXT_DIR}/${cmd}-${subcmd}-help.txt + echo $cmd $subcmd + $DVC ${cmd} ${subcmd} --help > ${out_f} + diff=$(git diff --ignore-all-space ${out_f}) + if [[ -n "${diff}" ]] ; then + git diff ${out_f} + response="" + while [[ ( ("$response" != "y") && ("$response" != "n") ) ]] ; do + vared -p "Create Github issue for this change? [y/n]" response + done + if [[ "$response" == "y" ]] ; then + diff=$(git diff ${out_f} | tail -n +7) + the_body="The diff in the command output is\\n\`\`\`diff\\n${diff}\\n\`\`\`" + echo "$the_body" + gh issue create --title "cmd: [auto] changes in \`dvc ${cmd} ${subcmd} --help\` should be reflected to command reference" --body "${the_body}" + fi + # git add ${f} + # git commit -m "[auto] updated help output for ${f}" + fi +} + +for d in ${COMMAND_REF_DIR}/*(/) ; do + for f in ${d}/*.md ; do + if [[ ${f:t} == "index.md" ]] ; then + continue + fi + cmd=${d:t} + subcmd=${f:r:t} + check_output_diff $cmd $subcmd + done +done + +for f in ${COMMAND_REF_DIR}/*.md ; do + if [[ ${f:t} == "index.md" ]] ; then + continue + fi + cmd=${f:r:t} + check_output_diff $cmd +done + + diff --git a/help-text/add--help.txt b/help-text/add--help.txt new file mode 100644 index 0000000000..ee13fcd27a --- /dev/null +++ b/help-text/add--help.txt @@ -0,0 +1,19 @@ +usage: dvc add [-h] [-q | -v] [-R] [--no-commit] [--external] [--glob] + [--file ] [--desc ] + targets [targets ...] + +Track data files or directories with DVC. +Documentation: + +positional arguments: + targets Input files/directories to add. + +optional arguments: + -h, --help show this help message and exit + -R, --recursive Recursively add files under directory targets. + --no-commit Don't put files/directories into cache. + --external Allow targets that are outside of the DVC repository. + --glob Allows targets containing shell-style wildcards. + --file Specify name of the DVC-file this command will generate. + --desc User description of the data (optional). This doesn't + affect any DVC operations. diff --git a/help-text/cache-dir-help.txt b/help-text/cache-dir-help.txt new file mode 100644 index 0000000000..8220d3f910 --- /dev/null +++ b/help-text/cache-dir-help.txt @@ -0,0 +1,20 @@ +usage: dvc cache dir [-h] [-q | -v] [--global | --system | --local] [-u] + [value] + +Manage cache settings. +Documentation: + +positional arguments: + value Path to cache directory. Relative paths are resolved relative + to the current directory and saved to config relative to the + config file location. If no path is provided, it returns the + current cache directory. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --global Use global config. + --system Use system config. + --local Use local config. + -u, --unset Unset option. diff --git a/help-text/check-ignore--help.txt b/help-text/check-ignore--help.txt new file mode 100644 index 0000000000..78e70293fb --- /dev/null +++ b/help-text/check-ignore--help.txt @@ -0,0 +1,20 @@ +usage: dvc check-ignore [-h] [-q | -v] [-d] [-a] [-n] [--stdin] + [targets [targets ...]] + +Check whether files or directories are excluded due to `.dvcignore`. +Documentation: + +positional arguments: + targets File or directory paths to check + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -d, --details Show the exclude patterns along with each target path. + -a, --all Include the target paths which don’t match any pattern + in the `--details` list. + -n, --non-matching Include the target paths which don’t match any pattern + in the `--details` list. + --stdin Read paths from standard input instead of providing + `targets`. diff --git a/help-text/checkout--help.txt b/help-text/checkout--help.txt new file mode 100644 index 0000000000..42b3bd7f22 --- /dev/null +++ b/help-text/checkout--help.txt @@ -0,0 +1,19 @@ +usage: dvc checkout [-h] [-q | -v] [--summary] [-d] [-R] [-f] [--relink] + [targets [targets ...]] + +Checkout data files from cache. +Documentation: + +positional arguments: + targets Limit command scope to these tracked files/directories, + .dvc files, or stage names. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --summary Show summary of the changes. + -d, --with-deps Checkout all dependencies of the specified target. + -R, --recursive Checkout all subdirectories of the specified directory. + -f, --force Do not prompt when removing working directory files. + --relink Recreate links or copies from cache to workspace. diff --git a/help-text/commit--help.txt b/help-text/commit--help.txt new file mode 100644 index 0000000000..4e7c5d4f5e --- /dev/null +++ b/help-text/commit--help.txt @@ -0,0 +1,16 @@ +usage: dvc commit [-h] [-q | -v] [-f] [-d] [-R] [targets [targets ...]] + +Save changed data to cache and update DVC-files. +Documentation: + +positional arguments: + targets DVC-files to commit. Optional. (Finds all DVC-files in the + workspace by default.) + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -f, --force Commit even if hash value for dependencies/outputs changed. + -d, --with-deps Commit all dependencies of the specified target. + -R, --recursive Commit cache for subdirectories of the specified directory. diff --git a/help-text/config--help.txt b/help-text/config--help.txt new file mode 100644 index 0000000000..418d54f9e4 --- /dev/null +++ b/help-text/config--help.txt @@ -0,0 +1,18 @@ +usage: dvc config [-h] [--global | --system | --local] [-q | -v] [-u] + name [value] + +Get or set config options. +Documentation: + +positional arguments: + name Option name (remote.name.option or section.option). + value Option value. + +optional arguments: + -h, --help show this help message and exit + --global Use global config. + --system Use system config. + --local Use local config. + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -u, --unset Unset option. diff --git a/help-text/dag--help.txt b/help-text/dag--help.txt new file mode 100644 index 0000000000..b5159571f1 --- /dev/null +++ b/help-text/dag--help.txt @@ -0,0 +1,17 @@ +usage: dvc dag [-h] [-q | -v] [--dot] [--full] [-o] [target] + +Visualize DVC project DAG. +Documentation: + +positional arguments: + target Stage or output to show pipeline for (optional). Finds all + stages in the workspace by default. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --dot Print DAG with .dot format. + --full Show full DAG that the target belongs too, instead of showing + DAG consisting only of ancestors. + -o, --outs Print output files instead of stages. diff --git a/help-text/destroy--help.txt b/help-text/destroy--help.txt new file mode 100644 index 0000000000..a26e3450dc --- /dev/null +++ b/help-text/destroy--help.txt @@ -0,0 +1,10 @@ +usage: dvc destroy [-h] [-q | -v] [-f] + +Remove DVC-files, local DVC config and data cache. +Documentation: + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -f, --force Force destruction. diff --git a/help-text/diff--help.txt b/help-text/diff--help.txt new file mode 100644 index 0000000000..d9f9a00487 --- /dev/null +++ b/help-text/diff--help.txt @@ -0,0 +1,20 @@ +usage: dvc diff [-h] [-q | -v] [--show-json] [--show-hash] [--show-md] + [--hide-missing] + [a_rev] [b_rev] + +Show added, modified, or deleted data between commits in the DVC repository, or between a commit and the workspace. +Documentation: + +positional arguments: + a_rev Old Git commit to compare (defaults to HEAD) + b_rev New Git commit to compare (defaults to the current + workspace) + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --show-json Format the output into a JSON + --show-hash Display hash value for each entry + --show-md Show tabulated output in the Markdown format (GFM). + --hide-missing Hide missing cache file status. diff --git a/help-text/doctor--help.txt b/help-text/doctor--help.txt new file mode 100644 index 0000000000..76c9621b13 --- /dev/null +++ b/help-text/doctor--help.txt @@ -0,0 +1,9 @@ +usage: dvc version [-h] [-q | -v] + +Display the DVC version and system/environment information. +Documentation: + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/dvc-help.txt b/help-text/dvc-help.txt new file mode 100644 index 0000000000..b67837f10c --- /dev/null +++ b/help-text/dvc-help.txt @@ -0,0 +1,50 @@ +usage: dvc [-q | -v] [-h] [-V] [--cd ] COMMAND ... + +Data Version Control + +optional arguments: + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -h, --help Show this help message and exit. + -V, --version Show program's version. + --cd Change to directory before executing. + +Available Commands: + COMMAND Use `dvc COMMAND --help` for command-specific help. + init Initialize DVC in the current directory. + get Download file or directory tracked by DVC or by Git. + get-url Download or copy files from URL. + destroy Remove DVC-files, local DVC config and data cache. + add Track data files or directories with DVC. + remove Remove stages or .dvc files, unprotect their outputs, and erase .gitignore entries. + move Rename or move a DVC controlled data file or a directory. + unprotect Unprotect tracked files or directories (when hardlinks or symlinks have been enabled with `dvc config cache.type`) + run Generate a stage file from a command and execute the command. + repro Reproduce complete or partial pipelines by executing their stages. + pull Download tracked files or directories from remote storage. + push Upload tracked files or directories to remote storage. + fetch Download cached files or directories from remote storage. + status Show changed stages, compare local cache and a remote storage. + gc Garbage collect unused objects from cache or remote storage. + import Download file or directory tracked by DVC or by Git into the workspace, and track it. + import-url Download or copy file from URL and take it under DVC control. + config Get or set config options. + checkout Checkout data files from cache. + remote Set up and manage data remotes. + cache Manage cache settings. + metrics Commands to display and compare metrics. + params Commands to display params. + install Install DVC git hooks into the repository. + root Return the relative path to the root of the DVC project. + list List repository contents, including files and directories tracked by DVC and by Git. + freeze Freeze stages or .dvc files. + unfreeze Unfreeze stages or .dvc files. + dag Visualize DVC project DAG. + commit Save changed data to cache and update DVC-files. + completion Generate shell tab completion. + diff Show added, modified, or deleted data between commits in the DVC repository, or between a commit and the workspace. + version (doctor) + Display the DVC version and system/environment information. + update Update data artifacts imported from other DVC repositories. + plots Commands to visualize and compare plot metrics in structured files (JSON, YAML, CSV, TSV) + check-ignore Check whether files or directories are excluded due to `.dvcignore`. diff --git a/help-text/fetch--help.txt b/help-text/fetch--help.txt new file mode 100644 index 0000000000..dbcc7b4f7c --- /dev/null +++ b/help-text/fetch--help.txt @@ -0,0 +1,28 @@ +usage: dvc fetch [-h] [-q | -v] [-j ] [-r ] [-a] [-T] + [--all-commits] [-d] [-R] [--run-cache] + [targets [targets ...]] + +Download cached files or directories from remote storage. +Documentation: + +positional arguments: + targets Limit command scope to these tracked + files/directories, .dvc files, or stage names. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -j , --jobs + Number of jobs to run simultaneously. The default + value is 4 * cpu_count(). For SSH remotes, the default + is 4. + -r , --remote + Remote storage to fetch from + -a, --all-branches Fetch cache for all branches. + -T, --all-tags Fetch cache for all tags. + --all-commits Fetch cache for all commits. + -d, --with-deps Fetch cache for all dependencies of the specified + target. + -R, --recursive Fetch cache for subdirectories of specified directory. + --run-cache Fetch run history for all stages. diff --git a/help-text/freeze--help.txt b/help-text/freeze--help.txt new file mode 100644 index 0000000000..243fc11195 --- /dev/null +++ b/help-text/freeze--help.txt @@ -0,0 +1,12 @@ +usage: dvc freeze [-h] [-q | -v] targets [targets ...] + +Freeze stages or .dvc files. +Documentation: + +positional arguments: + targets Stages or .dvc files to freeze + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/gc--help.txt b/help-text/gc--help.txt new file mode 100644 index 0000000000..66daf30321 --- /dev/null +++ b/help-text/gc--help.txt @@ -0,0 +1,28 @@ +usage: dvc gc [-h] [-q | -v] [-w] [-a] [-T] [--all-commits] [-c] [-r ] + [-f] [-j ] [-p [ [ ...]]] + +Removes all files in the cache or a remote which are not in +use by the specified Git revisions (defaults to just HEAD). +Documentation: + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -w, --workspace Keep data files used in the current workspace. + -a, --all-branches Keep data files for the tips of all Git branches. + -T, --all-tags Keep data files for all Git tags. + --all-commits Keep data files for all Git commits. + -c, --cloud Collect garbage in remote repository. + -r , --remote + Remote storage to collect garbage in + -f, --force Force garbage collection - automatically agree to all + prompts. + -j , --jobs + Number of jobs to run simultaneously. The default + value is 4 * cpu_count(). For SSH remotes, the default + is 4. + -p [ [ ...]], --projects [ [ ...]] + Keep data files required by these projects in addition + to the current one. Useful if you share a single cache + across repos. diff --git a/help-text/get--help.txt b/help-text/get--help.txt new file mode 100644 index 0000000000..30a57a97e5 --- /dev/null +++ b/help-text/get--help.txt @@ -0,0 +1,19 @@ +usage: dvc get [-h] [-q | -v] [-o []] [--rev []] [--show-url] + url path + +Download file or directory tracked by DVC or by Git. +Documentation: + +positional arguments: + url Location of DVC or Git repository to download from + path Path to a file or directory within the repository + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -o [], --out [] + Destination path to download files to + --rev [] Git revision (e.g. SHA, branch, tag) + --show-url Print the storage location (URL) the target data would + be downloaded from, and exit. diff --git a/help-text/get-url--help.txt b/help-text/get-url--help.txt new file mode 100644 index 0000000000..d961405aeb --- /dev/null +++ b/help-text/get-url--help.txt @@ -0,0 +1,13 @@ +usage: dvc get-url [-h] [-q | -v] url [out] + +Download or copy files from URL. +Documentation: + +positional arguments: + url See `dvc import-url -h` for full list of supported URLs. + out Destination path to put data to. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/import--help.txt b/help-text/import--help.txt new file mode 100644 index 0000000000..495921d0c2 --- /dev/null +++ b/help-text/import--help.txt @@ -0,0 +1,21 @@ +usage: dvc import [-h] [-q | -v] [-o []] [--rev []] + [--file ] [--no-exec] [--desc ] + url path + +Download file or directory tracked by DVC or by Git into the workspace, and track it. +Documentation: + +positional arguments: + url Location of DVC or Git repository to download from + path Path to a file or directory within the repository + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -o [], --out [] + Destination path to download files to + --rev [] Git revision (e.g. SHA, branch, tag) + --file Specify name of the DVC-file this command will generate. + --no-exec Only create DVC-file without actually downloading it. + --desc User description of the data (optional). This doesn't affect any DVC operations. diff --git a/help-text/import-url--help.txt b/help-text/import-url--help.txt new file mode 100644 index 0000000000..3ee27aad93 --- /dev/null +++ b/help-text/import-url--help.txt @@ -0,0 +1,27 @@ +usage: dvc import-url [-h] [-q | -v] [--file ] [--no-exec] + [--desc ] + url [out] + +Download or copy file from URL and take it under DVC control. +Documentation: + +positional arguments: + url Location of the data to download. Supported URLs: + /absolute/path/to/file/or/dir + relative/path/to/file/or/dir + C:\\path\to\file\or\dir + https://example.com/path/to/file + s3://bucket/key/path + gs://bucket/path/to/file/or/dir + hdfs://example.com/path/to/file + ssh://example.com/absolute/path/to/file/or/dir + remote://remote_name/path/to/file/or/dir (see `dvc remote`) + out Destination path to put files to. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --file Specify name of the DVC-file this command will generate. + --no-exec Only create DVC-file without actually downloading it. + --desc User description of the data (optional). This doesn't affect any DVC operations. diff --git a/help-text/init--help.txt b/help-text/init--help.txt new file mode 100644 index 0000000000..f0f096b853 --- /dev/null +++ b/help-text/init--help.txt @@ -0,0 +1,16 @@ +usage: dvc init [-h] [-q | -v] [--no-scm] [-f] [--subdir] + +Initialize DVC in the current directory. Expects directory +to be a Git repository unless --no-scm option is specified. +Documentation: + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --no-scm Initiate DVC in directory that is not tracked by any SCM tool + (e.g. Git). + -f, --force Overwrite existing '.dvc/' directory. This operation removes + local cache. + --subdir Necessary for running this command inside a subdirectory of a + parent SCM repository. diff --git a/help-text/install--help.txt b/help-text/install--help.txt new file mode 100644 index 0000000000..9d748e18f6 --- /dev/null +++ b/help-text/install--help.txt @@ -0,0 +1,12 @@ +usage: dvc install [-h] [-q | -v] [--use-pre-commit-tool] + +Install DVC git hooks into the repository. +Documentation: + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --use-pre-commit-tool + Install DVC hooks using pre-commit (https://pre- + commit.com) if it is installed. diff --git a/help-text/list--help.txt b/help-text/list--help.txt new file mode 100644 index 0000000000..87e3f05566 --- /dev/null +++ b/help-text/list--help.txt @@ -0,0 +1,16 @@ +usage: dvc list [-h] [-q | -v] [-R] [--dvc-only] [--rev []] url [path] + +List repository contents, including files and directories tracked by DVC and by Git. +Documentation: + +positional arguments: + url Location of DVC repository to list + path Path to directory within the repository to list outputs for + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -R, --recursive Recursively list files. + --dvc-only Show only DVC outputs. + --rev [] Git revision (e.g. SHA, branch, tag) diff --git a/help-text/metrics-diff-help.txt b/help-text/metrics-diff-help.txt new file mode 100644 index 0000000000..9c34c7ac61 --- /dev/null +++ b/help-text/metrics-diff-help.txt @@ -0,0 +1,29 @@ +usage: dvc metrics diff [-h] [-q | -v] [--targets [ [ ...]]] + [-R] [--all] [--show-json] [--show-md] [--no-path] + [--precision ] + [a_rev] [b_rev] + +Show changes in metrics between commits in the DVC repository, or between a commit and the workspace. +Documentation: + +positional arguments: + a_rev Old Git commit to compare (defaults to HEAD) + b_rev New Git commit to compare (defaults to the current + workspace) + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --targets [ [ ...]] + Limit command scope to these metrics files. Using -R, + directories to search metrics files in can also be + given. + -R, --recursive If any target is a directory, recursively search and + process metrics files. + --all Show unchanged metrics as well. + --show-json Show output in JSON format. + --show-md Show tabulated output in the Markdown format (GFM). + --no-path Don't show metric path. + --precision Round metrics to `n` digits precision after the + decimal point. Rounds to 5 digits by default. diff --git a/help-text/metrics-show-help.txt b/help-text/metrics-show-help.txt new file mode 100644 index 0000000000..04766f1d63 --- /dev/null +++ b/help-text/metrics-show-help.txt @@ -0,0 +1,22 @@ +usage: dvc metrics show [-h] [-q | -v] [-a] [-T] [--all-commits] [--show-json] + [-R] + [targets [targets ...]] + +Print metrics, with optional formatting. +Documentation: + +positional arguments: + targets Limit command scope to these metrics files. Using -R, + directories to search metrics files in can also be + given. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -a, --all-branches Show metrics for all branches. + -T, --all-tags Show metrics for all tags. + --all-commits Show metrics for all commits. + --show-json Show output in JSON format. + -R, --recursive If any target is a directory, recursively search and + process metrics files. diff --git a/help-text/move--help.txt b/help-text/move--help.txt new file mode 100644 index 0000000000..69a00dffe1 --- /dev/null +++ b/help-text/move--help.txt @@ -0,0 +1,14 @@ +usage: dvc move [-h] [-q | -v] src dst + +Rename or move a DVC controlled data file or a directory. +It renames and modifies the corresponding DVC-file to reflect the changes. +Documentation: + +positional arguments: + src Source path to a data file or directory. + dst Destination path. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/params-diff-help.txt b/help-text/params-diff-help.txt new file mode 100644 index 0000000000..5f1f817801 --- /dev/null +++ b/help-text/params-diff-help.txt @@ -0,0 +1,19 @@ +usage: dvc params diff [-h] [-q | -v] [--all] [--show-json] [--show-md] + [--no-path] + [a_rev] [b_rev] + +Show changes in params between commits in the DVC repository, or between a commit and the workspace. +Documentation: + +positional arguments: + a_rev Old Git commit to compare (defaults to HEAD) + b_rev New Git commit to compare (defaults to the current workspace) + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --all Show unchanged params as well. + --show-json Show output in JSON format. + --show-md Show tabulated output in the Markdown format (GFM). + --no-path Don't show params path. diff --git a/help-text/plots-diff-help.txt b/help-text/plots-diff-help.txt new file mode 100644 index 0000000000..5d8e54d331 --- /dev/null +++ b/help-text/plots-diff-help.txt @@ -0,0 +1,33 @@ +usage: dvc plots diff [-h] [-q | -v] [--targets [ [ ...]]] + [-t []] [-x ] [-y ] [--no-header] + [--title ] [--x-label ] [--y-label ] + [-o ] [--show-vega] + [revisions [revisions ...]] + +Show multiple versions of plot metrics by plotting them in a single image. +Documentation: + +positional arguments: + revisions Git commits to plot from + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --targets [ [ ...]] + Files to visualize (supports any file, even when not + found as `plots` in `dvc.yaml`). Shows all plots by + default. + -t [], --template [] + Special JSON or HTML schema file to inject with the + data. See + -x Field name for X axis. + -y Field name for Y axis. + --no-header Provided CSV or TSV datafile does not have a header. + --title Plot title. + --x-label X axis label + --y-label Y axis label + -o , --out + Destination path to save plots to + --show-vega Show output in Vega format. diff --git a/help-text/plots-modify-help.txt b/help-text/plots-modify-help.txt new file mode 100644 index 0000000000..df21664160 --- /dev/null +++ b/help-text/plots-modify-help.txt @@ -0,0 +1,28 @@ +usage: dvc plots modify [-h] [-q | -v] [-t []] [-x ] [-y ] + [--no-header] [--title ] [--x-label ] + [--y-label ] + [--unset [ [ ...]]] + target + +Modify display properties of plot metrics files. +Documentation: + +positional arguments: + target Metric file to set properties to + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -t [], --template [] + Special JSON or HTML schema file to inject with the + data. See + -x Field name for X axis. + -y Field name for Y axis. + --no-header Provided CSV or TSV datafile does not have a header. + --title Plot title. + --x-label X axis label + --y-label Y axis label + --unset [ [ ...]] + Unset one or more display properties. diff --git a/help-text/plots-show-help.txt b/help-text/plots-show-help.txt new file mode 100644 index 0000000000..c87ace72cb --- /dev/null +++ b/help-text/plots-show-help.txt @@ -0,0 +1,30 @@ +usage: dvc plots show [-h] [-q | -v] [-t []] [-x ] [-y ] + [--no-header] [--title ] [--x-label ] + [--y-label ] [-o ] [--show-vega] + [targets [targets ...]] + +Generate plots from metrics files. +Documentation: + +positional arguments: + targets Files to visualize (supports any file, even when not + found as `plots` in `dvc.yaml`). Shows all plots by + default. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -t [], --template [] + Special JSON or HTML schema file to inject with the + data. See + -x Field name for X axis. + -y Field name for Y axis. + --no-header Provided CSV or TSV datafile does not have a header. + --title Plot title. + --x-label X axis label + --y-label Y axis label + -o , --out + Destination path to save plots to + --show-vega Show output in Vega format. diff --git a/help-text/pull--help.txt b/help-text/pull--help.txt new file mode 100644 index 0000000000..6a7432f5a7 --- /dev/null +++ b/help-text/pull--help.txt @@ -0,0 +1,30 @@ +usage: dvc pull [-h] [-q | -v] [-j ] [-r ] [-a] [-T] + [--all-commits] [-f] [-d] [-R] [--run-cache] + [targets [targets ...]] + +Download tracked files or directories from remote storage. +Documentation: + +positional arguments: + targets Limit command scope to these tracked + files/directories, .dvc files, or stage names. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -j , --jobs + Number of jobs to run simultaneously. The default + value is 4 * cpu_count(). For SSH remotes, the default + is 4. + -r , --remote + Remote storage to pull from + -a, --all-branches Fetch cache for all branches. + -T, --all-tags Fetch cache for all tags. + --all-commits Fetch cache for all commits. + -f, --force Do not prompt when removing working directory files. + -d, --with-deps Fetch cache for all dependencies of the specified + target. + -R, --recursive Pull cache for subdirectories of the specified + directory. + --run-cache Fetch run history for all stages. diff --git a/help-text/push--help.txt b/help-text/push--help.txt new file mode 100644 index 0000000000..f5b9ffbdb7 --- /dev/null +++ b/help-text/push--help.txt @@ -0,0 +1,28 @@ +usage: dvc push [-h] [-q | -v] [-j ] [-r ] [-a] [-T] + [--all-commits] [-d] [-R] [--run-cache] + [targets [targets ...]] + +Upload tracked files or directories to remote storage. +Documentation: + +positional arguments: + targets Limit command scope to these tracked + files/directories, .dvc files, or stage names. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -j , --jobs + Number of jobs to run simultaneously. The default + value is 4 * cpu_count(). For SSH remotes, the default + is 4. + -r , --remote + Remote storage to push to + -a, --all-branches Push cache for all branches. + -T, --all-tags Push cache for all tags. + --all-commits Push cache for all commits. + -d, --with-deps Push cache for all dependencies of the specified + target. + -R, --recursive Push cache for subdirectories of specified directory. + --run-cache Push run history for all stages. diff --git a/help-text/remote-add-help.txt b/help-text/remote-add-help.txt new file mode 100644 index 0000000000..0fc26a1998 --- /dev/null +++ b/help-text/remote-add-help.txt @@ -0,0 +1,20 @@ +usage: dvc remote add [-h] [--global | --system | --local] [-q | -v] [-d] [-f] + name url + +Add a new data remote. +Documentation: + +positional arguments: + name Name of the remote + url Remote location. See full list of supported URLs at + + +optional arguments: + -h, --help show this help message and exit + --global Use global config. + --system Use system config. + --local Use local config. + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -d, --default Set as default remote. + -f, --force Force overwriting existing configs diff --git a/help-text/remote-default-help.txt b/help-text/remote-default-help.txt new file mode 100644 index 0000000000..176efe46c1 --- /dev/null +++ b/help-text/remote-default-help.txt @@ -0,0 +1,17 @@ +usage: dvc remote default [-h] [--global | --system | --local] [-q | -v] [-u] + [name] + +Set/unset the default data remote. +Documentation: + +positional arguments: + name Name of the remote + +optional arguments: + -h, --help show this help message and exit + --global Use global config. + --system Use system config. + --local Use local config. + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -u, --unset Unset default remote. diff --git a/help-text/remote-list-help.txt b/help-text/remote-list-help.txt new file mode 100644 index 0000000000..2c6d70d26a --- /dev/null +++ b/help-text/remote-list-help.txt @@ -0,0 +1,12 @@ +usage: dvc remote list [-h] [--global | --system | --local] [-q | -v] + +List all available data remotes. +Documentation: + +optional arguments: + -h, --help show this help message and exit + --global Use global config. + --system Use system config. + --local Use local config. + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/remote-modify-help.txt b/help-text/remote-modify-help.txt new file mode 100644 index 0000000000..bae6bbeefa --- /dev/null +++ b/help-text/remote-modify-help.txt @@ -0,0 +1,19 @@ +usage: dvc remote modify [-h] [--global | --system | --local] [-q | -v] [-u] + name option [value] + +Modify the configuration of a data remote. +Documentation: + +positional arguments: + name Name of the remote + option Name of the option to modify. + value (optional) Value of the option. + +optional arguments: + -h, --help show this help message and exit + --global Use global config. + --system Use system config. + --local Use local config. + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -u, --unset Unset option. diff --git a/help-text/remote-remove-help.txt b/help-text/remote-remove-help.txt new file mode 100644 index 0000000000..a672791171 --- /dev/null +++ b/help-text/remote-remove-help.txt @@ -0,0 +1,15 @@ +usage: dvc remote remove [-h] [--global | --system | --local] [-q | -v] name + +Remove a data remote. +Documentation: + +positional arguments: + name Name of the remote to remove. + +optional arguments: + -h, --help show this help message and exit + --global Use global config. + --system Use system config. + --local Use local config. + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/remote-rename-help.txt b/help-text/remote-rename-help.txt new file mode 100644 index 0000000000..1c2de7d74a --- /dev/null +++ b/help-text/remote-rename-help.txt @@ -0,0 +1,17 @@ +usage: dvc remote rename [-h] [--global | --system | --local] [-q | -v] + name new + +Rename a DVC remote +Documentation: + +positional arguments: + name Remote to be renamed + new New name of the remote + +optional arguments: + -h, --help show this help message and exit + --global Use global config. + --system Use system config. + --local Use local config. + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/remove--help.txt b/help-text/remove--help.txt new file mode 100644 index 0000000000..e4496053d0 --- /dev/null +++ b/help-text/remove--help.txt @@ -0,0 +1,13 @@ +usage: dvc remove [-h] [-q | -v] [--outs] targets [targets ...] + +Remove stages or .dvc files, unprotect their outputs, and erase .gitignore entries. +Documentation: + +positional arguments: + targets DVC-files to remove. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --outs Remove outputs as well. diff --git a/help-text/repro--help.txt b/help-text/repro--help.txt new file mode 100644 index 0000000000..585622561b --- /dev/null +++ b/help-text/repro--help.txt @@ -0,0 +1,40 @@ +usage: dvc repro [-h] [-q | -v] [-f] [-s] [-c ] [-m] [--dry] [-i] [-p] + [-P] [-R] [--no-run-cache] [--force-downstream] [--no-commit] + [--downstream] [--pull] [--glob] + [targets [targets ...]] + +Reproduce complete or partial pipelines by executing their stages. +Documentation: + +positional arguments: + targets Stages to reproduce. 'dvc.yaml' by default. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -f, --force Reproduce even if dependencies were not changed. + -s, --single-item Reproduce only single data item without recursive + dependencies check. + -c , --cwd + Directory within your repo to reproduce from. Note: + deprecated by `dvc --cd `. + -m, --metrics Show metrics after reproduction. + --dry Only print the commands that would be executed without + actually executing. + -i, --interactive Ask for confirmation before reproducing each stage. + -p, --pipeline Reproduce the whole pipeline that the specified stage + file belongs to. + -P, --all-pipelines Reproduce all pipelines in the repo. + -R, --recursive Reproduce all stages in the specified directory. + --no-run-cache Execute stage commands even if they have already been + run with the same command/dependencies/outputs/etc + before. + --force-downstream Reproduce all descendants of a changed stage even if + their direct dependencies didn't change. + --no-commit Don't put files/directories into cache. + --downstream Start from the specified stages when reproducing + pipelines. + --pull Try automatically pulling missing cache for outputs + restored from the run-cache. + --glob Allows targets containing shell-style wildcards. diff --git a/help-text/root--help.txt b/help-text/root--help.txt new file mode 100644 index 0000000000..ef7bb60bbf --- /dev/null +++ b/help-text/root--help.txt @@ -0,0 +1,9 @@ +usage: dvc root [-h] [-q | -v] + +Return the relative path to the root of the DVC project. +Documentation: + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/run--help.txt b/help-text/run--help.txt new file mode 100644 index 0000000000..3acf3d40dc --- /dev/null +++ b/help-text/run--help.txt @@ -0,0 +1,55 @@ +usage: dvc run [-h] [-q | -v] [-d ] [-n NAME] [-o ] + [-O ] [-p [:]] [-m ] + [-M ] [--plots ] [--plots-no-cache ] + [-w ] [--no-exec] [-f] [--no-run-cache] [--no-commit] + [--outs-persist ] + [--outs-persist-no-cache ] [--always-changed] + [--external] [--desc ] + ... + +Generate a stage file from a command and execute the command. +Documentation: + +positional arguments: + command Command to execute. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + -d , --deps + Declare dependencies for reproducible cmd. + -n NAME, --name NAME Stage name. + -o , --outs + Declare output file or directory. + -O , --outs-no-cache + Declare output file or directory (do not put into DVC + cache). + -p [:], --params [:] + Declare parameter to use as additional dependency. + -m , --metrics + Declare output metrics file. + -M , --metrics-no-cache + Declare output metrics file (do not put into DVC + cache). + --plots Declare output plot file. + --plots-no-cache + Declare output plot file (do not put into DVC cache). + -w , --wdir + Directory within your repo to run your command in. + --no-exec Only create stage file without actually running it. + -f, --force Overwrite existing stage + --no-run-cache Execute the command even if this stage has already + been run with the same + command/dependencies/outputs/etc before. + --no-commit Don't put files/directories into cache. + --outs-persist + Declare output file or directory that will not be + removed upon repro. + --outs-persist-no-cache + Declare output file or directory that will not be + removed upon repro (do not put into DVC cache). + --always-changed Always consider this DVC-file as changed. + --external Allow outputs that are outside of the DVC repository. + --desc User description of the stage (optional). This doesn't + affect any DVC operations. diff --git a/help-text/status--help.txt b/help-text/status--help.txt new file mode 100644 index 0000000000..8ef268e58e --- /dev/null +++ b/help-text/status--help.txt @@ -0,0 +1,34 @@ +usage: dvc status [-h] [-v] [-j ] [-q] [-c] [-r ] [-a] [-T] + [--all-commits] [-d] [-R] [--show-json] + [targets [targets ...]] + +Show changed stages, compare local cache and a remote storage. +Documentation: + +positional arguments: + targets Limit command scope to these tracked + files/directories, .dvc files, or stage names. + +optional arguments: + -h, --help show this help message and exit + -v, --verbose Be verbose. + -j , --jobs + Number of jobs to run simultaneously. The default + value is 4 * cpu_count(). For SSH remotes, the default + is 4. + -q, --quiet Suppresses all output. Exit with 0 if pipelines are up + to date, otherwise 1. + -c, --cloud Show status of a local cache compared to a remote + repository. + -r , --remote + Remote storage to compare local cache to + -a, --all-branches Show status of a local cache compared to a remote + repository for all branches. + -T, --all-tags Show status of a local cache compared to a remote + repository for all tags. + --all-commits Show status of a local cache compared to a remote + repository for all commits. + -d, --with-deps Show status for all dependencies of the specified + target. + -R, --recursive Show status of all stages in the specified directory. + --show-json Show status in JSON format. diff --git a/help-text/unfreeze--help.txt b/help-text/unfreeze--help.txt new file mode 100644 index 0000000000..ddc529ebb4 --- /dev/null +++ b/help-text/unfreeze--help.txt @@ -0,0 +1,12 @@ +usage: dvc unfreeze [-h] [-q | -v] targets [targets ...] + +Unfreeze stages or .dvc files. +Documentation: + +positional arguments: + targets Stages or .dvc files to unfreeze + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/unprotect--help.txt b/help-text/unprotect--help.txt new file mode 100644 index 0000000000..638cc010f6 --- /dev/null +++ b/help-text/unprotect--help.txt @@ -0,0 +1,12 @@ +usage: dvc unprotect [-h] [-q | -v] targets [targets ...] + +Unprotect tracked files or directories (when hardlinks or symlinks have been enabled with `dvc config cache.type`) +Documentation: + +positional arguments: + targets Data files/directories to unprotect. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. diff --git a/help-text/update--help.txt b/help-text/update--help.txt new file mode 100644 index 0000000000..897de91684 --- /dev/null +++ b/help-text/update--help.txt @@ -0,0 +1,14 @@ +usage: dvc update [-h] [-q | -v] [--rev []] [-R] targets [targets ...] + +Update data artifacts imported from other DVC repositories. +Documentation: + +positional arguments: + targets DVC-files to update. + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose. + --rev [] Git revision (e.g. SHA, branch, tag) + -R, --recursive Update all stages in the specified directory. diff --git a/help-text/version--help.txt b/help-text/version--help.txt new file mode 100644 index 0000000000..76c9621b13 --- /dev/null +++ b/help-text/version--help.txt @@ -0,0 +1,9 @@ +usage: dvc version [-h] [-q | -v] + +Display the DVC version and system/environment information. +Documentation: + +optional arguments: + -h, --help show this help message and exit + -q, --quiet Be quiet. + -v, --verbose Be verbose.