# @ggts-sh/cli 中文文档

规范地址：https://npmcn.com/package/%40ggts-sh/cli/

版本：0\.48\.3
npm 元数据更新时间：2026-11-05T23:47:31.724Z
中文译文更新时间：2026-11-16T13:43:47.826Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：14.3 kB，14 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- 首次发布：2026-09-08T13:04:10.772Z
- 最新版本发布：2026-11-05T23:47:31.371Z
- 近 30 天下载量：2109（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：11（近 12 个月 11 个）

## 中文简介

ggts:从命令行验证并渲染出图谱(JSON)到SVG——在沙盒中写出图的代理的反馈回路.

## 安装

```sh
npm install @ggts-sh/cli
```

也可以使用：`pnpm add @ggts-sh/cli`、`yarn add @ggts-sh/cli`、`bun add @ggts-sh/cli`

## README

# @ggts-sh/cli (英语)

[![codecov](https://codecov.io/gh/ggts-sh/ggts/branch/main/graph/badge.svg?component=packages-cli)](https://app.codecov.io/gh/ggts-sh/ggts/tree/main/packages%2Fcli)

`ggts check` 财务报告和审定财务报表 `ggts render`: 验证并向 SVG 提供 ggts 绘图 spec( JSON) 命令线 这是作者 specs 的代理的反馈回路—— 它 显示验证错误、警告和仅 JSON 工作流程建议 从来没有看到.

## 此软件包为何存在

嵌入式分析代理写出一个 spec, 主机 Webapp 使其与 `@ggts-sh/react` 或者说 `@ggts-sh/svelte`没有这个CLI在代理的沙盒,代理船 光谱盲:光谱可以有计划,但可以绘制一个误导性的图表 管道警告(减速堆栈、单观测组、规模) 推论问题)在网络应用中开火,没有人读取. 随着CLI, 将JSONL的诊断结果读取在 Stderr 上,并修正 在别人看到之前的画面.

如果您嵌入了 spec- 写入代理, 请将此包作为安装的一部分 合同,不是一个选择.

## CLI涵盖什么(和不包括什么)

| 每一出戏都盖住 | Opt- in/ 主机侧 |
| --- | --- |
| Schema 验证 (`validate`(中文(简体) ) | 东道主检查 **模式** 和大多数交互线条 |
| 管道警告和咨询 | 运行时间密钥/ 线程错误( 需要实时图) |
| 规模推论诊断(`source: "scale"`(中文(简体) ) | 组成/折旧 `ondiagnostic` 没有主机 |
| 斯佩克林咨询公司(Spec-lint)`source: "spec-lint"`(中文(简体) ) | 完整的工具提示视觉QA |

检查模式是 **东道主** 能力(`<Inspect mode="xy" />` / 绘图 `inspect`),而不是PortableSpec字段。 显示同样的检查X地表 咨询人员只能通过 `ondiagnostic` 在浏览器中, 声明主机 意图 :

```sh
ggts render --inspect xy spec.json > out.svg
# stderr may include:
# {"kind":"advisory","source":"interaction","code":"INTERACTION_INSPECT_X_ON_COL",…}
```

模式 : `auto`, (中文(简体) ), `exact`, (中文(简体) ), `x`, (中文(简体) ), `y`, (中文(简体) ), `xy` (与主持人同为enum). 无 `--inspect`,交互代码没有被发明——无头的 SVG 唯一的图表 安静点 今天,这条路径覆盖了巴/col x-指向纯收藏家(包括 别名重写如此 `geom: "histogram"` 匹配主机 `normalize`; 高心动性 而运行时间密钥/线程诊断仍需要挂载主机. 见 [ADR 0024 (英语)](https://github.com/ggts-sh/ggts/blob/main/docs/decisions/0024-cli-interaction-intent.md)。 。 。 .

## 安装

```sh
npm install --save-dev --save-exact @ggts-sh/cli
npm exec -- ggts check spec.json
npm exec -- ggts render spec.json > out.svg
```

在代理沙盒图像中 :

```dockerfile
FROM node:24-slim
RUN npm install -g @ggts-sh/cli
# agents can now run: ggts render spec.json > out.svg
```

按下您 Webapp 制作的架构适配器的同版本 与——所有 `@ggts-sh/*` 软件包版本已锁定.

## 使用量

`check` 运行相同的管道和渲染检查 `render`,压制 SVG输出. 两者都保留同样的诊断和出站码合同.

```sh
ggts check spec.json                        # full checks without SVG
ggts render spec.json > out.svg          # spec from a file
ggts render < spec.json > out.svg        # spec from stdin
ggts render spec.json --data data.json   # named datasets from a file
ggts render spec.json --width 832 --height 400
ggts render --inspect xy spec.json > out.svg   # host inspect intent
```

-   `render` 写入 SVG 键入; `check` 留点空出.
-   诊断结果作为JSON的线条 `{"kind":"error",…}` | `{"kind":"warning",…}` | `{"kind":"advisory",…}`。 。 。 . 规模推论诊断集 `source: "scale"`; spec-lint 组合 `source: "spec-lint"`; 交互意图 (`--inspect`(组数) `source: "interaction"`。 。 。 .

## 退出代码

| 代码 | 含义 |
| --- | --- |
| 0 个 | 检查或提供 |
| 1个 | 渲染失败( 管道错误—— spec在结构上有效) |
| 2个 | 使用错误( 糟糕的旗帜、 无法读取的输入、 无效的 JSON) |
| 3个 | 无效的光谱( 验证错误- 见 stderr JSON 线条) |

代理环: 渲染; 3号出口应用 `fix.example` 从每个 stderr 其错误 `path`,重新提交;在出口0时仍读作stderr——警告和 咨询意见是图表质量反馈.

## 参考文献

-   [CLI 参考](https://ggts.sh/reference/cli) 所有选项和 诊断
-   不产卵程序使用 : `runCommand` 接受 `render`编号 :`check`。 。 。 . 现有 `runCLI` 仍可提供方案的API.

## 常见问题

### @ggts-sh/cli 是什么？

ggts:从命令行验证并渲染出图谱\(JSON\)到SVG——在沙盒中写出图的代理的反馈回路\.

### 如何安装 @ggts-sh/cli？

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

### @ggts-sh/cli 支持 TypeScript 吗？

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

### @ggts-sh/cli 支持 ESM 还是 CommonJS？

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

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

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

### @ggts-sh/cli 可以商用吗？

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

### @ggts-sh/cli 的下载量有多少？

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

### @ggts-sh/cli 还在维护吗？

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

