c11r (韩语)

用于编码代理的商业层CLI. 从沙盒到运行中的组织 一个语法:

c11r <noun> <verb> [id] [--field value ...]

这是1.0行,在开发上 clean-slate 树枝。 它取代了之前的每个命令;没有保存0.x的任何命令.

语法

• 标准动词 : list, (中文(简体) ), get, (中文(简体) ), create, (中文(简体) ), update, (中文(简体) ), delete。带有状态机器的名词会添加自己的动词: c11r markets disable eu, (中文(简体) ), c11r orders approve 1001, (中文(简体) ), c11r payments capture 1001。 。 。 .
• 普通名词在CLI中没有代码. 其字段,过滤和动词出自API的图案,并 c11r schema <noun> 返回这个计划.
• 旗帜是Schema的田地,在kebab或蛇的情况下: --price-list 财务报告和审定财务报表 --price_list 都一样.
• 打开 list, (中文(简体) ), --<field> <value> 以平等方式过滤 --<field>.<op> <value> 由另一个运算符操作: --placed-at.gte 2026-11-01, (中文(简体) ), --status.in placed,approved。 。 。 . --waiting 列出现在需要决定的内容.
• 一个被点标的旗帜设定对象的一部分 : --customer.email [email protected]。数组需要 JSON 数组,用逗号分隔的值,或重复的旗帜;一系列对象需要 key=value 成对,每个旗帜一个对象: --items sku=COFFEE,quantity=2。 。 。 . --data 将字段作为 JSON 对象,或 @ 和一个文件名.
• 数额按主要单位分列: --amount 12.50。 。 。 .

内建名词

循环政策允许动词: 空动词是技能本身的名词(approve, (中文(简体) ), <noun>.<verb> 另一个管理名词在同项上的动词(payments.capture) (中文(简体) ). 删去或返还钱财的口号从不向政策开放.

登录、组织标志和秘密

二种无记. 一个 组织标志 (单位:千美元)sbx_... 从 sandbox create, (中文(简体) ), org_... 从 organizations create 财务报告和审定财务报表 organizations connect根据一个组织的数据采取行动。 这个 登录 是人类自己提供的API应用程序,用于 organizations, (中文(简体) ), members, (中文(简体) ), roles 编辑 credentials 被索赔的组织。 每个动词的用法都说它需要什么verbs[].credential),而CLI发送这一个.

c11r auth login 读取客户身份和客户秘密:

