# @codespar/cli 中文文档

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

版本：0\.22\.6
npm 元数据更新时间：2026-11-02T12:52:21.803Z
中文译文更新时间：2026-11-10T07:58:13.711Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：6.5 MB，1075 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=20
- 运行依赖：2 个
- 首次发布：2026-04-19T18:24:42.942Z
- 最新版本发布：2026-11-02T12:52:21.290Z
- 近 30 天下载量：2675（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：41（近 12 个月 41 个）

## 中文简介

代码Spar CLI. 拉丁美洲货币移动代理操作系统,来自您的终端:认证,浏览服务器,薄荷任务,执行工具,管理会话,流日志.

## 安装

```sh
npm install @codespar/cli
```

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

## README

# @ codespar/ cli (中文(简体) )

CodeSpar 的命令行界面——认证,浏览服务器,执行工具,管理会话,流日志,以及您终端的脚手架项目.

## 安装

```bash
npm install -g @codespar/cli
```

## 使用量

```bash
# Authenticate (stores API key in ~/.codespar/config.json)
codespar login

# Browse the catalog
codespar servers list
codespar tools list --server asaas

# Run a single tool call
codespar execute codespar_pay \
  --server asaas \
  --input '{"method":"pix","amount":15000,"currency":"BRL"}'

# Give an agent a unified multi-currency wallet under ONE signed mandate:
# a Pix (BRL) slot and a USDC slot, each with its own per-currency cap. No FX.
codespar mandate create --consumer shopper --agent buyer \
  --payee https://x402.codespar.dev/api/market-data,11144477735 \
  --slot BRL:pix:50000:1500 \
  --slot USDC:usdc:100:100

# See the wallet, rolled up per currency
codespar wallet shopper

# The same mandate pays a 402-protected API in USDC (gated by the USDC per-tx cap)
codespar spend --mandate <id> --amount 1 --agent buyer \
  --payee https://x402.codespar.dev/api/market-data

# Move value between slots (per-currency, no FX — a cross-currency move is a real
# ramp trade at the real rate). Omit --execute to just plan it.
codespar transfer shopper --from BRL --to USDC --amount 15000

# Every published meta-tool is invocable by name; the actions come from the
# published definition, so an unknown one is refused before anything is sent
codespar tools meta
codespar tool codespar_wallet --action balance --arg consumer_id=con_0000
codespar pay --action status --arg reference=pay_0000

# Resource groups are derived from the served OpenAPI document: each
# subcommand is one operation, its path parameters are the positionals
codespar sellers status slr_0000
codespar wallets list --query status=active
codespar triggers create --input '{"url":"https://example.test/hook","events":["payment.settled"]}'
codespar boletos list con_0000

# Manage sessions and logs
codespar sessions list
codespar logs tail --server stripe

# Scaffold a new agent
codespar init my-agent
```

## 图标

