Skip to content

Commit

Permalink
ref: artifacts get --show-url (#5245)
Browse files Browse the repository at this point in the history
* ref: artifacts get --show-url

* Update content/docs/command-reference/artifacts/get.md
  • Loading branch information
dberenbaum committed May 28, 2024
1 parent 5cf2fbe commit eaa8761
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion content/docs/command-reference/artifacts/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ into the current working directory (with optional DVC Studio support).
```usage
usage: dvc artifacts get [-h] [-q | -v]
[--rev [<version>]] [--stage [<stage>]]
[-o [<path>]] [-j <number>] [-f]
[-o [<path>]] [--show-url] [-j <number>] [-f]
[--config CONFIG]
[--remote REMOTE] [--remote-config [REMOTE_CONFIG ...]]
url name
Expand Down Expand Up @@ -59,6 +59,9 @@ files (see `dvc get`).
current working directory). Directories specified in the path will be created
by this command.

- `--show-url` - instead of downloading the file or directory, just print the
storage location (URL) of the target data.

- `-j <number>`, `--jobs <number>` - parallelism level for DVC to download data
from the remote. The default value is `4 * cpu_count()`. Using more jobs may
speed up the operation. Note that the default value can be set in the source
Expand Down Expand Up @@ -122,6 +125,17 @@ to the `dvc.yaml` file when addressing the artifact. Since we do not specify
`--rev` or `--stage`, `dvc artifacts get` will download the latest version of
the artifact by default.

## Example: Getting the storage URL of an artifact

We can use `dvc artifacts get --show-url` to get the actual location where the
model is stored:

```cli
$ dvc artifacts get https://github.com/iterative/example-get-started.git \
text-classification --rev=v1.0.0 --show-url
https://remote.dvc.org/get-started/files/md5/cf/a72ff6e2575c44f78f423cada5b783
```

[rest api]: /doc/studio/rest-api
[client access token]:
/doc/studio/user-guide/account-management#client-access-tokens
Expand Down

0 comments on commit eaa8761

Please sign in to comment.