Quickstart

Install the CLI, run carrick init where your repositories live, and paste the printed prompt into your coding agent.

You need Node 24 or newer and TypeScript repositories hosted on GitHub.

1. Install the CLI

Install the Carrick CLI globally with npm:

npm install -g carrick

carrick login opens your browser to authenticate the CLI with your Carrick workspace:

carrick login

3. Go to your repositories

Change into a repository, or into a parent directory that holds several:

cd ~/code

4. Initialise the workspace

Set up Carrick for the repositories in this directory:

carrick init

In a directory of several repositories, carrick init asks which ones to include. It then opens GitHub so you can approve the Carrick GitHub App for them, which needs a workspace owner or admin. It also connects Claude Code to the Carrick MCP server, and offers to connect Cursor, Windsurf, and VS Code when it finds them on your machine. For Codex or another agent, see Connecting your agent.

5. Paste the prompt into your agent

carrick init ends by printing a prompt like this one. Paste it into your coding agent:

Run the carrick scaffold tool for owner/repo, passing its owner/repo as `repo`, and follow what it returns.

Your agent writes carrick.json and the CI workflow, starts the first scan in the background, and opens a pull request once the scan finishes. It may ask you to approve its access in the browser on its first Carrick call.

Carrick emails you when the index is ready. To see progress before then, run carrick status.

6. Merge the pull request

Merge the pull request that your agent opened. From then on, the Carrick GitHub Action updates the index on every push to main.

Try it

Once the index is ready, ask your agent:

Use Carrick to list every service in our project and the number of endpoints each one exposes.

Next steps

Building the index details each file that your agent writes, the CI workflow, and setting up a repository by hand.
In your editor installs the extension for diagnostics and cross-repo go to definition.
Connecting your agent covers Codex and other MCP clients.
CLI lists every command, including carrick remove.