通用约定
这一组页面列出 Runtime 的全部 372 条系统命令,按分类分成 24 个子页,每个子页里的命令都从 1 开始编号。在应用里可以在集成 → 应用 → 智能体设置 → 系统命令同一份目录中启用或停用它们。
参数说明沿用 Runtime 目录的英文原文。
用法行是模板,不是可以直接执行的命令:真正执行前要把占位符换成你自己环境里的值。
| 用法行里的写法 | 实际要输入的内容 |
|---|---|
<uuid>、<apiName>、<CODE> | 换成真实值,并把尖括号去掉:--member-id 3f2c8f0e-8b1c-4a55-9d0f-2b7a1c9e4d10 |
value、path、iso、n、json | 同样是占位符,分别代表字符串、文件路径、带时区的 ISO 时间、整数、JSON 或文件路径 |
[--limit n] | 方括号表示可选,整段可以不给 |
(--definition-json json|--definition-file path) | 圆括号加竖线表示必须二选一 |
preset:form.submit、draft|active | 原样输入其中一个;冒号保留,竖线不要输入 |
尖括号不要留在命令里:在 bash / zsh 里 < 是输入重定向符号,命令在 shell 阶段就会报错;就算写成 '<uuid>',Runtime 也会因为不是合法 UUID 而拒绝。
以 system.form.record.get 为例:
# 用法行(模板)
sl system form record get --record-id <uuid> [--json]
# 真实执行(占位符换成真实值,按需保留 --json)
sl system form record get --record-id 3f2c8f0e-8b1c-4a55-9d0f-2b7a1c9e4d10 --json
其它约定:
- 所有命令都支持追加
--json输出机器可读结果 - 布尔选项为真时写成开关,为假或不需要时省略,例如写
--include-detail而不是--include-detail true - 条件(condition)要序列化成紧凑 JSON,用单引号传给
--condition-json - 如果某个输入在用法里没有对应选项,说明当前 CLI 未开放该输入
- CLI 子命令由命令名转换而来:
system.form.layout.list对应sl system form layout list