# @contentstack/cli 中文文档

规范地址：https://npmcn.com/package/%40contentstack/cli/

版本：2\.0\.2
npm 元数据更新时间：2026-10-06T19:36:32.888Z
中文译文更新时间：2026-11-10T16:46:43.074Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：38.4 kB，38 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.0\.0
- 运行依赖：34 个
- 首次发布：2020-10-15T07:53:24.082Z
- 最新版本发布：2026-10-06T19:36:32.043Z
- 近 30 天下载量：46243（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：226（近 12 个月 63 个）

## 中文简介

命令行工具( CLI) ,用于与 Contack 交互

## 安装

```sh
npm install @contentstack/cli
```

也可以使用：`pnpm add @contentstack/cli`、`yarn add @contentstack/cli`、`bun add @contentstack/cli`

## README

# @contentstack/cli (中文(简体) )

使用 Contentack 命令行接口( CLI) 从您的终端直接与 Contentack 交互 .

[![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) [![npm](https://img.shields.io/npm/v/@contentstack/cli)](https://www.npmjs.com/package/@contentstack/cli)

## 所需资源

节点.js v22 或 以上——下载自 [节点js.org](https://nodejs.org/)。 。 。 .

## 安装

```sh
npm install -g @contentstack/cli
```

## 使用量

```sh
csdx --version
csdx --help
csdx auth:login
```

完整文件请访问 [内存 CLI 文件](https://www.contentstack.com/docs/developers/cli)。 。 。 .

## 套装插件

| 插件 | 说明 | 文档 |
| --- | --- | --- |
| [`@contentstack/cli-auth`](https://www.npmjs.com/package/@contentstack/cli-auth) | 认证 — 登录、 登录、 符号管理 | [文档](https://www.contentstack.com/docs/headless-cms/cli-authentication) |
| [`@contentstack/cli-config`](https://www.npmjs.com/package/@contentstack/cli-config) | 区域和早期访问头配置 | [文档](https://www.contentstack.com/docs/headless-cms/configure-regions-in-the-cli) |
| [`@contentstack/cli-cm-import`](https://www.npmjs.com/package/@contentstack/cli-cm-import) | 将堆栈和模块导入目录 | [文档](https://www.contentstack.com/docs/headless-cms/import-content-using-the-cli) |
| [`@contentstack/cli-cm-export`](https://www.npmjs.com/package/@contentstack/cli-cm-export) | 从 Contack 导出堆栈和模块 | [文档](https://www.contentstack.com/docs/headless-cms/export-content-using-the-cli) |
| [`@contentstack/cli-cm-seed`](https://www.npmjs.com/package/@contentstack/cli-cm-seed) | 从 GitHub 仓库种子堆栈 | [文档](https://www.contentstack.com/docs/headless-cms/import-content-using-the-seed-command) |
| [`@contentstack/cli-cm-bootstrap`](https://www.npmjs.com/package/@contentstack/cli-cm-bootstrap) | 启动一个新内容夹项目 | [文档](https://www.contentstack.com/docs/headless-cms/bootstrap-starter-apps/) |
| [`@contentstack/cli-cm-export-to-csv`](https://www.npmjs.com/package/@contentstack/cli-cm-export-to-csv) | 将条目、分类、术语和类用户导出到 CSV | [文档](https://www.contentstack.com/docs/headless-cms/export-content-to-csv-file/) |
| [`@contentstack/cli-cm-clone`](https://www.npmjs.com/package/@contentstack/cli-cm-clone) | 将一叠切入到另一叠 | [文档](https://www.contentstack.com/docs/headless-cms/cloning-a-stack) |
| [`@contentstack/cli-migration`](https://www.npmjs.com/package/@contentstack/cli-migration) | 运行堆栈迁移脚本 | [文档](https://www.contentstack.com/docs/headless-cms/migrate-your-content-using-the-cli-migration-command/) |
| [`@contentstack/cli-cm-branches`](https://www.npmjs.com/package/@contentstack/cli-cm-branches) | 分支管理——创建、diff和合并 | [文档](https://www.contentstack.com/docs/headless-cms/compare-and-merge-branches-using-the-cli/) |
| [`@contentstack/cli-audit`](https://www.npmjs.com/package/@contentstack/cli-audit) | 审计和确定内容类型和条目问题 | [文档](https://www.contentstack.com/docs/headless-cms/audit-plugin) |
| [`@contentstack/cli-bulk-operations`](https://www.npmjs.com/package/@contentstack/cli-bulk-operations) | 跨堆栈内容的散装操作 | [文档](https://www.contentstack.com/docs/headless-cms/bulk-operations-in-cli) |

## 可安装插件

这些是默认安装中未捆绑的Contextack自有插件 。 添加其中任何一项:

```sh
csdx plugins:install <plugin-name>
```

| 插件 | 说明 | 文档 |
| --- | --- | --- |
| [`@contentstack/apps-cli`](https://www.npmjs.com/package/@contentstack/apps-cli) | 构建、部署和管理 Contentack 应用程序 | [文档](https://www.contentstack.com/docs/headless-cms/apps-cli-plugin) |
| [`contentstack-cli-tsgen`](https://www.npmjs.com/package/contentstack-cli-tsgen) | 从堆栈的内容类型生成类型脚本打字 | [文档](https://www.contentstack.com/docs/headless-cms/tsgen-plugin) |
| [`contentstack-cli-content-type`](https://www.npmjs.com/package/contentstack-cli-content-type) | 在堆栈中检索和检查内容类型 | [文档](https://www.contentstack.com/docs/headless-cms/cli-content-type-plugin) |
| [`@contentstack/cli-launch`](https://www.npmjs.com/package/@contentstack/cli-launch) | 启动项目 | [文档](https://www.contentstack.com/docs/headless-cms/cli-for-launch/) |
| [`@contentstack/cli-cm-regex-validate`](https://www.npmjs.com/package/@contentstack/cli-cm-regex-validate) | 验证内容类型和全局字段的正则属性 | [文档](https://www.contentstack.com/docs/headless-cms/cli-regex-validate-plugin) |
| [`@contentstack/cli-external-migrate`](https://www.npmjs.com/package/@contentstack/cli-external-migrate) | 从外部来源将内容迁移到 Contack | —— 说 |
| [`@contentstack/cli-cm-export-query`](https://www.npmjs.com/package/@contentstack/cli-cm-export-query) | 使用查询过滤器导出堆栈内容 | [文档](https://www.contentstack.com/docs/headless-cms/query-based-export) |

## 许可证

[麻省理工学院](https://github.com/contentstack/cli/blob/main/LICENSE)

## 常见问题

### @contentstack/cli 是什么？

命令行工具\( CLI\) ,用于与 Contack 交互

### 如何安装 @contentstack/cli？

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

### @contentstack/cli 支持 TypeScript 吗？

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

### @contentstack/cli 支持 ESM 还是 CommonJS？

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

### @contentstack/cli 需要什么版本的 Node\.js？

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

### @contentstack/cli 可以商用吗？

@contentstack/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @contentstack/cli 的下载量有多少？

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

### @contentstack/cli 还在维护吗？

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