• 在终端中,在提示时键入;该密钥不重复;
• 没有终端, 从文件中 : --secret-file <path>,或默认 ~/.config/c11r/provisioning.secret。文件持有 client_id=... 财务报告和审定财务报表 client_secret=... 线条(或带有这些密钥的JSON,或单独的秘密,与 --client-id. c11r 只有在没有其他用户能够读取时才读取(模式600),删除一次读取,除非 --keep-file 提供;
• 没有终端也没有文件,它立刻停止 secret_required, (中文(简体) ), next_step.action human_step 和仪表板页面 next_step.url,并将文件,模式600作为人类完成的两行: client_id= 财务报告和审定财务报表 client_secret=。一个缺少两个值的文件得到相同的答案,没有被发送到商业层。 礛 c11r auth login 读它.

从来没有从一面旗帜或环境。 c11r在Commercial Layer交换了对子两个小时的代币,只将该代币发送给了c11r API;客户端的秘密从不离开这台机器. 两人都留在 credentials.json,模式 600,并且从未打印. c11r status 显示存储的登录为 cli.login, (中文(简体) ), { client_id, email, stored_at },或无:读于此机上,从来秘诀. auth logout 忘记登录; 其最后一个标志在两个小时内自行结束 。 组织标志留下.

organizations create 财务报告和审定财务报表 organizations connect <slug> 一次回答组织符号: 它像沙盒符号一样被存储. connect --revoke-others 并请求确认。 在一个登录且没有组织标志的组织名称下,一个组织的名词就停止了 no_credentials 和下一步 c11r organizations connect <slug>。 。 。 . members 财务报告和审定财务报表 roles 有组织标志的,没有登入该标志的,API说需要什么:一个沙盒的索赔,一个声称的组织登录. organizations 没有登录在此停留 login_required。 。 。 .

credentials create 财务报告和审定财务报表 credentials token 回答一个秘密一次。 c11r 将其写入一个有模式 600 的文件, 并打印文件、 格式和提示, 永远不显示值: 默认 ~/.config/c11r/secrets/<org>/<name>.env (单位:千美元)<id>-token.env 或 --out <path>,作为 KEY=value 线条或带 --format json 一个JSON对象。 文件在请求发送前被检查; 只有一个已经替换到 --yes。一个 git 仓库内不忽略的文件会得到警告 secret_not_ignored与 --dry-run 什么都没有写 secret_file 说它会去哪里. credentials delete 删除 c11r 为证书在 ~/.config/c11r/secrets/<org>/ 并将他们列入其中 removed_files· ; sandbox destroy 删除该组织的整个文件夹并将其命名于 forgotten.secrets。所写文件 --out 没有跟踪和停留:警告 out_files_not_tracked 因此,当这个组织的秘密被写进 --out 中,或当一个删除找不到要删除的东西时。 一个符号文件携带 CL_BASE_ENDPOINT 除了标志. sales-calls book 一次回答取消符号: 保存在 credentials.json 财务报告和审定财务报表 sales-calls cancel <booking> 发送它.

全球旗帜

破坏性动词(删除, orders cancel, (中文(简体) ), payments void 财务报告和审定财务报表 refund, (中文(简体) ), sandbox reset 财务报告和审定财务报表 destroy() 在终端中请求确认,然后发送 confirm=true。没有终端,例如当代理或调度运行CLI时,他们就永远不会等待:没有 --yes 他们马上停下来 confirmation_required 和退出代码3.

哪个组织

--org,则 C11R_ORG,则 .c11r.json 在项目文件夹中( 通过走起, 如 .git),然后设置默认值 auth switch --global,然后存储的组织,确切的保存一个(绝不是登录名词) ?org=) (中文(简体) ). 数个存储,没有命名,命令停止 org_required 并列出他们.

• 托肯斯只出现在 ~/.config/c11r/credentials.json (或低于 XDG_CONFIG_HOME),模式600. CLI从不打印一个,只是它的提示.
• .c11r.json 仅持有 { "org": "<slug>" }:没有秘密,安全可犯. sandbox create, (中文(简体) ), organizations create 财务报告和审定财务报表 auth switch 写下来 organizations connect 当文件夹没有链接时; reset 随从新的子弹; destroy 当它命名被摧毁的组织时删除它.
• 项目文件夹是一个 .c11r.json,否则与 store.yml 或者说 loops.yml,否则就是现在的. loops.yml 去那边.

输出、出错和退出代码

每个答案都是一个JSON对象 在Stdout上,API的信封:

{ "data": {}, "state": { "lifecycle": "sandbox", "plan": null, "mode": "test", "org": "zztest-blue-beans", "expires_at": "2026-11-17T00:00:00Z" }, "warnings": [], "next": [] }

CLI自己的答案 (帮助, rops.yml) 形状相同, 有 state 无效。 每个错误,API的或CLI的,是:

{
  "error": {
    "code": "state_required",
    "message": "Live mode needs a claimed organization; this is a sandbox.",
    "required_state": "claimed",
    "required_plan": null,
    "missing": null,
    "path": null,
    "next_step": { "action": "claim", "command": "c11r sandbox claim", "url": null }
  },
  "state": { "lifecycle": "sandbox", "plan": null, "mode": "test", "org": "zztest-blue-beans", "expires_at": "2026-11-17T00:00:00Z" }
}

code 稳定. missing 实值 { noun, why }, (中文(简体) ), path 旗子或球场有过失, next_step.action 一个 create_sandbox, (中文(简体) ), claim, (中文(简体) ), upgrade, (中文(简体) ), contact_sales, (中文(简体) ), create_dependency, (中文(简体) ), fix_request, (中文(简体) ), retry_later, (中文(简体) ), human_step, (中文(简体) ), none。 。 。 . human_step 只有人类能做的 比如把一个秘密保存到一个文件里 写着一个网页 url 当有一个。 CLI 可添加 did_you_mean 财务报告和审定财务报表 details。 。 。 .

rate_limited 读取和写作 : 没有处理. commercelayer_busy 财务报告和审定财务报表 commercelayer_unavailable 重审后只读;可能已经到达商业层的书写在下一步失败。 唯一的例外是 sandbox create: 它发出新鲜的 Idempotency-Key,在5xx或丢失的连接后,它会用相同的密钥重复创建,所以API会回答它制作的沙盒并存储它的令牌. 每次重试只要API说retry_after 错误中的秒,或 Retry-After 头,最多30秒;没有它,1到3秒。 当API要求超过30秒时, CLI 不等待: 错误转到代理, 与 retry_after计划好了 每次重试都会写出一行到 Stderr.

环境