Edit on GitHub

config

Get or set project-level (or global) DVC configuration options.

Synopsis

usage: dvc config [-h] [--global | --system | --project | --local]
                  [-q | -v] [-u]
                  [-l] [--show-origin] [name] [value]

positional arguments:
  name     Option name in format: section.option or remote.name.option
           e.g. 'core.check_update', 'cache.dir', 'remote.myremote.url'
  value    Option value.

Description

You can query/set/replace/unset DVC configuration options with this command. It takes a config option name (a config section and a key, separated by a dot) and its value (any valid alpha-numeric string generally).

When reading config options (no value is given or --list is used), the values are read from a combined set of values from the system, global, project, and local config files (in that order). The --system, --global, --project, and --local options can be used to read from that configuration only.

When writing (a value is given or --unset is used), the new value is written to the project-level config file by default (.dvc/config). Options --system, --global and --local can be used to write to that location instead.

.dvc/config is meant to be tracked by Git and should not contain sensitive user info or secrets (passwords, SSH keys, etc). Use --local when in doubt.

FlagPriorityConfig file location
--local1.dvc/config.local
None or --project (default)2.dvc/config

The --global and --system flags are also useful to set config options for multiple projects or users, respectively.

FlagPrioritymacOS locationLinux location (typical*)Windows location
--global3$HOME/Library/Application\ Support/dvc/config$HOME/.config/dvc/config%LocalAppData%\iterative\dvc\config
--system4/Library/Application\ Support/dvc/config/etc/xdg/dvc/config%AllUsersProfile%\Application Data\iterative\dvc\config

* For Linux, the global file may be found in $XDG_CONFIG_HOME, and the system file in $XDG_CONFIG_DIRS[0], if those env vars are defined.

The --show-origin flag can show you where a given config option value is currently stored.

Refer to Configuration sections to explore which config options (name) are accepted.

Command options/flags

  • -u, --unset - remove the specified config option name from a config file. Don't provide a value argument when employing this flag.

  • --system - modify the system config file (e.g. /etc/xdg/dvc/config) instead of .dvc/config. Useful to apply config options to all the projects (all users) in the machine. May require superuser access e.g. sudo dvc config --system ... (Linux).

  • --global - modify the global config file (e.g. ~/.config/dvc/config) instead of the project's .dvc/config. Useful to apply config options to all your projects.

  • --project - only use the project's config file (.dvc/config) when reading config values (this is the default when writing).

  • --local - use the Git-ignored local config file (located in .dvc/config.local) instead of .dvc/config. This is useful to save private config values that you don't want to track and share with Git (credentials, private locations, etc.).

  • -l, --list - lists all defined config values.

  • --show-origin - when listing or getting config options, also show the location of the config file where each option value is found.

  • -h, --help - prints the usage/help message, and exit.

  • -q, --quiet - do not write anything to standard output. Exit with 0 if no problems arise, otherwise 1.

  • -v, --verbose - displays detailed tracing information.

Example: Add an S3 remote, and set it as default

๐Ÿ’ก Before adding an S3 remote, be sure to Create a Bucket.

$ dvc remote add myremote s3://bucket/path
$ dvc config core.remote myremote

Note that this is equivalent to using dvc remote add with the -d/--default flag.

Example: Default remotes

Use remote myremote by default:

$ dvc config core.remote myremote

Get the default remote:

$ dvc config core.remote
myremote

Clear default remote value:

$ dvc config --unset core.remote

The above command is equivalent to:

$ dvc config core.remote -u

Example: Cache config options

Set the cache directory to an absolute path:

$ dvc config cache.dir /mnt/cache
$ dvc config cache.dir
/mnt/cache

or to a relative path (resolved from ./.dvc/):

$ dvc config cache.dir ../../mycache
$ dvc pull

$ ls ../mycache
2f/

Set cache type: if reflink is not available, use copy:

$ dvc config cache.type reflink,copy
Content

๐Ÿ› Found an issue? Let us know! Or fix it:

Edit on GitHub

โ“ Have a question? Join our chat, we will help you:

Discord Chat