Skip to main content
Flags and arguments below are the contract as the binary states it. The global flags (--json, --timeout, …) apply here too and are documented on Global flags. Error codes are a workspace-global contract, not a per-command one — the taxonomy, and how to read a code that is not in it, is on The error envelope.

octolens autocomplete

Install shell completions (zsh, bash, fish, powershell) Arguments Flags Examples
Returns With --json, stdout carries one JSON document with these fields. autocomplete fish (and autocomplete when fish is detected) never emits this document: it delegates to the raw completion script — see autocomplete fish. Without --json: A terminal prints the shell-specific setup instructions. Example output:
Exit codes0 OK · 1 UNEXPECTED · 2 USAGE. The full map is on Exit codes.

octolens autocomplete fish

Print fish shell completions (zsh, bash, powershell: autocomplete <shell>) Examples
Returns stdout is the fish completion SCRIPT itself, in every mode (--json included) — the documented install recipe octolens autocomplete fish > ~/.config/fish/completions/octolens.fish must write a valid script file, so the output is never wrapped in JSON. Exit codes0 OK · 1 UNEXPECTED · 2 USAGE. The full map is on Exit codes.

octolens help

Show help for the CLI, a command group, or a single command Arguments Examples
Returns renders the same prose help pages --help does (for the root, a group, or a single command); there is no machine-readable form, and --json is REFUSED with the JSON_NOT_SUPPORTED error envelope (exit 2) rather than putting prose on a stdout the agent contract promises is JSON. For commands-as-data, read the shipped COMMANDS.md. Exit codes0 OK · 1 UNEXPECTED · 2 USAGE. The full map is on Exit codes.

octolens version

Show the Octolens CLI version, edition, and build metadata Examples
Returns With --json, stdout carries one JSON document with these fields. Without --json: A terminal prints one octolens/<version> (…) line. Example output:
Exit codes0 OK · 1 UNEXPECTED · 2 USAGE. The full map is on Exit codes.