Quickstart#
Run kluster.ai code reviews straight from your terminal. Install kluster-cli, authenticate with your API key, and review your first changes. No IDE or CI pipeline required.
Prerequisites#
You need:
- A kluster.ai account: Sign up on the kluster.ai platform if you don't have one.
- An API key: Get your API key from the CLI setup page.
1. Install#
curl -fsSL https://cli.kluster.ai/install.sh | sh
irm https://cli.kluster.ai/install.ps1 | iex
For installer options, supported platforms, and troubleshooting, see Installation.
2. Login#
Authenticate the CLI with your API key:
kluster login
When prompted, paste the API key from platform.kluster.ai/cli.
3. Review your code#
Stage some changes and run your first review:
kluster review staged
That's it. kluster.ai analyzes your code and flags issues with severity levels, explanations, and suggested fixes.
Want a deeper scan? Re-run the same command with --mode deep.
The CLI can do more than review staged changes—you can also review diffs against branches, review individual files, or set up git hooks to automate reviews on every commit or push.
Next steps#
- Installation: Shell completions, update system, and advanced install options.
- Review commands: Review diffs, branches, and individual files.
- Git hooks: Automate reviews on every commit or push.
- Reference: Configuration, exit codes, and full command reference.