配置和使用 npm

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

目录

• 使用以下命令配置 npm CodeCatalyst
• 从软件包存储库安装 npm CodeCatalyst 软件包
• 通过 npmjs 安装 npm 软件包 CodeCatalyst
• 将 npm 包发布到你的软件 CodeCatalyst 包存储库
• npm 命令支持
  • 支持的与软件包存储库交互的命令
  • 支持的客户端命令
  • 不受支持的命令

使用以下命令配置 npm CodeCatalyst

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

npm连接到您的 CodeCatalyst 软件包存储库

1. 打开 CodeCatalyst 控制台，网址为 https://codecatalyst.aws/。

2. 导航到您的项目。

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

4. 从列表中选择您的软件包存储库。

5. 选择 “Connect 到存储库”。

6. 在配置详细信息中，在 Pack age Manager 客户端中，选择 npm 客户端。

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

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

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

   2. 选择创建令牌。

   3. 将您的文件复制并存PAT放在安全的地方。

      警告

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

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

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

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

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

   替换以下值。

   注意

   如果您要从控制台说明中复制，则以下命令中的值会为您更新，无需更改。

   • Replace（替换） username 用你的 CodeCatalyst 用户名。

   • Replace（替换） PAT 和你的 CodeCatalyst PAT.

   • Replace（替换） space_name 使用您的 CodeCatalyst 空间名称。

   • Replace（替换） proj_name 用你的 CodeCatalyst 项目名称。

   • Replace（替换） 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 连接到存储库后使用以下命令配置 npm CodeCatalyst，即可在存储库上运行npm命令。

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

npm install lodash

通过 npmjs 安装 npm 软件包 CodeCatalyst

你可以通过 CodeCatalyst 存储库从 npmjs.com 安装来自 npmjs.com 的 npm 软件包，方法是为存储库配置与连接到 npmjs.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 包的信息，请参阅在 npm Docs 上创建 Node.js 模块。

npm 命令支持

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

主题

• 支持的与软件包存储库交互的命令
• 支持的客户端命令
• 不受支持的命令

支持的与软件包存储库交互的命令

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

命令	描述
bugs	猜测软件包的错误跟踪器的位置URL，然后它会尝试将其打开。
ci	从零开始安装一个项目。
deprecate	弃用程序包的某个版本。
dist-tag	修改程序包分发标签。
docs	猜测软件包文档的位置URL，然后它尝试使用 --browser config 参数将其打开。
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 config 参数将其打开。
view	显示程序包元数据。也可以用来打印元数据属性。

支持的客户端命令

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

命令	描述
垃圾桶（旧版）	显示 npm bin 目录。
build	构建程序包。
cache	操作程序包缓存。
completion	在所有 npm 命令中启用制表符自动完成功能。
config	更新用户和全局 npmrc 文件的内容。
dedupe	搜索本地包树，并尝试通过将依赖关系进一步向上移动来简化结构，使多个依赖包可以更有效地共享依赖关系。
edit	编辑已安装的程序包。在当前工作目录中选择一个依赖关系，然后在默认编辑器中打开该包目录。
explore	浏览已安装的程序包。在指定已安装软件包的目录中生成一个子外壳。如果指定了命令，则该命令将在子外壳中运行，然后子外壳会立即关闭。
help	获取有关 npm 的帮助。
help-search	搜索 npm 帮助文档。
init	创建 package.json 文件。
link	符号链接软件包目录。
ls	列出已安装的程序包。
pack	将程序包打包成 tarball。
prefix	显示前缀。除非同时指定，否则-g这是最接近包含package.json文件的父目录。
prune	删除未在父程序包依赖项列表中列出的程序包。
rebuild	对匹配的文件夹运行 npm build 命令。
restart	运行软件包的停止、重启和启动脚本以及相关的预脚本和后脚本。
根	将有效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 存储库。
搜索	在注册表中搜索与搜索词匹配的程序包。	CodeCatalyst 不支持该search命令。
star	标记您喜欢的程序包。	CodeCatalyst 目前不支持任何收藏夹机制。
stars	查看已标记为收藏的程序包。	CodeCatalyst 目前不支持任何收藏夹机制。
team	管理团队和团队成员资格。	CodeCatalyst 使用的用户和组成员资格模型不同于公共 npmjs 存储库。
token	管理您的身份验证令牌。	CodeCatalyst 使用不同的模型来获取身份验证令牌。有关信息，请参阅使用以下命令配置 npm CodeCatalyst。
unpublish	从注册表中删除程序包。	CodeCatalyst 不支持使用 npm 客户端从存储库中删除软件包版本。您可以在控制台中删除软件包。
whoami	显示 npm 用户名。	CodeCatalyst 使用的用户模型不同于公共 npmjs 存储库。