Reference / 参考手册

Environment Variables / 环境变量

Variable	Purpose / 用途
`DWS_CONFIG_DIR`	Override default config directory / 覆盖默认配置目录
`DWS_<PRODUCT>_MCP_URL`	Override a product MCP endpoint for local development / 本地开发时覆盖指定产品 MCP endpoint
`DWS_CLIENT_ID`	OAuth client ID (DingTalk AppKey)
`DWS_CLIENT_SECRET`	OAuth client secret (DingTalk AppSecret)
`DWS_TRUSTED_DOMAINS`	Comma-separated trusted domains for bearer token (default: `.dingtalk.com`). `` for dev only / Bearer token 允许发送的域名白名单，默认 `.dingtalk.com`，仅开发环境可设为 ``
`DWS_ALLOW_HTTP_ENDPOINTS`	Set `1` to allow HTTP for loopback during dev / 设为 `1` 允许回环地址 HTTP，仅用于开发调试
`DWS_DISABLE_KEYCHAIN`	macOS only. Set `1` to skip system Keychain for the encryption key and use file-based storage (same scheme as Linux). For sandboxed runtimes (e.g. Codex App) that block Keychain APIs. Weakens at-rest protection — DEK and ciphertext live in the same directory. / 仅 macOS。设为 `1` 时跳过系统 Keychain，密钥以文件形式存储（与 Linux 一致）。用于 Keychain API 被拦截的沙盒环境（如 Codex App）。代价是 DEK 与密文同目录，保护强度低于默认方案

Exit Codes / 退出码

Code	Category	Description / 描述
0	Success	Command completed successfully / 命令执行成功
1	API	MCP tool call or upstream API failure / MCP 工具调用或上游 API 失败
2	Auth	Authentication or authorization failure / 身份认证或授权失败
3	Validation	Invalid input, flags, or parameter schema mismatch / 输入参数校验失败
4	PAT	PAT authorization interception; stderr carries raw machine-readable PAT JSON / PAT 授权拦截；stderr 返回原始机器可解析 JSON
5	Internal	Unexpected internal error / 未预期的内部错误
6	Discovery	Static endpoint resolution or protocol negotiation failure / 静态端点解析或协议协商失败

With -f json, error responses include structured payloads: category, reason, hint, actions.

使用 -f json 时，错误响应包含结构化字段：category、reason、hint、actions。

Output Formats / 输出格式

dws contact user search --query "Alice" -f table   # Table (default, human-friendly / 表格，默认)
dws contact user search --query "Alice" -f json    # JSON (for agents and piping / 适合 agent)
dws contact user search --query "Alice" -f raw     # Raw API response / 原始响应
dws schema -f pretty "dev app create"                # Pretty helper-only schema view / helper-only schema 彩色分区展示

Dry Run / 试运行

dws todo task list --dry-run    # Preview MCP call without executing / 预览但不执行

Output to File / 输出到文件

dws contact user search --query "Alice" -o result.json

Schema Introspection / Schema 查询

静态端点模式下，产品命令和 flag 以当前二进制的 --help 与内置 Skill 为准。dws schema 仅保留 helper-only 子树（如 dev.*）的 schema 查询。

路径写法

dws schema                                  # 静态端点模式提示
dws schema "dev app create"                 # CLI 空格路径
dws schema --cli-path "dev app create"      # 显式 flag（脚本友好，免转义）
dws schema -f pretty "dev app create"       # ANSI 着色分区展示（人肉查看最舒服）

helper-only schema 以 CLI 路径为准；普通产品命令请使用 dws <path> --help 查看参数。

单工具输出字段

字段	说明
`name` / `cli_name` / `canonical_path`	MCP RPC 名 / CLI 叶子名 / helper-only canonical path
`group`	CLI 父级 group 路径（dot-separated）
`title` / `description`	工具名/说明（overlay 优先）
`parameters` / `required`	MCP 输入 JSON Schema 的 properties / required
`output_schema`	MCP 输出 Schema（上游下发时才有）
`sensitive`	敏感写操作，需 `--yes` 确认
`auth`	DingTalk 授权元数据，包括 `requiredScopes` / `requiredPermissions` / `recommendedScopes` / `grantProductCodes` / `riskAction` / `confirmationRequired`
`annotations.destructive_hint`	对齐 MCP 2025+ annotations，目前从 `sensitive` 映射
`flag_overlay[param]`	CLI 层对 MCP 参数的改写：`alias` / `transform` / `transform_args` / `env_default` / `default` / `hidden`

调试 --flag 行为的第一站是 flag_overlay —— 比如 --users 0232... 能不能直接用，看 receiverUserIdList.transform == "csv_to_array" 即可判断。

筛选输出

dws schema "dev app create" --jq '.tool.parameters'               # 只看参数 schema
dws schema "dev app create" --jq '.tool.required'                 # 只看必填字段

Shell Completion / 自动补全

# Bash
dws completion bash > /etc/bash_completion.d/dws

# Zsh
dws completion zsh > "${fpath[1]}/_dws"

# Fish
dws completion fish > ~/.config/fish/completions/dws.fish

5.1 KiB Raw Blame History Unescape Escape