View a markdown version of this page

配置并使用 npm - 亚马逊 CodeCatalyst
使用配置 npm CodeCatalyst从软件包存储库安装 npm CodeCatalyst 软件包通过以下方式从 npmjs 安装 npm 包 CodeCatalyst将 npm 包发布到您的 CodeCatalyst 包存储库npm 命令支持

亚马逊 CodeCatalyst 不再向新客户开放。现有客户可以继续正常使用该服务。有关更多信息，请参阅 如何从中迁移 CodeCatalyst。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

配置并使用 npm

要npm与一起使用 CodeCatalyst，您必须npm连接到您的包存储库并提供用于身份验证的个人访问令牌 (PAT)。您可以在 CodeCatalyst 控制台中查看npm连接到软件包存储库的说明。

使用配置 npm CodeCatalyst

以下说明说明如何进行身份验证和npm连接到您的 CodeCatalyst 软件包存储库。有关更多信息，请参阅 npm 官方文档。

将 npm 连接到你的 CodeCatalyst 包存储库

  1. 在处打开 CodeCatalyst 控制台https://codecatalyst.aws/。

  2. 导航到您的项目。

  3. 在导航窗格中，选择程序包。

  4. 从列表中选择您的程序包存储库。

  5. 选择连接到存储库。

  6. 在配置详细信息中，在程序包管理器客户端中，选择 npm 客户端。

  7. 选择您的操作系统以查看相应的配置步骤。

  8. 需要使用个人访问令牌 (PAT) 对 npm 进行身份验证 CodeCatalyst。如果您已有令牌，则可使用它。如果没有，您可以使用以下步骤创建一个令牌。

    1. （可选）：更新 PAT 名称和到期日期。

    2. 选择创建令牌。

    3. 将 PAT 复制并存储在安全位置。

      警告

      关闭此对话框后，您将无法再次查看或复制您的 PAT。凭证应是短期有效的，以最大限度地减少攻击者在盗用凭证后有效地使用凭证的时间。

  9. 从项目的根目录运行以下命令，对程序包存储库配置 npm。这些命令将执行以下操作：

    • 如果您的项目没有项目级 .npmrc 文件，则会创建该文件。

    • 将程序包存储库端点信息添加到您的项目级 .npmrc 文件中。

    • 将您的凭证（PAT）添加到您的用户级 .npmrc 文件中。

    替换以下值。

    注意

    如果通过控制台指令进行复制，则以下命令中的值将进行更新且无需更改。

    • username替换为您的 CodeCatalyst 用户名。

    • 替换PAT为你的 CodeCatalyst PAT。

    • space_name替换为您的 CodeCatalyst 空间名称。

    • proj_name替换为您的 CodeCatalyst 项目名称。

    • repo_name替换为您的 CodeCatalyst 软件包存储库名称。

    npm set registry=https://packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/ --location project
npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:_authToken=username:PAT

    对于 npm 6 或更低版本：要让 npm 始终将身份验证令牌传递给 CodeCatalyst，即使是GET请求也是如此，请按如下方式设置 always-auth 配置变量。npm config set

    npm set //packages.region.codecatalyst.aws/npm/space-name/proj-name/repo-name/:always-auth=true --location project

从软件包存储库安装 npm CodeCatalyst 软件包

在按照使用配置 npm CodeCatalyst 中的步骤操作来将 npm 连接到存储库后，您可以在存储库上运行 npm 命令。

您可以使用npm install命令安装包存储库中的npm CodeCatalyst 软件包或其上游存储库中的一个npm包。

npm install lodash

通过以下方式从 npmjs 安装 npm 包 CodeCatalyst

你可以通过 CodeCatalyst 存储库从 npmjs.com 安装 npm 包，方法是将存储库配置为与连接到 np mjs.com 的网关存储库 npm-public-registry-gateway 的上游连接。 从 npmjs 安装的程序包被提取并存储在网关存储库和最远的下游程序包存储库中。

从 npmjs 安装程序包

  1. 如果您尚未执行此操作，请npm按照中的步骤使用您的 CodeCatalyst包存储库进行配置使用配置 npm CodeCatalyst。

  2. 检查您的存储库是否已将网关存储库 npm-public-registry-gateway 添加为上游连接。您可以按照添加上游存储库中的说明操作并选择 npm-public-registry-gateway 存储库，来检查添加了哪些上游源或将 npm-public-registry-gateway 添加为上游源。

  3. 使用 npm install 命令安装程序包。

    npm install package_name

有关从上游存储库请求程序包的更多信息，请参阅请求包含上游存储库的程序包版本。

将 npm 包发布到您的 CodeCatalyst 包存储库

完成使用配置 npm CodeCatalyst 后，您可以运行 npm 命令。

你可以使用npm publish命令将 npm 包发布到 CodeCatalyst 软件包存储库。

npm publish

有关如何创建 npm 包的信息，请参阅在 n pm 文档上创建 Node.js模块。

npm 命令支持

除了列出不支持的特定npm命令外，以下各节还总结了 CodeCatalyst软件包存储库支持的命令。

