Skip to content

Commit 78055d4

Browse files
committed
cmd ref: get: document --show-url flag
1 parent fc45e12 commit 78055d4

File tree

1 file changed

+20
-0
lines changed
  • public/static/docs/command-reference

1 file changed

+20
-0
lines changed

public/static/docs/command-reference/get.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,13 @@ name.
6565
the file or directory from. The tip of the default branch is used by default
6666
when this option is not specified.
6767

68+
- `--show-url` - Returns path or url to the location in remote for given path,
69+
from where the **file** will be downloaded. `path` is used to specify the location
70+
of the target artifact within the source project in `url`, relative to the project's
71+
root. `url` can be an address to a DVC project or a path to a local DVC project.
72+
When this option is specified, it will not download the files.
73+
Git-only repository is not supported.
74+
6875
- `-h`, `--help` - prints the usage/help message, and exit.
6976

7077
- `-q`, `--quiet` - do not write anything to standard output. Exit with 0 if no
@@ -181,3 +188,16 @@ Untracked files:
181188
model.bigrams.pkl
182189
model.monograms.pkl
183190
```
191+
192+
### Example: Getting a url for a file in a DVC repository
193+
> Note that `dvc get` can be used from anywhere in the file system, as long as
194+
> DVC is [installed](/doc/install).
195+
196+
We can use `dvc get --show-url` to get the actual location of the resulting model file from our
197+
[get started example repo](https://github.com/iterative/example-get-started), a
198+
<abbr>DVC project</abbr> hosted on GitHub:
199+
200+
```dvc
201+
$ dvc get https://github.com/iterative/example-get-started model.pkl --show-url
202+
https://remote.dvc.org/get-started/66/2eb7f64216d9c2c1088d0a5e2c6951
203+
```

0 commit comments

Comments
 (0)