Installation#
kluster.ai's CLI is available for macOS, Linux, and Windows. The installer downloads a single binary, adds it to your PATH, and you're ready to go. This page covers installation, updates, shell completions, and uninstalling.
Install kluster-cli#
Run the following command in your terminal:
curl -fsSL https://cli.kluster.ai/install.sh | sh
The installer places the binary at ~/.kluster/cli/bin/kluster and adds it to your PATH.
Installer options:
| Flag | Description |
|---|---|
-b <dir> | Custom install directory (default: ~/.kluster/cli/bin). |
-d | Enable debug logging. |
-q | Quiet mode (errors only). |
-n | Dry run (no changes). |
Run the following command in PowerShell:
irm https://cli.kluster.ai/install.ps1 | iex
The installer places the binary at %USERPROFILE%\.kluster\cli\bin\kluster.exe and adds it to your PATH.
Verify installation#
After installation, verify the CLI is working:
kluster version
If you get command not found: kluster, your PATH likely wasn't updated. See Troubleshooting.
Login#
Authenticate the CLI with your API key:
kluster login
Get your API key from the CLI setup page.
To authenticate non-interactively (useful for CI/CD):
kluster login --api-key kl_your_key_here
To remove stored credentials:
kluster logout
Supported platforms#
| OS | Architectures |
|---|---|
| Linux | amd64, arm64 |
| macOS | amd64 (Intel), arm64 (Apple Silicon) |
| Windows | amd64, arm64 |
Update#
The CLI can update itself to the latest version:
kluster update
To check if an update is available without installing:
kluster update --check
The update process downloads the latest binary, verifies its SHA256 checksum, and replaces the current installation.
Uninstall#
To remove kluster-cli, delete the installation directory:
rm -rf ~/.kluster/cli
Remove-Item -Recurse -Force "$env:USERPROFILE\.kluster\cli"
Shell completions (optional)#
Enable tab completion for commands, flags, and git branches.
# Current session only
source <(kluster completion bash)
# Permanent (Linux, requires sudo)
kluster completion bash | sudo tee /etc/bash_completion.d/kluster > /dev/null
# Permanent (macOS with Homebrew)
kluster completion bash > "$(brew --prefix)/etc/bash_completion.d/kluster"
# Enable completions if not already
echo "autoload -U compinit; compinit" >> ~/.zshrc
# Add completion
kluster completion zsh > "${fpath[1]}/_kluster"
# Or source directly
echo 'source <(kluster completion zsh)' >> ~/.zshrc
# Current session only
kluster completion fish | source
# Permanent
kluster completion fish > ~/.config/fish/completions/kluster.fish
# Current session only
kluster completion powershell | Out-String | Invoke-Expression
# Permanent (add to profile)
kluster completion powershell >> $PROFILE
Next steps#
- Quickstart: Run your first review from the terminal.
- Review commands: All review options and output formats.
- Reference: Configuration, exit codes, and full command reference.