# @ingestron/cli 中文文档

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

版本：1\.6\.0
npm 元数据更新时间：2026-11-01T08:35:33.248Z
中文译文更新时间：2026-11-01T11:37:18.188Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：146 kB，140 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.13\.0
- 运行依赖：8 个
- 首次发布：2026-10-31T16:37:33.450Z
- 最新版本发布：2026-11-01T08:35:33.044Z
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

Ingestron计划|应用|检查|模式：从定义生成平台资产。

## 安装

```sh
npm install @ingestron/cli
```

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

## README

# @ingestron / cli

这个 `ingestron` 命令：从定义生成平台资产，如 组织的标准是“安全”。

```sh
ingestron plan      # what would change in each environment's output, with diffs
ingestron apply     # write it; files edited by hand are never overwritten
ingestron check     # for CI: fail when the output is not up to date
ingestron schemas   # editor schemas for VS Code's YAML extension
```

加载定义 [`@ingestron/definitions`](https://npmcn.com/package/%40ingestron/definitions/README.md)， 使用包的标准名称(如 [砖包](https://github.com/ingestron/pack-databricks), 用 [`@ingestron/generate`](https://npmcn.com/package/%40ingestron/generate/README.md),进入 `build/<environment>/`.

## 在代码中

```ts
import { run } from "@ingestron/cli";

const code = run(["check"], {
  cwd: "definitions",
  write: (text) => process.stdout.write(text),
});
process.exitCode = code;
```

## 检查生成的包

`pnpm check:bundle <schema.json>` 检查为每个程序生成的Databricks YAML 项目模板和测试夹具对的输出 `databricks bundle schema`，从您所部署的Databricks CLI中。

## 文档

用户文档: [https://docs.ingestron.io](https://docs.ingestron.io/)． 此包的语言中立规则在 [规范/ cli](https://github.com/ingestron/ingestron/tree/main/spec/cli).

## 执照

[apache - 2.0](https://www.apache.org/licenses/LICENSE-2.0)

## 常见问题

### @ingestron/cli 是什么？

Ingestron计划\|应用\|检查\|模式：从定义生成平台资产。

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

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

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

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

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

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

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

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

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

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

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

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