aboutsummaryrefslogtreecommitdiff
path: root/website/src/content/docs/zh-cn/socket-api.mdx
diff options
context:
space:
mode:
Diffstat (limited to 'website/src/content/docs/zh-cn/socket-api.mdx')
-rw-r--r--website/src/content/docs/zh-cn/socket-api.mdx12
1 files changed, 12 insertions, 0 deletions
diff --git a/website/src/content/docs/zh-cn/socket-api.mdx b/website/src/content/docs/zh-cn/socket-api.mdx
index 3a5320b8..7454ecc7 100644
--- a/website/src/content/docs/zh-cn/socket-api.mdx
+++ b/website/src/content/docs/zh-cn/socket-api.mdx
@@ -17,6 +17,18 @@ Herdr 为需要检查或控制运行中会话的脚本和智能体提供了一ä¸
这些层共享同一套控制面。
+## Schema
+
+安装的 CLI 可以打印该 Herdr 二进制中包含的 socket 协议 schema:
+
+```bash
+herdr api schema
+herdr api schema --json
+herdr api schema --output herdr-api.schema.json
+```
+
+普通的 `herdr api schema` 打印简短摘要。`--json` 打印供工具使用的完整 JSON Schema,`--output PATH` 将该文档写入文件。schema 覆盖原始请求、成功响应、错误响应、发出的事件和订阅事件。
+
## 你能控制什么
socket API 可以: