Add a new
dvc remote to the project configuration.
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.
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.
$ 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.
--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.
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