Files
moltbot/docs/cli/completion.md
2026-02-22 20:05:01 +01:00

1.2 KiB

summary, read_when, title
summary read_when title
CLI reference for `openclaw completion` (generate/install shell completion scripts)
You want shell completions for zsh/bash/fish/PowerShell
You need to cache completion scripts under OpenClaw state
completion

openclaw completion

Generate shell completion scripts and optionally install them into your shell profile.

Usage

openclaw completion
openclaw completion --shell zsh
openclaw completion --install
openclaw completion --shell fish --install
openclaw completion --write-state
openclaw completion --shell bash --write-state

Options

  • -s, --shell <shell>: shell target (zsh, bash, powershell, fish; default: zsh)
  • -i, --install: install completion by adding a source line to your shell profile
  • --write-state: write completion script(s) to $OPENCLAW_STATE_DIR/completions without printing to stdout
  • -y, --yes: skip install confirmation prompts

Notes

  • --install writes a small "OpenClaw Completion" block into your shell profile and points it at the cached script.
  • Without --install or --write-state, the command prints the script to stdout.
  • Completion generation eagerly loads command trees so nested subcommands are included.