Repository navigation
Command Catalog
本页由运行时操作目录生成。当前主机以 sbv commands --json 为准;
单项参数、安全分类和输入约束使用 sbv schema <operation-id> --json 查询。
sbv agent commands --json 与 sbv agent schema <operation-id> --json 是兼容入口。
操作描述不替代各协议 typed record 的校验,也不代表主机已安装或通过运行态验收。
完整用法中的占位符需要替换为实际值;--json 的 stdout 只返回一个 JSON 对象。
命令具体输入、并发和服务影响与同一操作描述共同维护。
列出 REALITY 伪装候选并检测 HTTP(S) 可用性
sbv hy2 masquerade-check --json [--url HTTP(S)_URL]| 契约 | 值 |
|---|---|
| 命令 | sbv hy2 masquerade-check |
| Agent 兼容入口 | sbv agent hy2 masquerade-check |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | none |
| CAS | none |
| 输入契约 | optional public HTTP(S) URL; HEAD, DNS and TLS verification; 5s connect/10s total, at most 3 redirects; no HY2 TLS identity change |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"single JSON envelope"} |
--url |
string |
false |
{"description":"public HTTP(S) URL; omit to list REALITY candidates without network access"} |
存储布局、迁移状态与系统入口及旧目录阻塞路径
sbv storage status --json| 契约 | 值 |
|---|---|
| 命令 | sbv storage status |
| Agent 兼容入口 | sbv agent storage status |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | none |
| CAS | none |
| 输入契约 | fixed owned legacy paths; no arbitrary source/destination |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"single JSON envelope"} |
检查活动文件与离线历史备份并迁移至统一私有目录
sbv storage migrate --json --yes| 契约 | 值 |
|---|---|
| 命令 | sbv storage migrate |
| Agent 兼容入口 | sbv agent storage migrate |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | legacy_and_storage_exclusive |
| CAS | journal |
| 输入契约 | fixed owned legacy paths; no arbitrary source/destination |
| 服务影响 | restart_possible |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"single JSON envelope"} |
--yes |
boolean |
true |
{"description":"confirm migration and possible service restart"} |
恢复未完成的目录迁移
sbv storage recover --json --yes| 契约 | 值 |
|---|---|
| 命令 | sbv storage recover |
| Agent 兼容入口 | sbv agent storage recover |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | legacy_and_storage_exclusive |
| CAS | journal |
| 输入契约 | fixed owned legacy paths; no arbitrary source/destination |
| 服务影响 | restart_possible |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"single JSON envelope"} |
--yes |
boolean |
true |
{"description":"confirm migration and possible service restart"} |
协议、环境及操作能力
sbv capabilities --json| 契约 | 值 |
|---|---|
| 命令 | sbv capabilities |
| Agent 兼容入口 | sbv agent capabilities |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | none |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
完整操作目录及自动化边界
sbv commands --json| 契约 | 值 |
|---|---|
| 命令 | sbv commands |
| Agent 兼容入口 | sbv agent commands |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | none |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
版本、服务和安装摘要
sbv status --json| 契约 | 值 |
|---|---|
| 命令 | sbv status |
| Agent 兼容入口 | sbv agent status |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
脱敏节点摘要
sbv nodes --json| 契约 | 值 |
|---|---|
| 命令 | sbv nodes |
| Agent 兼容入口 | sbv agent nodes |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
完整节点连接材料
sbv links --json| 契约 | 值 |
|---|---|
| 命令 | sbv links |
| Agent 兼容入口 | sbv agent links |
| 变更状态 | false |
| 敏感输出 | true |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
检查运行配置
sbv check --json| 契约 | 值 |
|---|---|
| 命令 | sbv check |
| Agent 兼容入口 | sbv agent check |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
只读诊断
sbv doctor --json| 契约 | 值 |
|---|---|
| 命令 | sbv doctor |
| Agent 兼容入口 | sbv agent doctor |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
WARP 脱敏状态
sbv warp --json| 契约 | 值 |
|---|---|
| 命令 | sbv warp |
| Agent 兼容入口 | sbv agent warp |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
描述操作参数及安全契约
sbv schema <operation-id> --json| 契约 | 值 |
|---|---|
| 命令 | sbv schema |
| Agent 兼容入口 | sbv agent schema |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | none |
| CAS | none |
| 输入契约 | operation-id from commands.operations[].id |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
operation-id |
string |
true |
{"description":"stable ID from commands catalog"} |
固定版本核心升级预检
sbv core upgrade-check --json x.y.z| 契约 | 值 |
|---|---|
| 命令 | sbv core upgrade-check |
| Agent 兼容入口 | sbv agent upgrade-check |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | exact x.y.z version; no implicit latest |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
version |
string |
true |
{"description":"exact target version","pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+$"} |
固定版本核心升级
sbv core upgrade --json x.y.z --yes| 契约 | 值 |
|---|---|
| 命令 | sbv core upgrade |
| Agent 兼容入口 | sbv agent upgrade |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | none |
| 输入契约 | exact x.y.z version; no implicit latest |
| 服务影响 | restart |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
version |
string |
true |
{"description":"exact target version","pattern":"^[0-9]+\\.[0-9]+\\.[0-9]+$"} |
instance view
sbv instance view <protocol> --json [--id ID] [--expected-revision N]| 契约 | 值 |
|---|---|
| 命令 | sbv instance view |
| Agent 兼容入口 | sbv agent instance view |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--expected-revision |
integer |
false |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--id |
string |
false |
{"description":"existing managed identity"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance diagnose
sbv instance diagnose <protocol> --json [--id ID] [--expected-revision N]| 契约 | 值 |
|---|---|
| 命令 | sbv instance diagnose |
| Agent 兼容入口 | sbv agent instance diagnose |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--expected-revision |
integer |
false |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--id |
string |
false |
{"description":"existing managed identity"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance export
sbv instance export <protocol> --json [--id ID] [--expected-revision N]| 契约 | 值 |
|---|---|
| 命令 | sbv instance export |
| Agent 兼容入口 | sbv agent instance export |
| 变更状态 | false |
| 敏感输出 | true |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--expected-revision |
integer |
false |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--id |
string |
false |
{"description":"existing managed identity"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance create
sbv instance create <protocol> --json --yes --expected-revision N --file record.json [--allow-public]| 契约 | 值 |
|---|---|
| 命令 | sbv instance create |
| Agent 兼容入口 | sbv agent instance create |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; optional listen.tcp_fast_open defaults true on TCP create, omitted on replace preserves prior value; explicit HY2 obfs/masquerade; see Protocol-Instances.md; writes exclude vless-reality |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--file |
path |
true |
{"description":"complete private JSON input; credentials stay out of argv"} |
--allow-public |
boolean |
false |
{"description":"explicit consent for non-loopback exposure"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance replace
sbv instance replace <protocol> --json --yes --expected-revision N --file record.json [--allow-public]| 契约 | 值 |
|---|---|
| 命令 | sbv instance replace |
| Agent 兼容入口 | sbv agent instance replace |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; optional listen.tcp_fast_open defaults true on TCP create, omitted on replace preserves prior value; explicit HY2 obfs/masquerade; see Protocol-Instances.md; writes exclude vless-reality |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--file |
path |
true |
{"description":"complete private JSON input; credentials stay out of argv"} |
--allow-public |
boolean |
false |
{"description":"explicit consent for non-loopback exposure"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance delete
sbv instance delete <protocol> --json --yes --expected-revision N --id ID| 契约 | 值 |
|---|---|
| 命令 | sbv instance delete |
| Agent 兼容入口 | sbv agent instance delete |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--id |
string |
true |
{"description":"existing managed identity"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance default
sbv instance default <protocol> --json --yes --expected-revision N --id ID| 契约 | 值 |
|---|---|
| 命令 | sbv instance default |
| Agent 兼容入口 | sbv agent instance default |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--id |
string |
true |
{"description":"existing managed identity"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance rebuild
sbv instance rebuild <protocol> --json --yes --expected-revision N| 契约 | 值 |
|---|---|
| 命令 | sbv instance rebuild |
| Agent 兼容入口 | sbv agent instance rebuild |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance takeover
sbv instance takeover <protocol> --json --yes --expected-revision N [--allow-public]| 契约 | 值 |
|---|---|
| 命令 | sbv instance takeover |
| Agent 兼容入口 | sbv agent instance takeover |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--allow-public |
boolean |
false |
{"description":"explicit consent for non-loopback exposure"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance migrate
sbv instance migrate <protocol> --json --yes --expected-revision N| 契约 | 值 |
|---|---|
| 命令 | sbv instance migrate |
| Agent 兼容入口 | sbv agent instance migrate |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
instance recover
sbv instance recover <protocol> --json --yes --expected-revision N| 契约 | 值 |
|---|---|
| 命令 | sbv instance recover |
| Agent 兼容入口 | sbv agent instance recover |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed protocol record; see Protocol-Instances.md; writes exclude vless-reality; migrate only mixed |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
protocol |
enum |
true |
{"description":"read: all managed protocols; write: excludes vless-reality; migrate: mixed only"} |
component list
sbv component list --json| 契约 | 值 |
|---|---|
| 命令 | sbv component list |
| Agent 兼容入口 | sbv agent component list |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
component diagnose
sbv component diagnose --json| 契约 | 值 |
|---|---|
| 命令 | sbv component diagnose |
| Agent 兼容入口 | sbv agent component diagnose |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
component export
sbv component export --json --id ID [--expected-revision N]| 契约 | 值 |
|---|---|
| 命令 | sbv component export |
| Agent 兼容入口 | sbv agent component export |
| 变更状态 | false |
| 敏感输出 | true |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--expected-revision |
integer |
false |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--id |
string |
true |
{"description":"existing managed identity"} |
component create
sbv component create --json --yes --expected-revision N --file record.json [--allow-public]| 契约 | 值 |
|---|---|
| 命令 | sbv component create |
| Agent 兼容入口 | sbv agent component create |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--file |
path |
true |
{"description":"complete private JSON input; credentials stay out of argv"} |
--allow-public |
boolean |
false |
{"description":"explicit consent for non-loopback exposure"} |
component replace
sbv component replace --json --yes --expected-revision N --file record.json [--allow-public]| 契约 | 值 |
|---|---|
| 命令 | sbv component replace |
| Agent 兼容入口 | sbv agent component replace |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--file |
path |
true |
{"description":"complete private JSON input; credentials stay out of argv"} |
--allow-public |
boolean |
false |
{"description":"explicit consent for non-loopback exposure"} |
component delete
sbv component delete --json --yes --expected-revision N --id ID| 契约 | 值 |
|---|---|
| 命令 | sbv component delete |
| Agent 兼容入口 | sbv agent component delete |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--id |
string |
true |
{"description":"existing managed identity"} |
component rebuild
sbv component rebuild --json --yes --expected-revision N| 契约 | 值 |
|---|---|
| 命令 | sbv component rebuild |
| Agent 兼容入口 | sbv agent component rebuild |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
component takeover
sbv component takeover --json --yes --expected-revision N [--allow-public]| 契约 | 值 |
|---|---|
| 命令 | sbv component takeover |
| Agent 兼容入口 | sbv agent component takeover |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
--allow-public |
boolean |
false |
{"description":"explicit consent for non-loopback exposure"} |
component recover
sbv component recover --json --yes --expected-revision N| 契约 | 值 |
|---|---|
| 命令 | sbv component recover |
| Agent 兼容入口 | sbv agent component recover |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | revision |
| 输入契约 | typed component record; see Advanced-Components.md |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-revision |
integer |
true |
{"description":"same-snapshot revision; recovery uses journal expected revision"} |
服务 status
sbv service status --json| 契约 | 值 |
|---|---|
| 命令 | sbv service status |
| Agent 兼容入口 | sbv agent service status |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
服务 start
sbv service start --json --yes| 契约 | 值 |
|---|---|
| 命令 | sbv service start |
| Agent 兼容入口 | sbv agent service start |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | none |
| 输入契约 | no pending instance/component/routing journal; known service state; current config must pass sing-box check |
| 服务影响 | start |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
服务 stop
sbv service stop --json --yes| 契约 | 值 |
|---|---|
| 命令 | sbv service stop |
| Agent 兼容入口 | sbv agent service stop |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | none |
| 输入契约 | no pending instance/component/routing journal; known service state |
| 服务影响 | stop |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
服务 restart
sbv service restart --json --yes| 契约 | 值 |
|---|---|
| 命令 | sbv service restart |
| Agent 兼容入口 | sbv agent service restart |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | none |
| 输入契约 | no pending instance/component/routing journal; known service state; current config must pass sing-box check |
| 服务影响 | restart |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
服务 logs
sbv service logs --json [--lines N]| 契约 | 值 |
|---|---|
| 命令 | sbv service logs |
| Agent 兼容入口 | sbv agent service logs |
| 变更状态 | false |
| 敏感输出 | true |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | logs: 1 <= lines <= 1000; default 100; no follow |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--lines |
integer |
false |
{"description":"1..1000; default 100"} |
统一分流 view
sbv routing view --json| 契约 | 值 |
|---|---|
| 命令 | sbv routing view |
| Agent 兼容入口 | sbv agent routing view |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
统一分流 export
sbv routing export --json| 契约 | 值 |
|---|---|
| 命令 | sbv routing export |
| Agent 兼容入口 | sbv agent routing export |
| 变更状态 | false |
| 敏感输出 | true |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | complete private routing draft with fingerprint; export .data.draft; see Agent-CLI.md |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
统一分流 nodes
sbv routing nodes --json| 契约 | 值 |
|---|---|
| 命令 | sbv routing nodes |
| Agent 兼容入口 | sbv agent routing nodes |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | — |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
统一分流 validate
sbv routing validate --json --file draft.json| 契约 | 值 |
|---|---|
| 命令 | sbv routing validate |
| Agent 兼容入口 | sbv agent routing validate |
| 变更状态 | false |
| 敏感输出 | false |
| 确认 | — |
| 并发条件 | shared |
| CAS | none |
| 输入契约 | complete private routing draft with fingerprint; export .data.draft; see Agent-CLI.md |
| 服务影响 | none |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--file |
path |
true |
{"description":"complete private JSON input; credentials stay out of argv"} |
统一分流 apply
sbv routing apply --json --yes --file draft.json| 契约 | 值 |
|---|---|
| 命令 | sbv routing apply |
| Agent 兼容入口 | sbv agent routing apply |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | fingerprint |
| 输入契约 | complete private routing draft with fingerprint; export .data.draft; see Agent-CLI.md |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | true |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--file |
path |
true |
{"description":"complete private JSON input; credentials stay out of argv"} |
统一分流 restore
sbv routing restore --json --yes --expected-fingerprint HASH| 契约 | 值 |
|---|---|
| 命令 | sbv routing restore |
| Agent 兼容入口 | sbv agent routing restore |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | fingerprint |
| 输入契约 | current fingerprint SHA256 required |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
--expected-fingerprint |
string |
true |
{"description":"SHA256 of the state observed before changing it"} |
统一分流 recover
sbv routing recover --json --yes| 契约 | 值 |
|---|---|
| 命令 | sbv routing recover |
| Agent 兼容入口 | sbv agent routing recover |
| 变更状态 | true |
| 敏感输出 | false |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | journal |
| 输入契约 | trusted journal owns recovery CAS |
| 服务影响 | restart_if_active |
| 外部写入 | false |
| 可能涉及外部写入 | true |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
推送节点到 SubMan;旧 agent subman-sync 无确认参数
sbv subman sync --json --yes| 契约 | 值 |
|---|---|
| 命令 | sbv subman sync |
| Agent 兼容入口 | sbv agent subman-sync |
| 变更状态 | true |
| 敏感输出 | true |
| 确认 | --yes |
| 并发条件 | exclusive |
| CAS | none |
| 输入契约 | existing private SubMan settings; legacy command remains compatible |
| 服务影响 | external_write |
| 外部写入 | true |
| 可能涉及外部写入 | false |
| 参数 | 类型 | 必需 | 说明与约束 |
|---|---|---|---|
--json |
boolean |
true |
{"description":"exactly one JSON envelope on stdout"} |
--yes |
boolean |
true |
{"description":"explicit mutation confirmation"} |
下列遗留操作尚无结构化写入口。使用所列菜单并遵守目标环境的操作授权; 不要通过拼接提示答案或直接改状态文件绕过这些边界。
| 操作 ID | 操作 | 菜单 / 手工入口 | 副作用 / 服务影响 | 限制原因 |
|---|---|---|---|---|
install |
安装新协议 | 1 |
{"mutation":true,"sensitive":true,"service_impact":"start_or_restart"} |
fresh install requires dependency, TLS and credential prompts |
reality.write |
REALITY 实例、名称与 QoS 写操作 | 2 |
{"mutation":true,"sensitive":true,"service_impact":"restart_possible"} |
legacy REALITY writes do not implement typed revision/CAS transactions |
protocol.remove |
按协议批量移除 | 3 |
{"mutation":true,"sensitive":false,"service_impact":"restart_or_stop"} |
use typed instance delete when supported; bulk legacy removal remains interactive |
core.uninstall |
卸载 sing-box | 5 |
{"mutation":true,"sensitive":false,"service_impact":"stop_and_remove"} |
stopped-state and owned-firewall checks are enforced; whole-uninstall rollback and structured result are not implemented |
node.qr |
显示节点二维码 | 11 |
{"mutation":false,"sensitive":true,"service_impact":"none"} |
terminal rendering; use sensitive links for machine connection material |
subman.settings |
SubMan 配置管理 | 11 |
{"mutation":true,"sensitive":true,"service_impact":"none"} |
settings currently use interactive secret input |
system.stack |
入站/出站协议栈设置 | 13 |
{"mutation":true,"sensitive":false,"service_impact":"restart"} |
host and listener changes lack a unified persistent rollback contract |
system.bbr |
BBR 设置 | 13 |
{"mutation":true,"sensitive":false,"service_impact":"host_network"} |
host sysctl mutation has no structured transaction interface |
system.media |
媒体解锁测试 | 12 -> 4 |
{"mutation":true,"sensitive":false,"service_impact":"none"} |
external executable probe may download/update its local backend and launch temporary processes; no stable structured result |
script.uninstall |
卸载管理脚本 | 15 |
{"mutation":true,"sensitive":false,"service_impact":"configuration_removal_possible"} |
destructive self-removal remains interactive |
这些入口可直接调用,仍使用文本结果;不要将其 stdout 当作结构化 JSON。
| 操作 ID | 用法与别名 | 变更 / 敏感 | 确认 / 并发 | 限制 |
|---|---|---|---|---|
script.update |
["sbv update sbv","sbv update-sbv","sbv update-script","sbv update script"] |
{"mutation":true,"sensitive":false} |
{"concurrency":"exclusive","confirmation":null} |
existing transactional updater emits human text, not the Agent envelope |
core.update |
["sbv update sing-box [latest|x.y.z]","sbv update-sing-box [latest|x.y.z]","sbv update-singbox [latest|x.y.z]","sbv update singbox [latest|x.y.z]"] |
{"mutation":true,"sensitive":false} |
{"concurrency":"exclusive","confirmation":null} |
legacy updater supports implicit/latest version and human output; use core.upgrade for structured automation |