diff --git a/content/docs/command-reference/pull.md b/content/docs/command-reference/pull.md index e81dc6fb48..39b7c391b0 100644 --- a/content/docs/command-reference/pull.md +++ b/content/docs/command-reference/pull.md @@ -235,11 +235,16 @@ use `dvc remote list` to check them. To remember how it's done, and set a context for the example, let's define a default SSH remote: ```cli -$ dvc remote add -d r1 ssh://user@example.com/path/to/dvc/remote/storage +$ dvc remote add -d r1 \ + ssh://user@example.com/project/data/cache $ dvc remote list -r1 ssh://user@example.com/path/to/dvc/remote/storage +r1 ssh://user@example.com/project/data/cache (default) +r2 ssh://user@example.com/other/storage ``` +Note that the default remote (if set) is also indicated when you run +`dvc remote list`. + DVC supports [several storage types]. diff --git a/content/docs/command-reference/push.md b/content/docs/command-reference/push.md index 95360cef8d..3837d655aa 100644 --- a/content/docs/command-reference/push.md +++ b/content/docs/command-reference/push.md @@ -117,7 +117,7 @@ also `dvc remote add --default`). Let's see an SSH remote example: ```cli $ dvc remote add --default r1 \ - ssh://user@example.com/path/to/dvc/cache/directory + ssh://user@example.com/project/data/cache ``` @@ -127,7 +127,8 @@ use `dvc remote list` to check them: ```cli $ dvc remote list -r1 ssh://user@example.com/path/to/dvc/cache/directory +r1 ssh://user@example.com/project/data/cache (default) +r2 ssh://user@example.com/other/storage ``` diff --git a/content/docs/command-reference/remote/default.md b/content/docs/command-reference/remote/default.md index eff31fa717..d77d2dbb6b 100644 --- a/content/docs/command-reference/remote/default.md +++ b/content/docs/command-reference/remote/default.md @@ -41,6 +41,9 @@ is omitted. You can also use `dvc config`, `dvc remote add`, or `dvc remote modify` commands to set/unset/change the default remote. +If a default remote is set, the output of the `dvc remote list` command will +specify it, see [the examples below](#examples). + Remotes are read from the system, global, project, and local config files (in that order). @@ -85,6 +88,14 @@ $ dvc remote default myremote ``` +See the default remote (if set) by listing all remotes: + +```cli +$ dvc remote list +myremote /path/to/remote (default) +otherremote /path/to/other/remote +``` + Change default remote value: ```cli diff --git a/content/docs/command-reference/remote/index.md b/content/docs/command-reference/remote/index.md index 72b1b6845a..33cc99a33a 100644 --- a/content/docs/command-reference/remote/index.md +++ b/content/docs/command-reference/remote/index.md @@ -82,8 +82,8 @@ The project's config file should now look like this: ```cli $ dvc remote list -myremote /path/to/remote -newremote s3://mybucket/path +myremote /path/to/remote (default) +newremote s3://mybucket/path ``` ## Example: Customize an additional S3 remote diff --git a/content/docs/command-reference/remote/list.md b/content/docs/command-reference/remote/list.md index 5d23781f1c..6ce4006aa8 100644 --- a/content/docs/command-reference/remote/list.md +++ b/content/docs/command-reference/remote/list.md @@ -13,7 +13,8 @@ usage: dvc remote list [-h] [--global | --system | --project | --local] Reads [DVC configuration] and prints the list of available remotes, including their names and URLs/paths. Remotes are read from the system, global, project, and local -config files (in that order). +config files (in that order). The default remote (if set) will be specified in the +output (see [the examples below](#examples)). [dvc configuration]: /doc/user-guide/project-structure/configuration#remote @@ -51,10 +52,12 @@ And now the list of remotes should look like: ```cli $ dvc remote list -myremote /path/to/remote +myremote /path/to/remote (default) +otherremote /path/to/other/remote ``` -The list will also include any previously added remotes. +The list will also include any previously added remotes, and the default remote +(if set). [local remote]: /doc/user-guide/data-management/remote-storage#file-systems-local-remotes