CLI
dcision 命令行工具——保存 API 密钥、运行决策、列出模板、离线生成和验证决策 schema——并为脚本和 CI 提供退出码。
@dcision/cli 会安装 dcision 命令。用它从终端或脚本调用已部署的决策,并通过离线验证把决策 schema 纳入版本控制。
安装
尚未发布到 npm
@dcision/cli 尚未发布到 npm。请从 Dcision 仓库的检出副本构建它;在本页说明它已发布之前,npm 上同名的包并非来自 Dcision——不要安装它,尤其不要在 CI 中安装。
# In a checkout of the Dcision repository — Node.js 22 and pnpm 10
pnpm install
pnpm --filter "@dcision/cli..." build # builds @dcision/core, then the CLI
npm install -g ./packages/cli # puts `dcision` on your PATH, linked to this checkout
dcision --version包名后面的 ... 会先构建 CLI 所依赖的包。如果不全局安装,请用 node packages/cli/dist/bin.js 代替 dcision。它需要 Node.js 20 或更高版本。
快速开始
# Save an API key (prompted, so it stays out of your shell history)
dcision login
# Run a deployed decision
dcision decide lead-qualification \
--state '{"message":"We need pricing for 500 users and want to start next month.","company_size":500}'
# Print the raw API response, with the full distributions
dcision decide lead-qualification --state-file lead.json --probabilities --json命令
| 命令 | 说明 |
|---|---|
dcision login [--api-key <key>] [--api-url <url>] | 保存 API 密钥——省略时会提示输入,通过管道传入时从 stdin 读取。 |
dcision logout | 移除已保存的密钥。 |
dcision config list | 显示配置。 |
dcision config get <key> | 打印一项设置。 |
dcision config set <key> <value> | 更改一项设置:api-url 或 output。 |
dcision decide <slug> [options] | 运行已部署的决策。 |
dcision templates | 列出内置模板。 |
dcision init [file] [--template <id>] [--force] | 写出一个决策 schema JSON(默认 ./decision.json)。 |
dcision validate <file> | 离线验证决策 schema。 |
dcision check-state <schema-file> (--state <json> | --state-file <path>) | 离线根据 schema 验证状态。 |
dcision --version、dcision --help | 版本和帮助。 |
login
dcision login # prompts for the key
dcision login --api-key "$DCISION_API_KEY" # non-interactive
echo "$DCISION_API_KEY" | dcision login # reads stdin when piped
dcision login --api-url https://api.dcision.io # also saves the API URL密钥存储在 ~/.config/dcision/config.json 中,文件权限为 600(只有你可以读取)。dcision logout 会移除它。优先通过环境变量或 stdin 使用 --api-key,而不是在会被记录到 shell 历史的命令行中直接输入密钥。
config
| 键 | 取值 | 默认值 |
|---|---|---|
api-url | API 基础 URL | https://api.dcision.io |
output | pretty 或 json | pretty |
dcision config set output json
dcision config get api-url
dcision config listdecide
dcision decide <slug> [--state <json> | --state-file <path> | --stdin] [--file <field>=<path>…] [--probabilities] [--idempotency-key <key>] [--json]| 选项 | 说明 |
|---|---|
--state <json> | JSON 形式的状态:对象、用于列表决策的数组,或用于文本决策的带引号字符串——--state '"Hello"'。纯文本会作为文本状态发送。 |
--state-file <path> | 从 JSON 文件读取状态。 |
--stdin | 从标准输入读取状态。 |
--file <field>=<path> | 在 image、audio 或 file 字段中发送文件——本地路径(以 base64 连同文件名发送,最大 20 MB)或由 Dcision 下载的 https:// URL。可重复使用;会合并到 --state 对象中,或构成整个状态。参见输入。 |
--probabilities | 添加每个问题的完整分布(?include=probabilities)。 |
--idempotency-key <key> | 使用此 Idempotency-Key。 |
--json | 打印原始 API 响应,而不是人类可读的输出——包括 scores、composites 以及 metrics 中的 token 计数。 |
使用 --state、--state-file 或 --stdin 之一传入状态,和/或使用 --file 标志。
当状态是 JSON 对象、数组或字符串时,CLI 会把它读取为 JSON,因此它可以用对象、列表或文本状态调用和检查决策:--state '["Hi!", "Can I get a quote for 50 seats?"]'。其他任何内容——纯文本、数字——都作为文本发送;以 { 开头但无法解析的值也会作为文本发送,并给出警告。
decide 可以安全重试:当你没有传入 Idempotency-Key 时,它会自动生成一个,并在网络错误时使用相同的键重试一次,因此丢失的响应会被重放,而不是运行——和计费——两次。
人类可读的输出显示决策和版本、行动及其原因、每个问题一行(包含结果和置信度)、使用 --probabilities 时的分布,以及延迟、模型、估算成本和执行 ID。使用 --json 获取加权级别、复合指标和响应中的目的地。
# Pipe states from another tool
jq -c '.lead' event.json | dcision decide lead-qualification --stdin --json
# Text decision
dcision decide spam-detection --state '"Congratulations! You won a gift card, click here."'
# Your own idempotency key, e.g. the record ID
dcision decide support-routing --state-file ticket.json --idempotency-key ticket-55120templates 和 init
dcision templates # lists the nineteen templates: id, name, description
dcision init # writes ./decision.json
dcision init lead.json --template lead-qualification # starts from a template
dcision init triage.json --template ticket-triage # a pattern template: speculative fan-out
dcision init lead.json --template lead-qualification --force # overwrites an existing file模板 id 为 lead-qualification、support-routing、spam-detection、agent-routing、rag-relevance、ticket-triage、voice-banking、resume-screening、customer-service-router、input-guardrail、model-routing、document-reranking、tool-call-gating、reply-confidence-gate、response-grading、invoice-triage、voice-message-routing、image-moderation 和 llm-output-guardrail——参见模板。
init 写出一个决策 schema——与应用编辑器中决策 schema 下显示的 JSON 相同。没有 --force 时,它不会覆盖已有文件。
validate 和 check-state
dcision validate decision.json
dcision check-state decision.json --state '{"message":"Hi, can I get a demo?"}'
dcision check-state decision.json --state-file samples/lead-1.json两者都离线运行,使用与应用和 API 相同的规则:validate 报告每个 schema 问题及其路径——问题、结构化条目、复合指标、策略及其 and 条件、目的地——并对有效的 schema 进行汇总:其状态、问题、策略数量和目的地数量。check-state 报告某个状态为何会被 422 INVALID_STATE 拒绝——对象、文本和列表状态都适用。在 CI 中使用它们,让 schema 和示例负载与你的代码保持同步。引擎的 token 预算(同样会计入问题)由 API 在决策运行时检查。
CLI 不会创建或部署决策。请在应用中构建和部署它们;使用 init、validate 和 check-state 在你的仓库中审查和测试 schema。
环境变量
| 变量 | 说明 |
|---|---|
DCISION_API_KEY | 要使用的 API 密钥——在不运行 login 的 CI 中很方便。 |
DCISION_API_URL | API 基础 URL。默认 https://api.dcision.io。 |
DCISION_WORKSPACE | 合作伙伴模式:在子工作区(ext:<external_id>)中运行 dcision decide;--workspace 会覆盖它。 |
NO_COLOR | 禁用彩色输出。 |
退出码
| 代码 | 含义 |
|---|---|
0 | 成功。 |
1 | 验证失败——无效的 schema 或状态。 |
2 | 用法错误——未知命令、缺少参数或选项冲突。 |
3 | API 错误——API 返回了错误。 |
4 | 网络错误——无法连接 API。 |
if ! dcision validate decision.json; then
echo "decision.json is invalid" >&2
exit 1
fi