7.5.3 swift package-registry login

  10 分钟阅读  

原文链接: https://docs.swift.org/latest/documentation/packagemanagerdocs/packageregistrylogin/

7.5.3 swift package-registry login

登录注册表。

概述

包管理器使用注册表服务的登录 API 验证凭据。如果返回成功响应，凭据会被保存到操作系统的凭据存储（例如 macOS 的钥匙串）。在非 macOS 平台上，或者提供了 --netrc 标志时，凭据会被保存到用户级 .netrc（默认位于 ~/.netrc）。位于 ~/.swiftpm/configuration/registries.json 的用户级配置文件也会被更新。

url 应当是注册表的基础 URL（例如 https://example-registry.com）。如果登录 API 端点的位置不是 /login（例如 https://example-registry.com/api/v1/login），请提供完整的 URL。

URL 必须是 HTTPS。

下表列出了支持的认证类型及其必需的选项：

认证方式必需的选项
Basic–username, –password
Token–token

该工具会分析所提供的选项，以确定认证类型，并在缺少密码/令牌时提示用户（也就是交互模式）。例如，如果只提供了 --username，该工具会假定使用基本认证并提示输入密码。

在非交互模式下，请按需提供 --password 或 --token 选项，或者确保凭据存储中存在该密钥。

如果不支持操作系统的凭据存储，该工具会在把凭据写入安全性较低的 netrc 文件之前提示用户确认。使用 --no-confirm 可以禁用这项确认。

要强制使用 netrc 文件而不是操作系统的凭据存储，请传入 --netrc 标志。

示例：基本认证（macOS，交互式）

1
2
3
4
5
6

> swift package-registry login https://example-registry.com \
    --username jappleseed
Enter password for 'jappleseed':

Login successful.
Credentials have been saved to the operating system's secure credential store.

example-registry.com 的条目会被添加到钥匙串。

包管理器更新 registries.json，表明 example-registry.com 需要基本认证：

{ “authentication”: { “example-registry.com”: { “type”: “basic” }, … }, … }

示例：基本认证（不支持操作系统的凭据存储，交互式）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

> swift package-registry login https://example-registry.com \
    --username jappleseed
Enter password for 'jappleseed':

Login successful.

WARNING: Secure credential store is not supported on this platform.
Your credentials will be written out to netrc file.
Continue? (Yes/No): Yes

Credentials have been saved to netrc file.

example-registry.com 的条目会被添加到 netrc 文件：

1
2
3

machine example-registry.com
login jappleseed
password alpine

包管理器更新 registries.json，表明 example-registry.com 需要基本认证：

1
2
3
4
5
6
7
8
9

{
  "authentication": {
    "example-registry.com": {
      "type": "basic"
    },
    ...
  },
  ...
}

示例：基本认证（改用 netrc 文件而非操作系统的凭据存储，交互式）

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

> swift package-registry login https://example-registry.com \
    --username jappleseed
    --netrc
Enter password for 'jappleseed':

Login successful.

WARNING: You choose to use netrc file instead of the operating system's secure credential store. 
Your credentials will be written out to netrc file.
Continue? (Yes/No): Yes

Credentials have been saved to netrc file.

example-registry.com 的条目会被添加到 netrc 文件：

1
2
3

machine example-registry.com
login jappleseed
password alpine

包管理器更新 registries.json，表明 example-registry.com 需要基本认证：

1
2
3
4
5
6
7
8
9

{
  "authentication": {
    "example-registry.com": {
      "type": "basic"
    },
    ...
  },
  ...
}

示例：基本认证（不支持操作系统的凭据存储，非交互式）

1
2
3
4
5
6
7

> swift package-registry login https://example-registry.com \
    --username jappleseed \
    --password alpine \
    --no-confirm
    
Login successful.
Credentials have been saved to netrc file.

example-registry.com 的条目会被添加到 netrc 文件：

1
2
3

machine example-registry.com
login jappleseed
password alpine

包管理器更新 registries.json，表明 example-registry.com 需要基本认证：

1
2
3
4
5
6
7
8
9

{
  "authentication": {
    "example-registry.com": {
      "type": "basic"
    },
    ...
  },
  ...
}

示例：基本认证（不支持操作系统的凭据存储，非交互式，非默认登录 URL）

1
2
3
4
5
6
7

