Quickstart

You need TypeScript repositories hosted on GitHub.

1. Install the GitHub App

Sign in at app.carrick.tools and press Install to add the Carrick GitHub App to your repositories, which needs a workspace owner or admin.

2. Build the index

Carrick builds the index without running anything on your machine. Your repository access setting on GitHub decides what Carrick indexes:

• Only select repositories: Carrick indexes every selected repository.
• All repositories: Carrick indexes nothing until you choose repositories on the checklist in the dashboard.

Carrick emails the workspace’s owners when the index starts building and when it is ready.

3. Connect your agent

Add the Carrick MCP server to Claude Code:

claude mcp add --scope user --transport http carrick https://api.carrick.tools/mcp

Or add it to Codex:

codex mcp add carrick --url https://api.carrick.tools/mcp
codex mcp login carrick

Your agent may ask you to approve its access in the browser on its first Carrick call. For Cursor, Windsurf, VS Code, or another agent, see Connecting your agent.

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.

Scan from your own machine

You can also build the index with the CLI, which needs Node 24 or newer.

1. Install the CLI and initialise

Run these two commands in a repository, or in a parent directory that holds several:

npm install -g carrick
carrick init

carrick init opens your browser to sign you in to Carrick. In a directory of several repositories, it 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.

carrick login is optional. Run it first if you want to sign in before setting anything up.

2. 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. On macOS the scan keeps your machine from idle-sleeping until it finishes, for at most three hours.

3. 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.

Next steps

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