# @cdklabs/cdk-cicd-wrapper-cli 中文文档

规范地址：https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/

版本：1\.4\.2
npm 元数据更新时间：2026-11-09T07:59:53.953Z
中文译文更新时间：2026-11-09T08:33:20.053Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cdklabs/cdk-cicd-wrapper-cli
原文对照：https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/?lang=original
项目主页：https://github.com/cdklabs/cdk-cicd-wrapper#readme
源码仓库：https://github.com/cdklabs/cdk-cicd-wrapper

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：775 kB，35 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 20\.19\.0
- 运行依赖：13 个
- 首次发布：2024-05-07T07:25:16.847Z
- 最新版本发布：2026-11-09T07:59:53.597Z
- 近 30 天下载量：3558（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：72（近 12 个月 31 个）

## 中文简介

此寄存器包含用于将您的 AWS CDK 项目以 CI/ CD 周围包裹的基础设施作为代码 .

## 安装

```sh
npm install @cdklabs/cdk-cicd-wrapper-cli
```

也可以使用：`pnpm add @cdklabs/cdk-cicd-wrapper-cli`、`yarn add @cdklabs/cdk-cicd-wrapper-cli`、`bun add @cdklabs/cdk-cicd-wrapper-cli`

## README

# CDK CI/CD 包装器 CLI

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

这个 [CDK CI/CD 包装器](https://cdklabs.github.io/cdk-cicd-wrapper) CLI是一个命令行界面(CLI)工具,旨在精简和自动化与AWS Cloud Development Kit(CDK)项目相关的各种任务. 它驱动自动驾驶管`exec`, (中文(简体) ), `deploy-ci`, (中文(简体) ), `synth`, (中文(简体) ), `deploy`, (中文(简体) ), `check`, (中文(简体) ), `migrate`)和提供一套公用事业,管理合规、安全、许可证和依赖性管理,所有这些都在一个单一的接口内.

## 目录

-   [安装](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-installation)
-   [使用量](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-usage)
    -   [自动驾驶管道命令](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-autopilot-pipeline-commands)
    -   [合规小桶](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-compliance-bucket)
    -   [安全扫描](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-security-scanning)
    -   [许可证管理](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-license-management)
    -   [检查依赖关系](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-check-dependencies)
    -   [校验](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-validate)
-   [捐款](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-contributing)
-   [许可证](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-license)

## 安装

要安装 CDK CI/ CD Wrapper, 您需要在您的系统上安装节点包管理器和 npm( 节点包管理器) 。 一旦具备这些先决条件,就可以使用以下命令在全球安装CDK CI/CD Wrapper:

```bash
npm install -g @cdklabs/cdk-cicd-wrapper-cli
```

或者,你可以使用 `npx` 命令运行 CDK CI/CD Wrapper CLI 不在全球安装:

```bash
npx @cdklabs/cdk-cicd-wrapper-cli [command]
```

## 使用量

CDK CI/CD Wrapper CLI 提供了多个命令来帮助您管理您的 CDK 项目的各个方面. 以下是可用的命令及其描述:

### 自动驾驶管道命令

这些命令驱动自动驾驶器( U)`1.x`(a) 由配置驱动的管道 `cicd.config.ts`。运行其中任何一个 `--help` 用于全旗套装(`--help` 具有权威性,而且始终是当前的:

```bash
npx cdk-cicd <command> --help
```

> **实验.** Autopilot 管道命令是预发的,仍在演变中;旗帜和行为可能在 `1.0` 释放.

| 命令 | 说明 |
| --- | --- |
| `exec` | 在包装器下运行一个 CDK 应用程序——每个引擎激活管道的单一切入点,读取引擎和相片从 `cicd.config`从 `cdk.json` 作为 `"app": "npx cdk-cicd exec bin/app.ts"`。 。 。 . |
| `synth` | 每个阶段/地区合成应用程序( S)`--stage`,或 `--all` (c) 用于完全的CI验证). |
| `deploy` | 合成、漂移检查和在各区域部署一个舞台`--stage`),或运行容器模式执行器(`--from-image`) (中文(简体) ). |
| `deploy-ci` | 提供管道本身进入枢纽账户,从 `cicd.config.ts` 单靠手操作的指令;之后的一切都是部署应用程序的管道. `--disposable` 泪从管道的 文物桶和钥匙与堆放. |
| `check` | 运行默认的 CI 检查( R)`validate`, (中文(简体) ), `audit`, (中文(简体) ), `license`, (中文(简体) ), `security`)——默认建设步骤. |
| `migrate` | 生成自动驾驶器 `cicd.config.ts` 从现有的 `0.x` `PipelineBlueprint` 条目文件( e)`--entry`, (中文(简体) ), `--application`, (中文(简体) ), `--dry-run`) (中文(简体) ). |

