Skip to content

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/init

This detects your languages, installs the right @ctxo/lang-* plugins, adds git hooks, and creates a starter .ctxo/config.yaml.

2. Verify ​

bash
npx ctxo doctor

All green? You are done.

If anything is red or yellow:

bash
npx ctxo doctor --fix

This 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-csharp
bash
npm install -D @ctxo/lang-typescript
bash
yarn add -D @ctxo/lang-typescript

Available plugins on npm: @ctxo/lang-typescript, @ctxo/lang-go, @ctxo/lang-csharp.

After install, re-index so the plugin takes effect:

bash
npx ctxo index

Next steps ​

Released under the MIT License.