Documentation

Everything you need to know to get started with ccr.

Installation

Install ccr globally via npm. Requires Node 20 or higher.

npm install -g @ryanisavibecoder/ccr

Once installed, authenticate with your ccr account:

ccr login

This opens your browser and walks you through sign-in. No API key required.

Tip: If you're behind a corporate proxy, set HTTP_PROXY and HTTPS_PROXY environment variables before running ccr login.

Basic usage

Run ccr from the root of any project. The simplest form takes a single instruction:

ccr "add a README explaining this codebase"

ccr reads your project, proposes changes, and asks for approval before writing anything to disk.

Multi-step tasks

You can give ccr complex instructions and it will break them down:

ccr "refactor the auth module to use JWT, update the tests, and add a migration script"

Interactive mode

Run ccr without arguments to start an interactive session:

ccr

Type your instructions at the prompt. Use exit or Ctrl+C to quit.

Commands

`ccr <instruction>`

Execute a single instruction and exit.

`ccr login`

Authenticate with your ccr account. Opens a browser window.

`ccr logout`

Clear stored credentials.

`ccr status`

Check authentication status and current quota.

`ccr version`

Print the installed version.

Configuration

ccr reads configuration from .ccrrc in your project root or home directory. Example:

{
  "ignore": [
    "node_modules/**",
    "dist/**",
    "*.log"
  ],
  "model": "auto"
}

Options

ignore — Array of glob patterns. Files matching these are never read or modified.
model — Model preference. Default is "auto" (ccr picks based on task). Advanced users can specify a provider.

FAQ

How does ccr stay free?

ccr routes requests across several LLM providers (Groq, Together AI, Cerebras, OpenRouter) and aggregates their free tiers. We pay nothing to run it; you pay nothing to use it. If that ever changes, we'll tell you here.

What files does ccr read?

ccr indexes text files (source code, config, markdown, etc.) and ignores binaries, images, and common build artifacts. You can customize this with the ignore config.

Can I use my own API key?

Not yet. The free routing is baked into ccr's backend. If you need enterprise features or guaranteed capacity, reach out.

Is my code private?

Yes. Code you send to ccr is processed by our LLM providers under their respective privacy policies. We don't train on your data and we don't share it. See our Privacy Policy for details.