# @circleci/circleci-config-sdk 中文文档 规范地址：https://npmcn.com/package/%40circleci/circleci-config-sdk/ 版本：0\.12\.5 npm 元数据更新时间：2026-06-16T18:42:10.546Z 中文译文更新时间：2026-11-09T16:48:13.643Z 软件包许可：MIT 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40circleci/circleci-config-sdk 原文对照：https://npmcn.com/package/%40circleci/circleci-config-sdk/?lang=original 项目主页：https://github.com/CircleCI-Public/circleci-config-sdk-ts#readme 源码仓库：https://github.com/CircleCI-Public/circleci-config-sdk-ts ## 关键信息（来自 npm 元数据） - 包体积（解压后）：890 kB，173 个文件 - 模块格式：CommonJS - TypeScript 类型：包内自带 - 运行依赖：2 个 - 首次发布：2021-04-30T15:20:20.252Z - 最新版本发布：2025-05-28T17:15:51.139Z - 近 30 天下载量：9271（2026-10-10 至 2026-11-08，npm 官方下载统计） - 已发布版本数：64（近 12 个月 0 个） ## 中文简介 用 JavaScript 构建 CircleCI 配置文件的 SDK . ## 安装 ```sh npm install @circleci/circleci-config-sdk ``` 也可以使用：`pnpm add @circleci/circleci-config-sdk`、`yarn add @circleci/circleci-config-sdk`、`bun add @circleci/circleci-config-sdk` ## README # CircleCI 配置 SDK ## 3⁄4 ̄ ̧漯B **这种回波不再由CircleCI维护,支持或监控. 后90天将存档. 对于那些想继续使用它的人来说,这可以成为借口.** **这种SDK是在 " 现成 " 和 " 现成 " 的基础上提供的,没有任何保证。 CircleCI否认所有明示或默示的担保,包括但不限于所有默示的可商性、所有权、适合某一特定目的和不侵权的担保.** [![GitHub](https://img.shields.io/github/license/CircleCI-Public/circleci-config-sdk-ts)](https://github.com/CircleCI-Public/circleci-config-sdk-ts/blob/main/LICENSE) [![CircleCI](https://img.shields.io/circleci/build/gh/CircleCI-Public/circleci-config-sdk-ts/main?logo=circleci&token=5fcb5715c180e9f7d3a076d95779cd88f75d2093)](https://app.circleci.com/pipelines/github/CircleCI-Public/circleci-config-sdk-ts) [![npm](https://img.shields.io/npm/v/@circleci/circleci-config-sdk?logo=npm)](https://www.npmjs.com/package/@circleci/circleci-config-sdk) [![codecov](https://codecov.io/gh/CircleCI-Public/circleci-config-sdk-ts/branch/main/graph/badge.svg?token=Z4C4RXABS7)](https://codecov.io/gh/CircleCI-Public/circleci-config-sdk-ts) [![npm](https://img.shields.io/npm/dm/@circleci/circleci-config-sdk?logo=npm)](https://www.npmjs.com/package/@circleci/circleci-config-sdk) ![GitHub Repo stars](https://img.shields.io/github/stars/CircleCI-Public/circleci-config-sdk-ts?style=social) 创建和管理您的 [圆CI](https://circleci.com/) 带有 JavaScript 的配置文件 类型脚本 . ## 目录 - [CircleCI 配置 SDK](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-circleci-config-sdk) - [目录](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-table-of-contents) - [开始](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-getting-started) - [安装](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-installation) - [使用量](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-usage) - [示例](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-example) - [获取帮助](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-getting-help) - [资源](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-resources) - [捐款](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-contributing) - [相关](https://npmcn.com/package/%40circleci/circleci-config-sdk/#readme-related) ## 开始 📖 [开始维基](https://github.com/CircleCI-Public/circleci-config-sdk-ts/wiki) 📖 [SDK API 文档](https://circleci-public.github.io/circleci-config-sdk-ts/) 💻 [实例](https://github.com/CircleCI-Public/circleci-config-sdk-ts/tree/main/sample) * * * ### 安装 使用 npm : ```shell $ npm i @circleci/circleci-config-sdk ``` 使用线条 : ```shell $ yarn add @circleci/circleci-config-sdk ``` #### 使用量 在浏览器中: ```typescript import CircleCI from '@circleci/circleci-config-sdk'; ``` 在节点.js中: ```javascript const CircleCI = require('@circleci/circleci-config-sdk'); ``` ### 示例 使用 TypeScript/ Javascript 生成 CircleCI 配置, 并正确输入为完整 英特利斯纳支持. ```typescript const CircleCI = require('@circleci/circleci-config-sdk'); // Instantiate new Config const myConfig = new CircleCI.Config(); // Create new Workflow const myWorkflow = new CircleCI.Workflow('myWorkflow'); myConfig.addWorkflow(myWorkflow); // Create an executor instance // Executors are used directly in jobs // and do not need to be added to the config separately const nodeExecutor = new CircleCI.executors.DockerExecutor('cimg/node:lts'); // Create Job and add it to the config const nodeTestJob = new CircleCI.Job('node-test', nodeExecutor); myConfig.addJob(nodeTestJob); // Add steps to job nodeTestJob .addStep(new CircleCI.commands.Checkout()) .addStep( new CircleCI.commands.Run({ command: 'npm install', name: 'NPM Install', }), ) .addStep( new CircleCI.commands.Run({ command: 'npm run test', name: 'Run tests', }), ); // Add Jobs to Workflow myWorkflow.addJob(nodeTestJob); // The `stringify()` function on `CircleCI.Config` will return the CircleCI YAML equivalent. const MyYamlConfig = myConfig.stringify(); // Save the config to a file in Node.js or the browser. Note, use in the browser requires user interaction. myConfig.writeFile('config.yml'); ``` `MyYamlConfig` 将持有以下字符串(一个有效的 CircleCI 配置). ```yaml version: 2.1 setup: false jobs: node-test: docker: - image: cimg/node:lts resource_class: medium steps: - checkout: {} - run: command: npm install name: NPM Install - run: command: npm run test name: Run tests workflows: myWorkflow: jobs: - node-test: {} ``` ## 获取帮助 这个开源项目利用GitHub问题和项目委员会来管理 请求和支持. 如果你找不到答案 在现有的 [问题](https://github.com/CircleCI-Public/circleci-config-sdk-ts/issues?q=), (中文(简体) ), 您可使用适当的模板打开新一期。 问题是最好的办法 circleCI 团队和开源社区可以跟踪和互动 你的问题. ### 资源 考虑在开启新问题之前检查下列共同资源. - [CircleCI 配置引用](https://circleci.com/docs/2.0/configuration-reference/) - [配置 SDK API 文档](https://circleci-public.github.io/circleci-config-sdk-ts/) - [财务问题](https://github.com/CircleCI-Public/circleci-config-sdk-ts/wiki/FAQ#what-features-of-circleci-config-are-not-supported-by-this-sdk) # 捐款 这个 [仓库](https://github.com/CircleCI-Public/circleci-config-sdk-ts) 欢迎社区捐款! 看我们的 [捐款额](https://github.com/CircleCI-Public/circleci-config-sdk-ts/blob/main/CONTRIBUTING.md) 指导如何配置您的发展环境和如何提交 质量拉动请求. # 相关 - [视觉配置编辑器](https://github.com/CircleCI-Public/visual-config-editor) ## 常见问题 ### @circleci/circleci-config-sdk 是什么？ 用 JavaScript 构建 CircleCI 配置文件的 SDK \. ### 如何安装 @circleci/circleci-config-sdk？ 在项目目录运行 npm install @circleci/circleci-config-sdk，或使用 pnpm add / yarn add / bun add。 ### @circleci/circleci-config-sdk 支持 TypeScript 吗？ 支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。 ### @circleci/circleci-config-sdk 支持 ESM 还是 CommonJS？ 以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。 ### @circleci/circleci-config-sdk 可以商用吗？ @circleci/circleci-config-sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。 ### @circleci/circleci-config-sdk 的下载量有多少？ 根据 npm 官方下载统计，@circleci/circleci-config-sdk 在 2026/10/10 – 2026/11/08 这 30 天内被下载 9,271 次，日均约 309 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。 ### @circleci/circleci-config-sdk 还在维护吗？ 最新版本 0\.12\.5 发布于 2025/05/29（1\.4 年前）；至今共发布 64 个版本，其中过去 12 个月发布了 0 个；首次发布于 2021/04/30。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。