Skip to main content

Human-Centered Codebase Context Manager for LLMs

Project description

Codigest

Codigest is a standalone CLI tool designed to extract, structure, and track the context of your codebase for Large Language Models (LLMs).

Unlike simple copy-paste tools, Codigest employs a Context Anchor system (Shadow Git) to track changes locally without polluting your main version control history. It also features Semantic Analysis to detect structural changes in your code.

Core Philosophy

  • Read-Only & Safe: Codigest never modifies your source code. It only reads, analyzes, and formats context.
  • Context-Aware: Instead of dumping raw text, it structures code into XML snapshots designed for LLM comprehension.
  • Session-Based Tracking: It maintains an internal anchor to track "work-in-progress" changes independently of your Git commits.
  • Environment Isolated: Runs in its own isolated Python 3.14 environment via uv, ensuring it never conflicts with your project's dependencies.

Installation

Codigest runs as a global tool. You don't need to add it to your project's requirements.txt. We strongly recommend using uv for the best experience.

Step 1: Install uv

If you don't have uv installed, use Winget (Windows) or curl (macOS/Linux).

# Windows (via Winget)
winget install --id astral-sh.uv

# macOS/Linux
curl -LsSf https://astral.sh/uv/install.sh | sh

Step 2: Install codigest

Install Codigest globally. uv will automatically manage the required Python 3.14 environment for you.

uv tool install codigest

Step 3: Update Path (Important!)

To run codigest from any terminal, ensure your tools directory is in your PATH.

uv tool update-shell

> Note: Restart your terminal (or VS Code) after this step to apply changes.


Workflow & Commands

Once installed, you can use codigest command anywhere.

1. Initialization

Sets up the .codigest directory and captures the initial baseline anchor.

codigest init

2. Full Context Snapshot (scan)

Scans the entire codebase and generates a structured XML snapshot.

  • Output: .codigest/snapshot.xml
  • Use Case: Providing the LLM with the full project context at the start of a session.
  • Side Effect: Updates the internal Context Anchor to the current state.
codigest scan --message "Initial project context"

3. Incremental Changes (diff)

Tracks text-based changes between the last scan and the current working tree.

  • Output: .codigest/changes.diff
  • Use Case: "I modified 3 files. Here is exactly what changed since the last snapshot."
  • Note: This is based on the internal Shadow Git, not your project's Git history.
codigest diff

4. Semantic Analysis (semdiff)

Analyzes structural changes (AST-based) rather than line-by-line text differences.

  • Output: .codigest/semdiff.xml
  • Use Case: "I refactored the API. Show me which functions were added, removed, or had their signatures changed."
  • Benefit: Significantly reduces token usage compared to raw diffs by ignoring formatting/comment changes.
codigest semdiff

5. Architecture Digest (digest)

Generates a high-level outline of the project structure (Classes, Functions, Methods only).

  • Output: .codigest/digest.xml
  • Use Case: "Don't read the implementation details. Just understand the class hierarchy and available methods."
codigest digest

Configuration

You can customize behavior in .codigest/config.toml.

[filter]
# Target extensions
extensions = [".py", ".ts", ".rs", ".md", ".json"]

# Exclude patterns (Gitignore syntax)
exclude_patterns = [
    "*.lock",
    "tests/data/",
    "legacy_code/"
]

[output]
format = "xml"

Architecture Details

Context Anchor (Shadow Git) Codigest maintains a hidden, lightweight Git repository inside .codigest/anchor.

  • When you run scan, the current state is committed to this anchor.
  • When you run diff, the tool compares your working directory against this anchor.
  • When you run semdiff, the tool parses the AST of the anchor version and the current version to detect logical drifts.

Safety Mechanisms

  • structure-aware dedent: Ensures XML tags are perfectly aligned regardless of code indentation.
  • Automatic Exclusion: Self-referential files (.codigest/) are automatically ignored to prevent recursion loops.

License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codigest-0.3.2.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

codigest-0.3.2-py3-none-any.whl (27.1 kB view details)

Uploaded Python 3

File details

Details for the file codigest-0.3.2.tar.gz.

File metadata

  • Download URL: codigest-0.3.2.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codigest-0.3.2.tar.gz
Algorithm Hash digest
SHA256 903723679af162c6c5579ee053a067c82fe77d15730d19960c6d086e301a5353
MD5 e171bbb2dd923e551e4954c15446fc77
BLAKE2b-256 620eef16044c618bb559efda29d12339aacdc14714b54b9ca4332daf446f0b36

See more details on using hashes here.

Provenance

The following attestation bundles were made for codigest-0.3.2.tar.gz:

Publisher: publish.yml on SJB7777/codigest

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file codigest-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: codigest-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 27.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for codigest-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f89b370c1a41c941c3dd0a56fda0ad7f9e0468c064d2370f9f017bad05b23c94
MD5 c667e4630e817f2012937edfde25fdeb
BLAKE2b-256 e9e655cb55bfd05ce34053622e2ef3b1b8884fac3215dc2ede224b78870cbdc1

See more details on using hashes here.

Provenance

The following attestation bundles were made for codigest-0.3.2-py3-none-any.whl:

Publisher: publish.yml on SJB7777/codigest

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page