Installation β
Prerequisites β
- Node.js >= 20
- git (any recent version)
- A supported language: TypeScript / JavaScript, Go, or C#
1. Initialize β
From the root of the repo you want to index:
bash
npx @ctxo/initThis detects your languages, installs the right @ctxo/lang-* plugins, adds git hooks, and creates a starter .ctxo/config.yaml.
2. Verify β
bash
npx ctxo doctorAll green? You are done.
If anything is red or yellow:
bash
npx ctxo doctor --fixThis runs a dependency-ordered remediation pass (missing plugins, stale cache, broken hooks). Add --dry-run first if you want to preview.
Add a language later β
@ctxo/init auto-detects what your repo uses. To add more languages after the fact, install the plugin package directly:
bash
pnpm add -D @ctxo/lang-typescript
# or: @ctxo/lang-go, @ctxo/lang-csharpbash
npm install -D @ctxo/lang-typescriptbash
yarn add -D @ctxo/lang-typescriptAvailable plugins on npm: @ctxo/lang-typescript, @ctxo/lang-go, @ctxo/lang-csharp.
After install, re-index so the plugin takes effect:
bash
npx ctxo indexNext steps β
- Quick Start - index your repo and make the first MCP call
- MCP Client Setup - wire Ctxo into your editor