diff --git a/content/docs/command-reference/diff.md b/content/docs/command-reference/diff.md index 27215d2fe2..63e4a96a04 100644 --- a/content/docs/command-reference/diff.md +++ b/content/docs/command-reference/diff.md @@ -9,7 +9,7 @@ workspace. ```usage usage: dvc diff [-h] [-q | -v] [--targets [ [ ...]]] - [--show-json] [--show-hash] [--show-md] + [--json] [--show-hash] [--md] [a_rev] [b_rev] positional arguments: @@ -30,9 +30,9 @@ branch or tag name, Git commit hash, etc. It defaults to comparing the current workspace and the last commit (`HEAD`), if arguments `a_rev` and `b_rev` are not specified. -Options `--show-json` and `--show-hash` can be used to modify format of the -output of this command. See the [Options](#options) and [Examples](#examples) -sections below for more details. +Options `--json` and `--show-hash` can be used to modify format of the output of +this command. See the [Options](#options) and [Examples](#examples) sections +below for more details. `dvc diff` does not have an effect when the repository is not tracked by Git, for example when `dvc init` was used with the `--no-scm` option. @@ -56,10 +56,10 @@ for example when `dvc init` was used with the `--no-scm` option. $ dvc diff --targets t1.json t2.yaml -- HEAD v1 ``` -- `--show-json` - prints the command's output in easily parsable JSON format, - instead of a human-readable table. +- `--json` - prints the command's output in easily parsable JSON format, instead + of a human-readable table. -- `--show-md` - prints the command's output in Markdown table format. +- `--md` - prints the command's output in Markdown table format. - `--show-hash` - print file and directory hash values along with their path. Useful for debug purposes. @@ -188,7 +188,7 @@ Let's use the same command as above, but with JSON output and including hash values: ```dvc -$ dvc diff --show-json --show-hash \ +$ dvc diff --json --show-hash \ baseline-experiment bigrams-experiment ``` diff --git a/content/docs/command-reference/exp/diff.md b/content/docs/command-reference/exp/diff.md index c6bf37ef45..d20d0f8f8f 100644 --- a/content/docs/command-reference/exp/diff.md +++ b/content/docs/command-reference/exp/diff.md @@ -7,7 +7,7 @@ Show changes in [metrics](/doc/command-reference/metrics) and ```usage usage: dvc exp diff [-h] [-q | -v] [--all] [--param-deps] - [--show-json] [--show-md] [--old] + [--json] [--md] [--old] [--no-path] [--precision ] [a_rev] [b_rev] positional arguments: @@ -54,10 +54,10 @@ all the current experiments (without comparisons). - `--param-deps` - include only parameters that are stage dependencies. -- `--show-json` - prints the command's output in easily parsable JSON format, - instead of a human-readable table. +- `--json` - prints the command's output in easily parsable JSON format, instead + of a human-readable table. -- `--show-md` - prints the command's output in the Markdown table format +- `--md` - prints the command's output in the Markdown table format ([GFM](https://github.github.com/gfm/#tables-extension-)). - `--old` - include the "Old" value column in addition to the new "Value" (and diff --git a/content/docs/command-reference/exp/show.md b/content/docs/command-reference/exp/show.md index d91262b1bb..14489cc70a 100644 --- a/content/docs/command-reference/exp/show.md +++ b/content/docs/command-reference/exp/show.md @@ -14,8 +14,7 @@ usage: dvc exp show [-h] [-q | -v] [-a] [-T] [-A] [-n ] [--exclude-params ] [--param-deps] [--sort-by ] [--sort-order {asc,desc}] [--no-timestamp] [--sha] - [--show-json] [--show-csv] [--show-md] - [--precision ] + [--json] [--csv] [--md] [--precision ] ``` ## Description @@ -113,13 +112,13 @@ metric or param. - `--sha` - display Git commit (SHA) hashes instead of branch, tag, or experiment names. -- `--show-json` - prints the command's output in easily parsable JSON format, - instead of a human-readable table. +- `--json` - prints the command's output in easily parsable JSON format, instead + of a human-readable table. -- `--show-csv` - prints the command's output in CSV format instead of a +- `--csv` - prints the command's output in CSV format instead of a human-readable table. -- `--show-md` - prints the command's output in Markdown table format. +- `--md` - prints the command's output in Markdown table format. - `--precision ` - [round](https://docs.python.org/3/library/functions.html#round) decimal values diff --git a/content/docs/command-reference/list.md b/content/docs/command-reference/list.md index b043126eb2..44eb94de54 100644 --- a/content/docs/command-reference/list.md +++ b/content/docs/command-reference/list.md @@ -11,7 +11,7 @@ and by Git. ```usage usage: dvc list [-h] [-q | -v] [-R] [--dvc-only] - [--show-json] [--rev []] + [--json] [--rev []] url [path] positional arguments: @@ -67,8 +67,8 @@ accessed with `dvc get`, `dvc import`, or `dvc.api`. [Git revision](https://git-scm.com/docs/revisions)) of the repository to list content for. The latest commit in `master` (tip of the default branch) is used by default when this option is not specified. -- `--show-json` - prints the command's output in easily parsable JSON format, - instead of a human-readable table. +- `--json` - prints the command's output in easily parsable JSON format, instead + of a human-readable table. - `-h`, `--help` - prints the usage/help message, and exit. diff --git a/content/docs/command-reference/metrics/diff.md b/content/docs/command-reference/metrics/diff.md index c5c58af6b4..e29bdf0ded 100644 --- a/content/docs/command-reference/metrics/diff.md +++ b/content/docs/command-reference/metrics/diff.md @@ -10,7 +10,7 @@ Compare [metrics](/doc/command-reference/metrics) between two commits in the ```usage usage: dvc metrics diff [-h] [-q | -v] [--targets [ [ ...]]] [-R] - [--all] [--show-json] [--show-md] [--no-path] + [--all] [--json] [--md] [--no-path] [--old] [--precision ] [a_rev] [b_rev] @@ -66,10 +66,10 @@ all the current metrics (without comparisons). - `--all` - list all metrics, including those without changes. -- `--show-json` - prints the command's output in JSON format (machine-readable) +- `--json` - prints the command's output in JSON format (machine-readable) instead of a human-readable table. -- `--show-md` - prints the command's output in the Markdown table format +- `--md` - prints the command's output in the Markdown table format ([GFM](https://github.github.com/gfm/#tables-extension-)). - `--old` - include the "Old" value column in addition to the new "Value" (and diff --git a/content/docs/command-reference/metrics/show.md b/content/docs/command-reference/metrics/show.md index f418f970e0..4c01865f70 100644 --- a/content/docs/command-reference/metrics/show.md +++ b/content/docs/command-reference/metrics/show.md @@ -6,7 +6,7 @@ Print [metrics](/doc/command-reference/metrics), with optional formatting. ```usage usage: dvc metrics show [-h] [-q | -v] [-a] [-T] [--all-commits] - [--show-json] [--show-md] [-R] + [--json] [--md] [-R] [targets [targets ...]] positional arguments: @@ -44,10 +44,10 @@ compares them with a previous version. well as in the workspace. This prints metrics in the entire commit history of the project. -- `--show-json` - prints the command's output in easily parsable JSON format, - instead of a human-readable table. +- `--json` - prints the command's output in easily parsable JSON format, instead + of a human-readable table. -- `--show-md` - prints the command's output in Markdown table format. +- `--md` - prints the command's output in Markdown table format. - `-R`, `--recursive` - determines the metrics files to show by searching each target directory and its subdirectories for `dvc.yaml` files to inspect. If diff --git a/content/docs/command-reference/params/diff.md b/content/docs/command-reference/params/diff.md index 3236a85dfe..7092a455d3 100644 --- a/content/docs/command-reference/params/diff.md +++ b/content/docs/command-reference/params/diff.md @@ -11,7 +11,7 @@ the DVC repository, or between a commit and the ```usage usage: dvc params diff [-h] [-q | -v] [--targets [ [ ...]]] [--all] - [--deps] [--show-json] [--show-md] [--no-path] + [--deps] [--json] [--md] [--no-path] positional arguments: a_rev Old Git commit to compare (defaults to HEAD) @@ -62,10 +62,10 @@ specified with the `--targets` option. - `--deps` - include only parameters that are stage dependencies. -- `--show-json` - prints the command's output in easily parsable JSON format, - instead of a human-readable table. +- `--json` - prints the command's output in easily parsable JSON format, instead + of a human-readable table. -- `--show-md` - prints the command's output in the Markdown table format. +- `--md` - prints the command's output in the Markdown table format. - `-h`, `--help` - prints the usage/help message, and exit. diff --git a/content/docs/command-reference/status.md b/content/docs/command-reference/status.md index 0f4d8a0a61..f070c80f95 100644 --- a/content/docs/command-reference/status.md +++ b/content/docs/command-reference/status.md @@ -9,7 +9,7 @@ and remote storage. ```usage usage: dvc status [-h] [-v] [-j ] [-q] [-c] [-r ] [-a] [-T] - [--all-commits] [-d] [-R] [--show-json] + [--all-commits] [-d] [-R] [--json] [targets [targets ...]] positional arguments: @@ -142,8 +142,8 @@ that. [remote storage](/doc/command-reference/remote) to compare against (see `dvc remote list`. Implies `--cloud`. -- `--show-json` - prints the command's output in easily parsable JSON format, - instead of a human-readable table. +- `--json` - prints the command's output in easily parsable JSON format, instead + of a human-readable table. - `-j `, `--jobs ` - parallelism level for DVC to access data from remote storage. This only applies when the `--cloud` option is used, or a