见 [CLI 参考](https://cdklabs.github.io/cdk-cicd-wrapper/cli/) 用于完整命令文件.

### 合规小桶

这个 `npx @cdklabs/cdk-cicd-wrapper-cli compliance-bucket` 命令创建 S3 桶,用于遵守目的.

### 安全扫描

这个 `npx @cdklabs/cdk-cicd-wrapper-cli security-scan` 命令扫描您的代码库安全漏洞。 您可以阅读更多关于内部安全功能的信息 [安全开发者指南](https://cdklabs.github.io/cdk-cicd-wrapper/developer_guides/security)。 。 。 .

### 许可证管理

这个 `npx @cdklabs/cdk-cicd-wrapper-cli license` 命令可以为您的工程验证和生成一个 NOTICE 文件。 NOTICE文件的一致性由这个命令进行测试,并包含在"代码Pipeline Building"步骤中,以确保文件总是最新的.

要更新 NOTICE 文件, 请运行以下命令 :

```bash
npx @cdklabs/cdk-cicd-wrapper-cli license --fix
```

### 许可证管理配置

许可证管理脚本配置可以在 `licensecheck.json` 文档。 以下是示例配置:

```json
{
  "failOnLicenses": ["MIT License"],
  "npm": {
    "excluded": [],
    "excludedSubProjects": ["./example/package.json"]
  },
  "python": {
    "excluded": [],
    "excludedSubProjects": ["./example/Pipfile"]
  }
}
```

-   被禁许可证可列入 `failOnLicenses` 属性。 牌照名称匹配对大小写敏感.
-   子文件夹 `Pipfile` 或者说 `package.json` 档案应排除在许可证检查之外,应列在 `npm.excludedSubProjects` 或者说 `python.excludedSubProjects` 属性.
-   对于国家防范机制软件包,子文件夹还需要包含 `package-lock.json` 文件,以确保正确的依赖性被安装和检查.
-   对国家预防机制和Python的许可证核查也可排除依赖.

关于许可证管理配置选项的更多信息,请参阅 [许可证管理配置](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/#readme-license-management-configuration) 节.

### 检查依赖关系

这个 `npx @cdklabs/cdk-cicd-wrapper-cli check-dependencies` 命令审计您的项目的依赖性.

### 校验

这个 `npx @cdklabs/cdk-cicd-wrapper-cli validate` 命令确保 `package-lock.json` 文件没有被篡改.

## 捐款

欢迎向CDK CI/CD Wrapper捐款! 若您愿意贡献,请遵循本报告概述的准则 [捐款额](https://npmcn.com/package/%40cdklabs/cdk-cicd-wrapper-cli/CONTRIBUTING.md) 文档.

## 许可证

CDK CI/CD Wrapper CLI根据 [Apache 2.0 许可证](https://opensource.org/licenses/Apache-2.0)。 。 。 .

## 常见问题

### @cdklabs/cdk-cicd-wrapper-cli 是什么？

此寄存器包含用于将您的 AWS CDK 项目以 CI/ CD 周围包裹的基础设施作为代码 \.

### 如何安装 @cdklabs/cdk-cicd-wrapper-cli？

在项目目录运行 npm install @cdklabs/cdk-cicd-wrapper-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cdk-cicd，可以用 npx cdk-cicd 直接运行。

### @cdklabs/cdk-cicd-wrapper-cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cdklabs/cdk-cicd-wrapper-cli 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @cdklabs/cdk-cicd-wrapper-cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>= 20\.19\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cdklabs/cdk-cicd-wrapper-cli 可以商用吗？

@cdklabs/cdk-cicd-wrapper-cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cdklabs/cdk-cicd-wrapper-cli 的下载量有多少？

根据 npm 官方下载统计，@cdklabs/cdk-cicd-wrapper-cli 在 2026/10/10 – 2026/11/08 这 30 天内被下载 3,558 次，日均约 119 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cdklabs/cdk-cicd-wrapper-cli 还在维护吗？

最新版本 1\.4\.2 发布于 2026/11/09（今天）；至今共发布 72 个版本，其中过去 12 个月发布了 31 个；首次发布于 2024/05/07。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。