config

获取或设置项目级别（或全局）的 DVC 配置选项。

概要

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.

描述

您可以使用此命令查询、设置、替换或取消设置DVC 配置选项。该命令接受一个配置选项的name（由配置节和键名组成，以点号分隔）及其value（通常为任意有效的字母数字字符串）。

在读取配置选项时（未提供value或使用了--list），值将从系统、全局、项目和本地配置文件的组合中读取（按此顺序）。可以使用--system、--global、--project和--local选项仅从特定配置文件中读取。

在写入时（提供了value或使用了--unset），新值默认写入项目级别的配置文件（.dvc/config）。可使用--system、--global和--local选项指定写入其他位置。

--global和--system标志分别适用于为多个项目或多用户设置配置选项。

请参阅配置节了解支持哪些配置选项（name）。

命令选项/标志

• -u, --unset - 从配置文件中移除指定的配置选项name。使用此标志时不要提供value参数。

• --system - 修改系统级配置文件（例如/etc/xdg/dvc/config），而非.dvc/config。适用于为机器上的所有项目（所有用户）应用配置选项。可能需要超级用户权限，例如sudo dvc config --system ...（Linux）。

• --global - 修改全局配置文件（例如~/.config/dvc/config），而非项目的.dvc/config。适用于为您的所有项目应用配置选项。

• --project - 读取配置值时仅使用项目的配置文件（.dvc/config）。（写入时的默认行为。）

• --local - 使用 Git 忽略的本地配置文件（位于.dvc/config.local），而非.dvc/config。可用于保存您不想通过 Git 跟踪和共享的私有配置值（如凭据、私有路径等）。

• -l, --list - 列出所有已定义的配置值。

• --show-origin - 在列出或获取配置选项时，同时显示每个选项value所在的配置文件位置。

• -h, --help - 打印使用说明/帮助信息，然后退出。

• -q, --quiet - 不向标准输出写入任何内容。如果没有问题则以 0 退出，否则以 1 退出。

• -v, --verbose - 显示详细的跟踪信息。

示例：添加 S3 远程存储并设为默认

💡 在添加 S3 远程之前，请确保已创建存储桶。

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

注意：这等同于使用dvc remote add并带上-d/--default标志。

示例：默认远程仓库

默认使用远程仓库 myremote：

$ dvc config core.remote myremote

获取默认远程仓库：

$ dvc config core.remote
myremote

清除默认远程仓库值：

$ dvc config --unset core.remote

上述命令等同于：

$ dvc config core.remote -u

示例：缓存配置选项

将缓存目录设置为绝对路径：

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

或设置为相对路径（相对于 ./.dvc/ 解析）：

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

$ ls ../mycache
2f/

设置缓存类型：如果 reflink 不可用，则使用 copy：

$ dvc config cache.type reflink,copy