| 命令 | 说明 |
| --- | --- |
| `login` | 将 API 密钥保存到 `~/.codespar/config.json` |
| `logout` | 清除存储的 API 密钥 |
| `whoami` | 显示组织、项目和关键 证书决心 |
| `servers list` | 列出服务器( 过滤器由 `--category`, (中文(简体) ), `--region`(中文(简体) ) |
| `servers show <id>` | 显示服务器的细节和工具 |
| `tools list` | 列表工具( 过滤器由 `--server`(中文(简体) ) |
| `tools show <name>` | 显示工具的全部输入/输出计划 |
| `tools meta [name]` | 15个已公布的元工具定义——行动、需要的投入、词汇 |
| `tool <name>` | 启动任何已发布的元工具 : `--action`, (中文(简体) ), `--arg key=value`, (中文(简体) ), `--input` |
| `pay` 编号 : `kyc` | 简指 `tool codespar_pay` 编号 : `tool codespar_kyc` |
| `consumers <sub>` | 消费者:简介、Pix密钥、Pix查询、收据、联系人核查 |
| `boletos <sub>` | DDA: 订阅一个文档, 列出它收到的花生 |
| `sellers <sub>` | 销售者:上岗状态、保管、待结算、分类账 |
| `mcp-servers <sub>` | 租户MCP服务器:注册、验证、补丁工具、扫描平台收费 |
| `wallets <sub>` | 钱包:结余、分类账、资金来源、执行、转移、保管 |
| `triggers <sub>` | 触发器(webhooks):终点,交付,DLQ,秘密旋转,再交付 |
| `execute <tool>` | 在丢弃的会话中运行单个工具呼叫 |
| `discover <query>` | 搜索匹配使用大小写的工具目录 |
| `agent run <dir>` | 运行一个基于代理目录的回合 `@codespar/agent-core` (单位:千美元)`--input`, (中文(简体) ), `--approve`编号 :`--deny`(通过其本身) `npm start`; 输出相同, 退出代码相同 |
| `eval <dir>` | 运行代理的 `npm run check` + 键 `npm run eval` (对抗性套房和假设情况),每例1行;任何故障后1出入口 |
| `mandate create` | 建立消费者授权——代理方津贴. `--slot CURRENCY:METHOD:CAP:PER_TX` (可重复,例如:. `BRL:pix:50000:1500`)用于统一的多货币钱包;每货币上限,无FX |
| `mandate revoke <id>` | 取消消费者授权`POST /v1/mandates/{id}/revoke`; 活动或已暂停 ; 已撤销, 终端. `--reason` 进入证据行 |
| `wallet <consumer>` | 显示消费者的统一钱包,按货币滚动 |
| `transfer <consumer>` | 在钱包槽间移动值( N)`--from --to --amount [--execute]`); 跨货币移动是按实际利率进行的真正斜坡交易,没有FX |
| `spend` | 根据任务执行代理支出(x402 / USDC / Pix,由收款人路由) |
| `charge` | 通过下列方式发出入境费: `codespar_charge` |
| `ship` | 生成标签 / 引用率 / 音轨通过 `codespar_ship` |
| `ledger` | 后条目 / 读取余额 / 通过 `codespar_ledger` |
| `issue` | 发放/冻结/读取代理使用卡 `codespar_issue` |
| `payment-status <id>` | Poll 自动结算状态( 添加) `--stream`(中文(简体) ) |
| `verification-status <id>` | Poll 合成 KYC 状态( 添加) `--stream`(中文(简体) ) |
| `wizard [server]` | 连接向导 — 需要的秘密, 连接 URL, 下一步 |
| `sessions list` | 列出最近的会话( Filter by `--status`, (中文(简体) ), `--limit`(中文(简体) ) |
| `sessions show <id>` | 显示会话细节( 添加) `--logs` 用于工具呼叫) |
| `sessions close <id>` | 关闭活动会话 |
| `connect list` | 每个用户列出活动连接链接 |
| `connect start <server>` | 启动 OAuth 连接链接流量( 添加) `--open`(中文(简体) ) |
| `connect revoke <server>` | 取消连接 |
| `logs tail` | 实时流用工具调用日志( SSE) |
| `audit replay` | 询问 API 是否在一个间隔时间内验证了审计链(`--from`编号 :`--to`, ISO 8601) 并做出裁决; 链式检查运行服务器侧, 当裁决不是时退出 1 `verified` |
| `init <name> [--template <slug>]` | 从模板中为新的商务代理提供脚手架; `init --list` 给他们看看 |

## 全球旗帜

| 旗帜 | 说明 |
| --- | --- |
| `--json` | 机器可读 JSON 输出(管道输入) `jq`(中文(简体) ) |
| `--api-key <key>` | 覆盖存储的密钥 |
| `--base-url <url>` | 指向自定义的 API( 固定, 自动托管) |
| `--project <id>` | 项目范围要求(多项目类) |

资源组子命令也使用 `-q, --query key=value` (可重复), `--timeout <ms>`,并且——当行动宣布请求机构时—— `-i, --input '<json>'` 或者说 `-f, --input-file <path>`每个子命令 `--help` 列出所需文档标记的查询参数(用于 实例 `owner` 打开 `codespar shop instruments`),结尾为一个例子 每个位置,每个需要 `-q` 键和身体旗帜.

## 命令来自何处

资源组和元工具命令不逐一写出. `codespar sellers`, (中文(简体) ), `consumers`, (中文(简体) ), `boletos`, (中文(简体) ), `mcp-servers`, (中文(简体) ), `wallets` 财务报告和审定财务报表 `triggers` 来源于 `API_OPERATIONS` - 手术台 `@codespar/sdk` 从已服务 OpenAPI 文档生成 – 所以 a 子命令是一个操作,它背后的请求是 文档声明. `codespar tool <name>` 读取15个共享的元工具 定义 `@codespar/types`:名称、动作和 需要的输入是已公布的,在发送任何信息之前检查.

没有命令的资源家族需要一个书面的例外,但日期除外 (单位:千美元)`src/surface.ts`)),覆盖范围测试拒绝让名单增加.

## 配置

解析顺序( 第一局胜出) :

1.  命令行旗( R)`--api-key`, (中文(简体) ), `--base-url`, (中文(简体) ), `--project`(中文(简体) )
2.  环境变量`CODESPAR_API_KEY`, (中文(简体) ), `CODESPAR_BASE_URL`, (中文(简体) ), `CODESPAR_PROJECT`(中文(简体) )
3.  配置文件于 `~/.codespar/config.json` (chmod 600) (英语)

## 模板

`codespar init --list` 从软件包本身打印此表格,并加一个 每个模板的一行描述.

