Skip to main content

Installation

Prerequisites​

Caret CLI requires Node.js version 20 or higher. We recommend using Node.js 22 for the best experience.

To check your Node.js version:

node --version

Installation​

npm install -g caret

After installation, authenticate with your Caret account:

caret auth

This starts an authentication wizard to sign you in and configure your preferred AI model provider.

Quick Start​

Get started with Caret in seconds:

caret

That's it! Running caret in any directory starts an interactive session where you can chat with the AI agent. Type your task, review the plan, and type /act when ready to execute.

For even faster execution without interaction:

caret "Add unit tests to utils.js"

This runs Caret with a single command, perfect for quick tasks or automation.

💡Tip

New to Caret CLI? Start with interactive mode (caret) to see how it works. Once comfortable, explore the three core flows for advanced usage patterns.