cindex

Overview

cindex is a lightweight script that helps you index a codebase as context for LLMs.

Setup

This project uses poetry to manage dependencies. To install the project, run the following commands from the project root:

python -m venv .venv
source .venv/bin/activate
poetry install

Usage

This project can be installed in editable mode using the following command:

pip install -e .

This creates a CLI command cindex that can be used to index a codebase.

cindex <optional_target_directory> [optional_config_path]

The config_path is optional and defaults to src/cindex/configs/default-settings.yml.

This command can be added to your shell's PATH to make it available globally.

export PATH="$PATH:/path/to/code-context/.venv/bin"