Quickstart

You need Python 3.11 or newer and git on your PATH.

Install

pip install cidx

Or run it without installing, using uv:

uvx cidx --version

Index a repository

Run this from the repository root:

cidx index --repo .

The index is one SQLite file in your user cache. Nothing is written inside the repository.

Ask it something

cidx query Context --repo .

cidx query echo --references --repo .

cidx query src/click/globals.py --outline --repo .

cidx query --repo-map --repo .

Connect your agent

Add cidx to any MCP client that can start a stdio server. Use an absolute path:

{
  "mcpServers": {
    "cidx": {
      "command": "uvx",
      "args": ["cidx", "serve", "--repo", "/absolute/path/to/repo"]
    }
  }
}

The full documentation is being written and will replace this page.