配置并使用 npm
要在 CodeCatalyst 中使用 npm
,您必须将 npm
连接到您的程序包存储库,并提供用于身份验证的个人访问令牌(PAT)。您可以查看有关在 CodeCatalyst 控制台中将 npm
连接到程序包存储库的说明。
目录
使用 CodeCatalyst 配置 npm
以下说明介绍如何进行身份验证并将 npm
连接到 CodeCatalyst 程序包存储库。有关更多信息,请参阅 npm 官方文档
将 npm
连接到您的 CodeCatalyst 程序包存储库
-
通过访问 https://codecatalyst.aws/
打开 CodeCatalyst 控制台。 -
导航到您的项目。
-
在导航窗格中,选择程序包。
-
从列表中选择您的程序包存储库。
-
选择连接到存储库。
-
在配置详细信息中,在程序包管理器客户端中,选择 npm 客户端。
选择您的操作系统以查看相应的配置步骤。
-
需要个人访问令牌(PAT)才能使用 CodeCatalyst 对 npm 进行身份验证。如果您已有令牌,则可使用它。如果没有,您可以使用以下步骤创建一个令牌。
(可选):更新 PAT 名称和到期日期。
-
选择创建令牌。
-
将 PAT 复制并存储在安全位置。
警告
关闭此对话框后,您将无法再次查看或复制您的 PAT。凭证应是短期有效的,以最大限度地减少攻击者在盗用凭证后有效地使用凭证的时间。
-
从项目的根目录运行以下命令,对程序包存储库配置 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
请求),请使用npm config set
来设置 always-auth 配置变量,如下所示。npm set //packages.
region
.codecatalyst.aws/npm/space-name
/proj-name
/repo-name
/:always-auth=true --location project
从 CodeCatalyst 程序包存储库中安装 npm 程序包
在按照使用 CodeCatalyst 配置 npm 中的步骤操作来将 npm 连接到存储库后,您可以在存储库上运行 npm
命令。
您可以使用 npm install
命令安装位于 CodeCatalyst 程序包存储库或其某个上游存储库中的 npm 程序包。
npm install
lodash
通过 CodeCatalyst 从 npmjs 安装 npm 程序包
您可以通过 CodeCatalyst 存储库从 npmjs.com
从 npmjs 安装程序包
-
如果尚未执行此操作,请按照使用 CodeCatalyst 配置 npm中的步骤操作,对 CodeCatalyst 程序包存储库配置
npm
。 -
检查您的存储库是否已将网关存储库 npm-public-registry-gateway 添加为上游连接。您可以按照添加上游存储库中的说明操作并选择 npm-public-registry-gateway 存储库,来检查添加了哪些上游源或将 npm-public-registry-gateway 添加为上游源。
-
使用
npm install
命令安装程序包。npm install
package_name
有关从上游存储库请求程序包的更多信息,请参阅请求包含上游存储库的程序包版本。
将 npm 程序包发布到 CodeCatalyst 程序包存储库
完成使用 CodeCatalyst 配置 npm 后,您可以运行 npm
命令。
您可以使用 npm publish
命令将 npm 程序包发布到 CodeCatalyst 程序包存储库。
npm publish
有关如何创建 npm 程序包的信息,请参阅 npm Docs 上的 Creating Node.js Modules
npm 命令支持
以下部分总结了 CodeCatalyst 程序包存储库支持的 npm
命令,并列出了不支持的特定命令。
与程序包存储库进行交互的受支持命令
此部分列出了 npm
命令,其中 npm
客户端向其配置到的注册表(例如 npm
config set registry
)发出一个或多个请求。这些命令已经过验证,在针对 CodeCatalyst 程序包存储库调用时可以正常运行。
命令 | 描述 |
---|---|
猜测程序包的错误跟踪器 URL 的位置,然后尝试打开它。 |
|
从零开始安装一个项目。 |
|
弃用程序包的某个版本。 |
|
修改程序包分发标签。 |
|
猜测程序包的文档 URL 的位置,然后尝试使用 |
|
运行一组检查来验证您的 npm 安装是否能管理 JavaScript 程序包。 |
|
安装程序包。 |
|
从零开始安装一个项目并运行测试。别名: |
|
安装程序包并运行测试。运行 |
|
检查已配置的注册表,确定是否有任何已安装的程序包已过时。 |
|
ping 已配置或给定的 npm 注册表并验证身份验证。 |
|
将程序包版本发布到注册表。 |
|
猜测程序包存储库 URL 的位置,然后尝试使用 |
|
显示程序包元数据。也可用于输出元数据属性。 |
支持的客户端命令
这些命令不需要与程序包存储库进行任何直接交互,因此 CodeCatalyst 无需任何项即可支持它们。
命令 | 描述 |
---|---|
显示 npm |
|
构建程序包。 |
|
操作程序包缓存。 |
|
在所有 npm 命令中启用制表符自动完成功能。 |
|
更新用户和全局 |
|
搜索本地程序包树,并尝试通过将依赖项进一步向上移动来简化结构,这样多个依赖程序包就可以更有效地共享依赖项。 |
|
编辑已安装的程序包。在当前工作目录中选择一个依赖项,然后在默认编辑器中打开程序包目录。 |
|
浏览已安装的程序包。在指定的已安装程序包目录中创建一个子 Shell。如果指定了一条命令,则此命令将在该子 Shell 中运行,然后立即停止运行。 |
|
获取有关 npm 的帮助。 |
|
搜索 npm 帮助文档。 |
|
创建 |
|
创建指向程序包目录的符号链接。 |
|
列出已安装的程序包。 |
|
将程序包打包成 tarball。 |
|
显示前缀。除非同时也指定了 |
|
删除未在父程序包依赖项列表中列出的程序包。 |
|
对匹配的文件夹运行 |
|
运行程序包的停止、重启和启动脚本以及相关的前置和后置脚本。 |
|
将有效的 |
|
运行任意程序包脚本。 |
|
锁定依赖项版本以供发布。 |
|
卸载程序包。 |
不受支持的命令
CodeCatalyst 程序包存储库不支持这些 npm
命令。
命令 | 描述 | 备注 |
---|---|---|
设置已发布程序包的访问级别。 |
CodeCatalyst 使用的权限模型与公共 npmjs 存储库不同。 |
|
添加注册表用户账户 |
CodeCatalyst 使用的用户模型与公共 npmjs 存储库不同。 |
|
运行安全审核。 |
CodeCatalyst 目前不提供安全漏洞数据。 |
|
管理 npm 钩子,包括添加、移除、列出和更新。 |
CodeCatalyst 目前不支持任何变更通知机制。 |
|
对用户进行身份验证。这是 |
CodeCatalyst 使用的身份验证模型与公共 npmjs 存储库不同。有关信息,请参阅使用 CodeCatalyst 配置 npm。 |
|
注销注册表。 |
CodeCatalyst 使用的身份验证模型与公共 npmjs 存储库不同。无法从 CodeCatalyst 存储库中注销,但是身份验证令牌会在其可配置的到期时间后过期。默认令牌持续时间为 12 小时。 |
|
管理程序包所有者。 |
CodeCatalyst 使用的权限模型与公共 npmjs 存储库不同。 |
|
更改注册表配置文件的设置。 |
CodeCatalyst 使用的用户模型与公共 npmjs 存储库不同。 |
|
在注册表中搜索与搜索词匹配的程序包。 |
CodeCatalyst 不支持 |
|
标记您喜欢的程序包。 |
CodeCatalyst 目前不支持任何收藏机制。 |
|
查看已标记为收藏的程序包。 |
CodeCatalyst 目前不支持任何收藏机制。 |
|
管理团队和团队成员资格。 |
CodeCatalyst 使用的用户和组成员资格模型与公共 npmjs 存储库不同。 |
|
管理您的身份验证令牌。 |
CodeCatalyst 使用不同的模型来获取身份验证令牌。有关信息,请参阅使用 CodeCatalyst 配置 npm。 |
|
从注册表中移除程序包。 |
CodeCatalyst 不支持使用 npm 客户端从存储库中移除程序包版本。您可以在控制台中删除程序包。 |
|
显示 npm 用户名。 |
CodeCatalyst 使用的用户模型与公共 npmjs 存储库不同。 |