Add a new
dvc remote to the project configuration.
You may also need
dvc remote modify to provide credentials and/or configure
other remote parameters. See Remote storage configuration for more
usage: dvc remote add [-h] [--global | --system | --project | --local] [-q | -v] [-d] [-f] name url positional arguments: name Name of the remote. url (See supported URLs in the examples below.)
Registers a remote storage location to save data files (besides the
cache) and optionally sets it as the
--default remote. DVC
remotes can point to a cloud storage service, an SSH server, network-attached
storage, or even a directory in the local file system.
dvc remote default is expected by
dvc gc, and
dvc fetch unless their
-r) option is used.
name (required) is used to identify the remote and must be unique.
DVC will determine the storage type based on the
url (also required), a URL or path for the location.
The storage type determines which config parameters you can access via
dvc remote modify. Note that the
url itself can be modified.
This command creates a
remote section in the project's config file
-d) flag uses the
core config section:
$ dvc remote add -d temp /tmp/dvcstore
# .dvc/config ['remote "temp"'] url = /tmp/dvcstore [core] remote = myremote
If you installed DVC via
pip and plan to use cloud services as remote
storage, you might need to install these optional dependencies:
[all] to include them
all. For example:
$ pip install "dvc[s3]"
--system- save remote configuration to the system config file (e.g.
/etc/xdg/dvc/config) instead of
--global- save remote configuration to the global config file (e.g.
~/.config/dvc/config) instead of
--project- save remote configuration to the project's config file (
.dvc/config). This is the default behavior.
--local- save remote configuration to the Git-ignored local config file (located in
.dvc/config.local) instead of
.dvc/config. This is useful to save private remote config that you don't want to track and share with Git.
--default- commands that require a remote (such as
dvc fetch) will be using this remote by default to upload or download data (unless their
-roption is used).
dvc remote defaultto unset/change the default remote, for example:
dvc remote default --unset(equivalent to
dvc config -u core.remote).
--force- overwrite existing remote with new
--help- prints the usage/help message, and exit.
--quiet- do not write anything to standard output. Exit with 0 if no problems arise, otherwise 1.
--verbose- displays detailed tracing information.
Supported storage types
The following are the supported types of storage protocols and platforms.
- Amazon S3 (AWS) and S3-compatible e.g. MinIO
- Microsoft Azure Blob Storage
- Google Cloud Storage (GCP)
- Google Drive
- Aliyun OSS