Skip to content
axxbetadocs
nextv0.2.26
GitHub
These are the docs of main, not released yet. See the docs of v0.2.26, the latest release.

axx completion

View .mdOpen in Claude

Generate the autocompletion script for Axx for the specified shell. See each sub-command’s help for details on how to use the generated script.

Usage:
axx completion [command]
Available Commands:
bash Generate the autocompletion script for bash
fish Generate the autocompletion script for fish
powershell Generate the autocompletion script for powershell
zsh Generate the autocompletion script for zsh
Flags:
-h, --help help for completion
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)
Use "axx completion [command] --help" for more information about a command.

Generate the autocompletion script for the bash shell.

This script depends on the ‘bash-completion’ package. If it is not installed already, you can install it via your OS’s package manager.

To load completions in your current shell session:

source <(axx completion bash)

To load completions for every new session, execute once:

axx completion bash > /etc/bash_completion.d/axx
axx completion bash > $(brew --prefix)/etc/bash_completion.d/axx

You will need to start a new shell for this setup to take effect.

Usage:
axx completion bash
Flags:
-h, --help help for bash
--no-descriptions disable completion descriptions
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

axx completion fish | source

To load completions for every new session, execute once:

axx completion fish > ~/.config/fish/completions/axx.fish

You will need to start a new shell for this setup to take effect.

Usage:
axx completion fish [flags]
Flags:
-h, --help help for fish
--no-descriptions disable completion descriptions
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)

Generate the autocompletion script for powershell.

To load completions in your current shell session:

axx completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command to your powershell profile.

Usage:
axx completion powershell [flags]
Flags:
-h, --help help for powershell
--no-descriptions disable completion descriptions
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo "autoload -U compinit; compinit" >> ~/.zshrc

To load completions in your current shell session:

source <(axx completion zsh)

To load completions for every new session, execute once:

axx completion zsh > "${fpath[1]}/_axx"
axx completion zsh > $(brew --prefix)/share/zsh/site-functions/_axx

You will need to start a new shell for this setup to take effect.

Usage:
axx completion zsh [flags]
Flags:
-h, --help help for zsh
--no-descriptions disable completion descriptions
Global Flags:
--compact print only what matters (auto-enabled for coding agents)
-c, --config string path to axx.yaml (default: search upward from the working directory)
--json emit machine-readable JSON (stable envelope)
--no-color disable colored output
-v, --verbose count increase log verbosity (-v, -vv)