# @gobing-ai/spur 中文文档

规范地址：https://npmcn.com/package/%40gobing-ai/spur/

版本：0\.4\.35
npm 元数据更新时间：2026-11-15T01:45:13.781Z
中文译文更新时间：2026-11-16T17:45:44.550Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：15.4 MB，420 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2026-06-09T18:16:51.878Z
- 最新版本发布：2026-11-15T01:45:13.449Z
- 近 30 天下载量：5660（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：142（近 12 个月 142 个）

## 中文简介

Spur CLI——主流编码代理商的本地第一工具:强制检查、工作流程管弦、代理卫生和历史分析。 Bun-native; 曝光 `spur` 命令.

## 安装

```sh
npm install @gobing-ai/spur
```

也可以使用：`pnpm add @gobing-ai/spur`、`yarn add @gobing-ai/spur`、`bun add @gobing-ai/spur`

## README

# @gobing-ai/ spur (英语)

**这个 `spur` 命令** - 主流编码代理商的本地第一工具(Claude Code、Codex、, 双子座CLI,pi,omp,OpenCode,反重力,OpenClaw,Hermes,Grok). 斯普尔 **没有** 编码代理; 它将你已经拥有的代理 检查约束 工作流程 协调 代理健康 检查 谈话 -历史分析.

## 安装

选择与您的设置相匹配的路径 。 都给你一个全球 `spur` 命令和种子默认值 配置为 `~/.config/spur/` 第一次运行.

### 如果你有Bun的话`bun >= 1.3.0`)——建议

Npm包装一个邦包 运行在邦的运行时间 你已经有.

```bash
# Install globally → use the `spur` command everywhere
bun install -g @gobing-ai/spur
spur --help

# …or run ad-hoc with no install
bunx @gobing-ai/spur --help
```

#### 安装 `sp` 编码代理件的插件

Npm 包装 `sp` 插件及其市场与 CLI 并列 。 安装它 不克隆此寄存器而输入您的支持的编码代理 :

```bash
# point superskill at the installed @gobing-ai/spur package root
superskill install sp --marketplace $(npm root -g)/@gobing-ai/spur
```

(与邦: `bun install -g @gobing-ai/spur`; 软件包根是 `$(npm root -g)/@gobing-ai/spur` 或者说 `$(bun pm bin -g)/../lib/node_modules/@gobing-ai/spur`. ) (中文(简体) ). 登记市场和 安装 `sp` 插件到 Claude Code, Codex, 双子座 CLI, pi, omp, OpenCode, Antigravity等.

### 如果没有Bun——独立二进制

一个自成一体的可执行文件(Bun嵌入),用于macOS和Linux. 无运行时间安装 .

```bash
# One-liner: downloads the binary, puts it on PATH, seeds config
curl -fsSL https://raw.githubusercontent.com/gobing-ai/spur/main/scripts/install.sh | sh
spur --help
```

安装器下降 `spur` 输入 `~/.local/bin` 默认。 覆盖目标 `SPUR_INSTALL`, (中文(简体) ), 或用 `SPUR_VERSION`数字 :

```bash
SPUR_INSTALL=/usr/local/bin SPUR_VERSION='@gobing-ai/spur-v0.1.7' \
  sh -c "$(curl -fsSL https://raw.githubusercontent.com/gobing-ai/spur/main/scripts/install.sh)"
```

