@ingestron/cli

中文文档
1.6.0发布于 2026/11/01Apache-2.0TypeScriptES Module

ingestron plan | apply | check | schemas: generate platform assets from definitions.

原始使用文档
文档目录4 节
  1. In code
  2. Checking generated bundles
  3. Documentation
  4. Licence

@ingestron/cli

The ingestron command: generates platform assets from definitions, as the organisation's standard says, safely.

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

It loads the definitions with @ingestron/definitions, builds the files with the packs its standard names, such as the Databricks pack, and writes them with @ingestron/generate, into build/<environment>/.

In code

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

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

Checking generated bundles

pnpm check:bundle <schema.json> checks the Databricks YAML generated for every project template and test fixture against the output of databricks bundle schema, from the Databricks CLI you deploy with.

Documentation

User documentation: https://docs.ingestron.io. The language-neutral rules for this package are in spec/cli.

Licence

Apache-2.0

版本与发布记录

@ingestron/cli 共发布 8 个版本,首次发布于 2026/11/01;过去 12 个月发布了 8 个版本。

版本发布日期距今
1.6.0latest2026/11/012 天前
1.5.02026/11/012 天前
1.4.02026/11/012 天前
1.3.02026/11/012 天前
1.2.02026/11/012 天前
1.1.02026/11/012 天前

关于 @ingestron/cli 的常见问题

@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 和提交记录判断。