Docs
Build with Carrick
Carrick gives coding agents, and the engineers working with them, one
current index of every TypeScript service in an organisation. It compiles
routes, compiler-resolved types, and semantic function intents from your
repositories on main, delivering real-time answers
across four points: when your agent asks over MCP, right after it edits a file
via local hooks, in your code editor, and on pull requests via GitHub App
comments. Get started with npm install -g carrick and
carrick init in your workspace directory. See
the Quickstart.
Get started
Introduction What Carrick is, the four points where it answers, and where to start. Quickstart Install the CLI, run carrick init where your repositories live, and paste the printed prompt into your coding agent. How Carrick works The problem Carrick solves, the three layers of its index, where it answers, and the parts that build and serve the index. What Carrick covers What Carrick scans, the requirements a repo needs to scan cleanly, the framework and protocol story, and the cases that fall outside MVP scope. Guides
Building the index What the scaffold tool writes, the first scan, configuring a repository by hand, and the GitHub Actions workflow that keeps the index current. In your editor Carrick editor diagnostics, cross-repo go to definition, the code lens, the boundary line and one setting per surface. Connecting your agent How coding agents read Carrick through local hooks, the hosted MCP index and editor diagnostics, with setup for each MCP client. CLI Reference for Carrick login, workspace setup, the scan that builds the index, refreshes, file checks and status output. carrick.json Per-repo config that tells the scanner which services a repo contains and which env vars and domains name internal services versus third-party APIs. PR comments Carrick comments contract-drift findings on your pull requests, posted by the GitHub App, on by default and toggled per project. Task skills
Task skills The four skills carrick init installs, how they arrive in both harnesses, the stamp that decides who owns each file, and the end-of-task nudge that points at one of them. carrick-impact The task skill that lists everything that depends on the code you are about to change, with a file and line for each, and a type verdict for each consumer. carrick-reuse The task skill that compares the functions a task added against the whole function index, and groups the places a project has built the same thing twice. carrick-drift The task skill that puts a producer's type, each consumer call site's expected type and the stored verdict side by side, one operation at a time. carrick-census The task skill for every-place-that-does-X questions: two wordings of one concept, paged to the end, joined into one list with a receipt. For agents
Every page on this site is also served as raw markdown at the
same path with a .md suffix. An
index of all pages in the llms.txt
format lives at /llms.txt. A full
concatenated dump of every page lives at
/llms-full.txt.