| 粘贴 | 堆栈 |
| --- | --- |
| `pix-agent` | 节点 + OpenAI — 最小 Pix 充电 + WhatsApp 通知 |
| `ecommerce-checkout` | 节点 + Claude — 完整循环 |
| `streaming-chat` | Next.js + Vercel AI — 逐个符号流出 |
| `multi-tenant` | Next.js + OpenAI——一款API密钥,N租户 |
|  |  |
| `bills-agent` | 启动工具箱—— 消费者将月份的账单委托给一个根据署名授权付款的代理人:按月支付上限,月上限,名收款人,到期. 每一笔付款都退回收据. |
| `checkout-agent` | 启动工具箱—— 在谈话中发售的商家代理人:客户用一推车制造出代码价格,随行人员(或销售政策)确认订单,一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一比一 收费 付了. |
| `collections-agent` | 启动工具箱—— 商人的代理人收集:在谈判信封内与付款人商定条件,每分期发行一波勒皮克,并配有一等钥匙,在谈话中呈现QR和复制与粘贴,并结束商业的周期. forcer.paid或commerce. 已经过期了. |
| `hello-agent` | 启动工具箱—— 代码-代理-建设者技能的活例子:只读的代理,读取月份的账单,无法支付. 由五个文件,包和一包模块所建. |
| `supplier-payments-agent` | 启动工具箱——一家公司将供应商、佣金和工资发放给一家代理商,该代理商根据一项签署的授权分批付款。 一个批次是处决的循环:一次拒绝不能阻止其他处决,而重新运行它给任何人两次钱. |
|  |  |

这些标记之间的套装行由 `npm run sync:kit-templates` 从每个经纪人自己的 `description`。不要用手编辑它们:下一次同步 覆盖它们,这就是重点——下一张手拍的列表被扭曲 特工登陆.

### 启动 kit 模板

工具箱模板是 [代码/代理启动键](https://github.com/codespar/agent-starter-kits), (中文(简体) ), 在发布时复制到这个包中 —— 每一个被同步的 ref 携带的代理, 发现而非列出,这就是上表产生的原因. `init` 绝不要把他们捉走,他们只得享受所降示的焦油丸所携带的 线下工作,两个安装相同的CLI版本脚手架 字节.

```
codespar init my-bills --template bills-agent
cd my-bills
cp agents/bills-agent/.env.example agents/bills-agent/.env   # then fill in your keys
npm install
npm run consent -- --yes
npm start
```

脚手架镜像 工具包库: `agents/<name>/` 和包 - 当地 代理软件包需要的是工具包自己的文件,字节的字节,在一个 生成根 `package.json` 链接它们为 npm 工作空间。 没有 软件包发布于 npm - `@codespar/agent-core` 而且,因为跑者是 分开它, `@codespar/agent-runtime`,拥有 `codespar-agent` 选项 每一个经纪人的脚本都打过电话 所以他们都卖了 经纪人自己的针 和资料库里的一样 坚决地处理好这些副本 哪一个 销售商从代理商的依赖中走出, 转接,和一个建筑 将留下一个被拒绝,而不是被运出:没有目录的针头 在它后面发送 `npm install` 给登记册的软件包 在那里发表。 包里没有东西是重写的: `agent.yaml` 留着 药包 `cli:` 财务报告和审定财务报表 `mcp:` 针和每个相对路径 (单位:千美元)`../../tsconfig.base.json`,则 `.env` 代理从自己的目录读取, 其 README 名称的路径 ) 继续解析 .

模板本身的根脚本被缩小到一个代理,以及它的 `check` 包根的:包根的接通了回波级的门 文件的单个代理模板不携带.

`templates/kits.lock.json` (b) 已同步(立方或承诺)的参考工具包记录, 承诺它, 和内容散列每个模板。 释放门 (单位:千美元)`npm run check:kit-templates`,在CI和出版工作流程中运行) 获取再次校正, 重建模板并失败, 如果已套件 树与按字节排列的锁不同——手版模板或锁 没有同步就撞上船了.

**撞出包来** 到新标签或承诺,来自 `packages/cli`数字 :

```
npm run sync:kit-templates -- --ref <tag-or-sha>   # rewrites templates/<kit>/, the lock and the README rows
git add templates README.md && git commit
```

凸起可以带来以前不存在的代理,因此可以添加模板 同步写上方的表格和锁,以及 `codespar init --list` 读取 锁上锁 运行 e2e 任务( R)`CODESPAR_CLI_KIT_E2E=1`) 在凸起上:这是唯一的大门 证明新生成的模板仍然安装和通过自己的模板 `npm run check`,每个模板的锁名.

然后按下这个软件包的版本(新模板内容至少是次要的). 无 `--ref` 同步重运行在锁定的 ref 上,这是通往 在同步脚本本身更改后重新生成树 .

## 还需要吗?

需要治理、预算限制和代理付款的审计线索? **[代码Spar 企业](https://codespar.dev/enterprise)** 在这些MCP服务器上添加了政策引擎,支付路由,以及合规模板.

## 许可证

麻省理工学院 - [代码.dev](https://codespar.dev/)

## 常见问题

### @codespar/cli 是什么？

代码Spar CLI\. 拉丁美洲货币移动代理操作系统,来自您的终端:认证,浏览服务器,薄荷任务,执行工具,管理会话,流日志\.

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

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

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

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/codespar\_\_cli 是否存在。

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

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

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

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

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

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

### @codespar/cli 的下载量有多少？

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

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

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