> swift package-registry login https://example-registry.com/api/v1/login \
    --username jappleseed \
    --password alpine \
    --no-confirm
    
Login successful.
Credentials have been saved to netrc file.

example-registry.com 的条目会被添加到 netrc 文件：

1
2
3

machine example-registry.com
login jappleseed
password alpine

包管理器更新 registries.json，表明 example-registry.com 需要基本认证：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{
  "authentication": {
    "example-registry.com": {
      "type": "basic",
      "loginAPIPath": "/api/v1/login"
    },
    ...
  },
  ...
}

示例：令牌认证

1
2

> swift package-registry login https://example-registry.com \
    --token jappleseedstoken

如果支持，example-registry.com 的条目会被添加到操作系统的凭据存储，否则添加到用户级 netrc 文件：

1
2
3

machine example-registry.com
login token
password jappleseedstoken

包管理器更新 registries.json，表明 example-registry.com 需要令牌认证：

1
2
3
4
5
6
7
8
9

{
  "authentication": {
    "example-registry.com": {
      "type": "token"
    },
    ...
  },
  ...
}

用法

package-registry login [--package-path=<package-path>]
  [--cache-path=<cache-path>] [--config-path=<config-path>]
  [--security-path=<security-path>]
  [--scratch-path=<scratch-path>]
  [--swift-sdks-path=<swift-sdks-path>]
  [--toolset=<toolset>...]
  [--pkg-config-path=<pkg-config-path>...]
  [--enable-dependency-cache] [--disable-dependency-cache]
  [--enable-build-manifest-caching]
  [--disable-build-manifest-caching]
  [--manifest-cache=<manifest-cache>]
  [--enable-experimental-prebuilts]
  [--disable-experimental-prebuilts] [--verbose]
  [--very-verbose|vv] [--quiet] [--color-diagnostics]
  [--no-color-diagnostics] [--disable-sandbox] [--netrc]
  [--enable-netrc] [--disable-netrc]
  [--netrc-file=<netrc-file>] [--enable-keychain]
  [--disable-keychain]
  [--resolver-fingerprint-checking=<resolver-fingerprint-checking>]
  [--resolver-signing-entity-checking=<resolver-signing-entity-checking>]
  [--enable-signature-validation]
  [--disable-signature-validation] [--enable-prefetching]
  [--disable-prefetching]
  [--force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file]
  [--skip-update] [--disable-scm-to-registry-transformation]
  [--use-registry-identity-for-scm]
  [--replace-scm-with-registry]
  [--default-registry-url=<default-registry-url>]
  [--configuration=<configuration>] [--=<Xcc>...]
  [--=<Xswiftc>...] [--=<Xlinker>...] [--=<Xcxx>...]
  [--triple=<triple>] [--sdk=<sdk>] [--toolchain=<toolchain>]
  [--swift-sdk=<swift-sdk>] [--sanitize=<sanitize>...]
  [--auto-index-store] [--enable-index-store]
  [--disable-index-store]
  [--enable-parseable-module-interfaces] [--jobs=<jobs>]
  [--use-integrated-swift-driver]
  [--explicit-target-dependency-import-check=<explicit-target-dependency-import-check>]
  [--build-system=<build-system>] [--=<debug-info-format>]
  [--enable-dead-strip] [--disable-dead-strip]
  [--disable-local-rpath] [<url>] [--username=<username>]
  [--password=<password>] [--token=<token>]
  [--token-file=<token-file>] [--no-confirm] [--version]
  [--help]
  • –package-path=<package-path>：

指定要操作的包路径（默认为当前目录）。这会先切换工作目录，然后再执行其他任何操作。

  • –cache-path=<cache-path>：

指定共享缓存目录的路径。

  • –config-path=<config-path>：

指定共享配置目录的路径。

  • –security-path=<security-path>：

指定共享安全目录的路径。

  • –scratch-path=<scratch-path>：

指定自定义的临时构建目录路径。（默认 .build）

  • –swift-sdks-path=<swift-sdks-path>：

包含已安装 Swift SDK 的目录路径。

  • –toolset=<toolset>：

指定为目标平台构建时使用的工具集 JSON 文件。可以多次使用该选项来指定多个工具集。各个工具集会按指定顺序合并为当前构建的单个最终工具集。

  • –pkg-config-path=<pkg-config-path>：

指定搜索 pkg-config .pc 文件的替代路径。可以多次使用该选项来指定多个路径。

  • –enable-dependency-cache|disable-dependency-cache：

