Skip to main content

openclaw completion

生成 shell 补全脚本,将它们缓存到 OpenClaw 状态目录下,并可选地将其安装到你的 shell 配置文件中。

用法

选项

  • -s, --shell <shell>: shell 目标(zshbashpowershellfish;默认:zsh
  • -i, --install: 通过向你的 shell 配置文件添加一行用于缓存脚本的 source 语句来安装补全
  • --write-state: 将补全脚本写入 $OPENCLAW_STATE_DIR/completions(默认 ~/.openclaw/completions),而不输出到 stdout;配合 --shell 时只写入该 shell,否则写入全部四种
  • -y, --yes: 跳过安装确认提示(非交互式)

安装流程

--install 会将你的配置文件指向缓存脚本,因此缓存必须先存在:如果缓存缺失,命令会失败,并提示你运行 openclaw completion --write-state。将 --write-state --install 组合使用,可以一步完成这两件事。若不指定 --shell--install 会从 $SHELL 检测当前 shell(若检测失败则回退到 zsh)。 安装会在你的 shell 配置文件中写入一个小的 # OpenClaw Completion 块,并将任何较旧、较慢的 source <(openclaw completion ...) 行替换为缓存的 source 行: 配置文件的更改会暂存于目标文件旁边,并且仅在完整、持久化写入完成后以原子方式替换目标文件。安装失败时,现有配置文件将保持不变。

注意事项

  • 如果没有 --install--write-state,该命令会将脚本打印到 stdout。
  • 补全生成会预先加载完整的命令树,包括插件 CLI 命令,因此会包含嵌套子命令。
  • openclaw update 会在成功更新后自动刷新补全缓存;openclaw doctor 可以修复缺失或过期的补全配置。

相关