与程序包存储库进行交互的受支持命令

此部分列出了 npm 命令，其中 npm 客户端向其配置到的注册表（例如 npm config set registry）发出一个或多个请求。经验证，这些命令在针对 CodeCatalyst 软件包存储库调用时可以正常运行。

命令 说明

bugs

猜测程序包的错误跟踪器 URL 的位置，然后尝试打开它。

ci

从零开始安装一个项目。

deprecate

弃用程序包的某个版本。

dist-tag

修改程序包分发标签。

docs

猜测程序包的文档 URL 的位置，然后尝试使用 --browser 配置参数打开它。

doctor

运行一组检查来验证你的 npm 安装是否可以管理你的 JavaScript 软件包。

install

安装程序包。

install-ci-test

从零开始安装一个项目并运行测试。别名：npm cit。此命令运行 npm ci，然后立即运行 npm test。

install-test

安装程序包并运行测试。运行 npm install，然后立即运行 npm test。

outdated

检查已配置的注册表，确定是否有任何已安装的程序包已过时。

ping

ping 已配置或给定的 npm 注册表并验证身份验证。

publish

将程序包版本发布到注册表。

update

猜测程序包存储库 URL 的位置，然后尝试使用 --browser 配置参数来打开它。

view

显示程序包元数据。也可用于输出元数据属性。

支持的客户端命令

这些命令不需要与软件包存储库进行任何直接交互，因此 CodeCatalyst不需要任何东西来支持它们。

命令 说明

bin（旧版）

显示 npm bin 目录。

build

构建程序包。

cache

操作程序包缓存。

completion

在所有 npm 命令中启用制表符自动完成功能。

config

更新用户和全局 npmrc 文件的内容。

dedupe

搜索本地程序包树，并尝试通过将依赖项进一步向上移动来简化结构，这样多个依赖程序包就可以更有效地共享依赖项。

edit

编辑已安装的程序包。在当前工作目录中选择一个依赖项，然后在默认编辑器中打开程序包目录。

explore

浏览已安装的程序包。在指定的已安装程序包目录中创建一个子 Shell。如果指定了一条命令，则此命令将在该子 Shell 中运行，然后立即停止运行。

help

获取有关 npm 的帮助。

help-search

搜索 npm 帮助文档。

init

创建 package.json 文件。

link

创建指向程序包目录的符号链接。

ls

列出已安装的程序包。

pack

将程序包打包成 tarball。

prefix

显示前缀。除非同时也指定了 -g，否则这是包含 package.json 文件的最近一级父目录。

prune

删除未在父程序包依赖项列表中列出的程序包。

rebuild

对匹配的文件夹运行 npm build 命令。

restart

运行程序包的停止、重启和启动脚本以及相关的前置和后置脚本。

root

将有效的 node_modules 目录输出到标准输出。

run-script

运行任意程序包脚本。

shrinkwrap

锁定依赖项版本以供发布。

uninstall

卸载程序包。

不受支持的命令

CodeCatalyst 软件包存储库不支持这些npm命令。

命令 说明 备注

access

设置已发布程序包的访问级别。

CodeCatalyst 使用与公共 npmjs 存储库不同的权限模型。

adduser

添加注册表用户账户

CodeCatalyst 使用的用户模型与公共 npmjs 存储库不同。

audit

运行安全审核。

CodeCatalyst 目前不提供安全漏洞数据。

hook

管理 npm 钩子，包括添加、移除、列出和更新。

CodeCatalyst 目前不支持任何变更通知机制。

login

对用户进行身份验证。这是 npm adduser 的一个别名。

CodeCatalyst 使用与公共 npmjs 存储库不同的身份验证模型。有关信息，请参阅使用配置 npm CodeCatalyst。

logout

注销注册表。

CodeCatalyst 使用与公共 npmjs 存储库不同的身份验证模型。无法从 CodeCatalyst 存储库注销，但是身份验证令牌在其可配置的到期时间之后过期。默认令牌持续时间为 12 小时。

owner

管理程序包所有者。

CodeCatalyst 使用与公共 npmjs 存储库不同的权限模型。

profile

更改注册表配置文件的设置。

CodeCatalyst 使用的用户模型与公共 npmjs 存储库不同。

search

在注册表中搜索与搜索词匹配的程序包。

CodeCatalyst 不支持该search命令。

star

标记您喜欢的程序包。

CodeCatalyst 目前不支持任何收藏机制。

stars

查看已标记为收藏的程序包。

CodeCatalyst 目前不支持任何收藏机制。

team

管理团队和团队成员资格。

CodeCatalyst 使用与公共 npmjs 存储库不同的用户和群组成员资格模型。

token

管理您的身份验证令牌。

CodeCatalyst 使用不同的模型来获取身份验证令牌。有关信息，请参阅使用配置 npm CodeCatalyst。

unpublish

从注册表中移除程序包。

CodeCatalyst 不支持使用 npm 客户端从存储库中删除软件包版本。您可以在控制台中删除程序包。

whoami

显示 npm 用户名。

CodeCatalyst 使用的用户模型与公共 npmjs 存储库不同。