获取依赖时使用共享缓存。

  • –enable-build-manifest-caching|disable-build-manifest-caching：

  • –manifest-cache=<manifest-cache>：

Package.swift 清单的缓存模式。有效取值：shared（共享缓存）、local（包的构建目录）、none（禁用）

  • –enable-experimental-prebuilts|disable-experimental-prebuilts：

是否对宏使用预编译的 swift-syntax 库。

  • –verbose：

提高详细程度，包含信息性输出。

  • –very-verbose|vv：

提高详细程度，包含调试输出。

  • –quiet：

降低详细程度，只包含错误输出。

  • –color-diagnostics|no-color-diagnostics：

在向 TTY 输出时启用或禁用彩色诊断信息。默认情况下，连接到 TTY 时启用彩色诊断，否则禁用。

  • –disable-sandbox：

执行子进程时禁用沙箱。

  • –netrc：

即使在其他凭据存储更优先的情况下也使用 netrc 文件。

  • –enable-netrc|disable-netrc：

从 netrc 文件加载凭据。

  • –netrc-file=<netrc-file>：

指定 netrc 文件的路径。

  • –enable-keychain|disable-keychain：

在 macOS 钥匙串中查找凭据。

  • –resolver-fingerprint-checking=<resolver-fingerprint-checking>：

  • –resolver-signing-entity-checking=<resolver-signing-entity-checking>：

  • –enable-signature-validation|disable-signature-validation：

验证从注册表下载的已签名包发布的签名。

  • –enable-prefetching|disable-prefetching：

  • –force-resolved-versions|disable-automatic-resolution|only-use-versions-from-resolved-file：

只使用 Package.resolved 文件中的版本，如果该文件已过期则解析失败。

  • –skip-update：

在解析期间跳过从远程更新依赖。

  • –disable-scm-to-registry-transformation：

禁用从源代码管理到注册表的转换。

  • –use-registry-identity-for-scm：

在注册表中查找源代码管理依赖，并尽可能使用它们的注册表标识，以帮助在两种来源之间去重。

  • –replace-scm-with-registry：

在注册表中查找源代码管理依赖，并尽可能改用注册表来获取它们，而不是用源代码管理。

  • –default-registry-url=<default-registry-url>：

要使用的默认注册表 URL，用于替代 registries.json 配置文件。

  • –configuration=<configuration>：

以指定配置构建

  • –=<Xcc>：

把标志传递给所有 C 编译器调用。

  • –=<Xswiftc>：

把标志传递给所有 Swift 编译器调用。

  • –=<Xlinker>：

把标志传递给所有链接器调用。

  • –=<Xcxx>：

把标志传递给所有 C++ 编译器调用。

  • –triple=<triple>：

  • –sdk=<sdk>：

  • –toolchain=<toolchain>：

  • –swift-sdk=<swift-sdk>：

筛选构建时要使用的特定 Swift SDK。

  • –sanitize=<sanitize>：

打开针对错误行为的运行时检查，可能取值：address、thread、undefined、scudo。

  • –auto-index-store|enable-index-store|disable-index-store：

启用或禁用构建期间建立索引的特性。

  • –enable-parseable-module-interfaces：

  • –jobs=<jobs>：

构建过程中并行启动的任务数量。

  • –use-integrated-swift-driver：

  • –explicit-target-dependency-import-check=<explicit-target-dependency-import-check>：

一个标志，表明本次构建应检查各个目标是否只导入它们显式声明的依赖。

  • –build-system=<build-system>：

  • –=<debug-info-format>：

要使用的调试信息格式。

  • –enable-dead-strip|disable-dead-strip：

禁用/启用链接器的死代码剥离。

  • –disable-local-rpath：

默认不再把 $ORIGIN/@loader_path 加入 rpath。

  • url：

注册表 URL。

  • –username=<username>：

注册表的用户名。

  • –password=<password>：

注册表的密码。

  • –token=<token>：

注册表的访问令牌。

  • –token-file=<token-file>：

包含访问令牌的文件路径。

  • –no-confirm：

允许在无需确认的情况下写入 netrc 文件。

  • –version：

显示版本。

  • –help：

显示帮助信息。

最后修改 September 13, 2026: 更新C和Cpp以及新增Kotlin和SwiftUI (d20dcaaa6)