remote add

向项目配置中添加一个新的 dvc remote。

您可能还需要使用 dvc remote modify 来提供凭据和/或配置其他远程参数。更多信息请参见远程存储配置。

概要

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.)

描述

注册一个远程存储位置，用于保存数据文件（除缓存外），并可选择将其设为 --default 远程。DVC 远程可指向云存储服务、SSH 服务器、网络附加存储，甚至本地文件系统中的目录。

除非使用其 --remote（-r）选项，否则 dvc push、dvc pull、dvc status、dvc gc 和 dvc fetch 均默认使用 dvc remote default。

远程 name（必需）用于标识远程，必须唯一。DVC 将根据提供的 url（同样必需，即存储位置的 URL 或路径）确定存储类型。

存储类型决定了您可通过 dvc remote modify 访问的配置参数。请注意，url 本身也可被修改。

此命令会在项目的配置文件（.dvc/config）中创建一个 remote 部分。使用 --default（-d）标志时，将使用 core 配置部分：

$ dvc remote add -d temp /tmp/dvcstore

# .dvc/config
['remote "temp"']
    url = /tmp/dvcstore
[core]
    remote = myremote

如果你通过 pip 安装了 DVC 并计划使用云服务作为远程存储，你可能需要安装这些可选依赖项： [s3]、[azure]、[gdrive]、[gs]、[oss]、[ssh]。使用 [all] 可包含所有依赖项。例如：

$ pip install "dvc[s3]"

命令选项/标志

--system - 将远程配置保存到系统配置文件（例如 /etc/xdg/dvc/config），而非 .dvc/config。
--global - 将远程配置保存到全局配置文件（例如 ~/.config/dvc/config），而非 .dvc/config。
--project - 将远程配置保存到项目配置文件（.dvc/config）。这是默认行为。
--local - 将远程配置保存到 Git 忽略的本地配置文件（位于 .dvc/config.local），而非 .dvc/config。这适用于保存您不希望被 Git 跟踪和共享的私有远程配置。
-d, --default - 需要远程的命令（如 dvc pull、dvc push、dvc fetch）将默认使用此远程上传或下载数据（除非使用其 -r 选项）。

使用 dvc remote default 可取消或更改默认远程，例如： dvc remote default --unset（等同于 dvc config -u core.remote）。
-f, --force - 使用新的 url 值覆盖已存在的远程。
-h, --help - 打印使用说明/帮助信息，然后退出。
-q, --quiet - 不向标准输出写入任何内容。如果没有问题则以 0 退出，否则以 1 退出。
-v, --verbose - 显示详细的跟踪信息。

支持的存储类型

以下是支持的存储协议和平台类型：

云服务商

Amazon S3（AWS）以及 S3 兼容服务，例如 MinIO
Microsoft Azure Blob Storage
Google Cloud Storage（GCP）
Google Drive
阿里云 OSS

自托管 / 本地部署

SSH；类似 scp
HDFS 与 WebHDFS
HTTP
WebDAV