Skip to content

Commit

Permalink
cmd ref: clarify pre-requisite of --show-url option
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgeorpinel committed Jan 23, 2020
1 parent 663f589 commit ab40ed7
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions public/static/docs/command-reference/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,17 +58,16 @@ name.
an existing directory is specified, then the output will be placed inside of
it.

- `--rev` - `url` is expected to represent a Git repository for this option to
- `--rev` - `url` is expected to contain a Git repository for this option to
have an effect. Specific
[Git revision](https://git-scm.com/book/en/v2/Git-Internals-Git-References)
(such as a branch name, a tag, or a commit hash) of the repository to download
the file or directory from. The tip of the default branch is used by default
when this option is not specified.

- `--show-url` - `url` is expected to represent a DVC project for this option to
have an effect (as opposed to a Git-only, non-DVC repository). When
`--show-url` is used, instead of downloading the file or directory, this
command just prints the storage location (URL) of the target data.
- `--show-url` - `path` is expected to represent a DVC-tracked file for this
option to have an effect. Instead of downloading the file or directory, just
print the storage location (URL) of the target data.

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

Expand Down

0 comments on commit ab40ed7

Please sign in to comment.