若为 `~/.local/bin` 还没有在你的 `PATH`,添加(例如:. `export PATH="$HOME/.local/bin:$PATH"` 在你的外壳简介中。 支助目标: `darwin-arm64`, (中文(简体) ), `darwin-x64`, (中文(简体) ), `linux-arm64`, (中文(简体) ), `linux-x64`。 。 。 . Windows:在WSL下使用Bun路径.

**核查.** 安装器将下载到临时文件, 检查它与发布 `SHA256SUMS`,然后在解剖学上替换 `spur`。下载失败,检查和不匹配,或 缺少 `SHA256SUMS` 留下一个未激活的现有安装并退出非零. `SPUR_RELEASE_URL` 覆盖下载基础 URL( 镜像, 或 `file://` 测试中的目录).

支票和是一个 **代码执行** 边界,而不仅仅是完整性检查:已核实 下载, 安装器 _运行_ 编号(`spur init`因此,释放谁 `SHA256SUMS` 无法校验 是无法安全安装的释放. `SPUR_SKIP_VERIFY=1` 是单一的直通绕道 打印一个警告 – 保持它用于本地或空接安装,并将脚本插入 `sh` 仅来自 一个你信任的来源.

**复放独立二相.** 运行 `bun run build:binaries` 内 `apps/cli`上传 **全部** 联 合 国 `dist/cli/spur-*` **财务报告和审定财务报表** `dist/cli/SHA256SUMS` 到 GitHub 发布标记。 释放 无 `SHA256SUMS` 默认使安装器失败.

### 货包布局(哪些船舶)

已公布的柏油球是自成一体的 Bun 捆绑外加静态资产:

| 路径 | 目的 |
| --- | --- |
| `spur.js` | CLI 条目`bin.spur`(中文(简体) ) |
| `config/` | 默认规则、工作流程、任务、模板、插件(ADR-015 SSOT) |
| `web/` | 斯普尔委员会 `spur serve` |
| `schemas/` | JSON Schema 编辑器/ CI 验证 |

`spur init` 复制全文 `config/` 树入工程 `.spur/` 目录(和种子) `~/.config/spur/` 全球第一运行). `spur serve` 从软件包中解决棋盘资产 `web/`。 。 。 .

### 首发

```bash
spur init     # scaffold .spur/ from bundled config/ + seed ~/.config/spur/ — idempotent, never clobbers
spur serve    # local board at http://localhost:3000/board (uses package web/)
```

独立安装器运行 `spur init` 给您; 邦安装在您的第一个 `spur init`。 。 。 .

## 使用量

```bash
spur init                                  # scaffold .spur/ + seed global rules
spur serve --port 5678                     # start API + Spur Board
spur rule run --preset recommended-pre-check   # evaluate constraint rules
spur workflow run <workflow.yaml>          # run an FSM workflow
spur agent run "<prompt>" --agent auto     # execute a prompt via a coding agent
spur agent doctor                          # check agent readiness
spur history import --source claude --root <path>
spur history analyze
spur status
```

每个命令都支持 `--json` 用于机器可读输出.

### 扩大Spur董事会

一个项目可以添加自己的"局"模块——一个编译的回放工具或嵌入式URL应用软件——没有 编辑此软件包。 一个安装的董事会从新项目读取 `.spur/config.yaml`数字 :

```yaml
bootstrap:
  modules:
    - id: team-board
      name: Team board
      icon: "🧭"
      type: react
      directory: board/team-board/dist
      entry: index.js
      styles: [index.css]
    - id: docs
      name: Documentation
      icon: "📚"
      type: iframe
      url: https://docs.example.test/
```

`spur init` 种子 `modules: []` (只建入); 用配置编辑更改选择, 然后重新启动 `spur serve` 并重新装入。 正式的写作合同——宣言联盟 `@gobing-ai/spur/board` 类型导出、 Vite 库设置和框架/托拉斯限制 — 位于 [下游理事会模块设计](https://github.com/gobing-ai/spur/blob/main/docs/design/downstream-board-modules.md)。 。 。 .

## 文档

完整的文件、架构和完整的指令表面都位于 [Spur 仓库](https://github.com/gobing-ai/spur)。 。 。 .

## 许可证

阿帕奇-2.0 © [罗宾敏](mailto:minlongbing@gmail.com)

## 常见问题

### @gobing-ai/spur 是什么？

Spur CLI——主流编码代理商的本地第一工具:强制检查、工作流程管弦、代理卫生和历史分析。 Bun-native; 曝光 spur 命令\.

### 如何安装 @gobing-ai/spur？

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

### @gobing-ai/spur 支持 TypeScript 吗？

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

### @gobing-ai/spur 支持 ESM 还是 CommonJS？

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

### @gobing-ai/spur 可以商用吗？

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

### @gobing-ai/spur 的下载量有多少？

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

### @gobing-ai/spur 还在维护吗？

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

