Skip to main content

Zero-LLM project scanner for AI agents. Produces a compact project map so AI uses 50-100x fewer tokens to understand your codebase.

Project description

codemap-zero

Zero-LLM project scanner for AI agents. Scan any codebase and get a compact project map so AI uses 50-100x fewer tokens to understand your code.

PyPI Python License: MIT GitHub

What it does

Your Project (50,000+ lines)  →  codemap scan .  →  codemap-zero/PROJECT_MAP.md (~3K tokens)
                                                   →  codemap-zero/codemap.json (full graph)
                                                   →  codemap-zero/codemap.html (interactive viz)
  • AST-level extraction — parses 20+ languages via tree-sitter
  • Dependency graph — imports, calls, class hierarchies as a directed graph
  • Community detection — auto-discovers logical modules (Louvain/Leiden)
  • Architecture analysis — god nodes, circular deps, dead code, layers
  • Zero LLM tokens — everything is deterministic static analysis

Install

pip install codemap-zero

With extras:

pip install codemap-zero[web]   # web dashboard (Flask)
pip install codemap-zero[ai]    # AI assistant (vedaslab.in API)
pip install codemap-zero[all]   # everything

Quick Start

Scan a project

codemap scan .

Generates a codemap-zero/ folder containing PROJECT_MAP.md, codemap.json, and codemap.html.

Interactive menu

codemap menu .

Choose actions by number — scan, launch dashboard, AI assistant, stats.

Web dashboard

codemap serve .

Opens a professional web dashboard at http://localhost:8787 with interactive graph visualization, module explorer, and complexity analysis.

AI assistant

export VEDASLAB_API_KEY=your-key
codemap ai .

Chat with AI about your project using multiple providers (Vedaslab.in, OpenAI, Google Gemini, Anthropic Claude). The AI gets full project context from the scan.

CLI Reference

codemap scan [TARGET] [OPTIONS]    Scan project and generate maps
  -o, --output DIR                 Output directory (default: codemap-zero/)
  --no-html                        Skip HTML generation
  --no-json                        Skip JSON export

codemap serve [TARGET] [OPTIONS]   Launch web dashboard
  -p, --port PORT                  Port (default: 8787)
  --host HOST                      Host (default: 127.0.0.1)

codemap ai [TARGET] [OPTIONS]      Interactive AI assistant
  --api-key KEY                    API key (supports vedaslab, openai, gemini, claude)
  --model MODEL                    Model name (e.g. gpt-4o, gemini-2.5-pro)

codemap menu [TARGET]              Interactive menu mode

Supported Languages

Python, JavaScript, TypeScript, TSX, Go, Rust, Java, C, C++, C#, Ruby, Kotlin, Scala, PHP, Swift, Lua, Zig, PowerShell, Elixir, Julia — plus Markdown, JSON, YAML, TOML configs.

How It Works

  1. Detect — finds project type, frameworks, entry points, file structure
  2. Extract — parses every source file into AST nodes (files, classes, functions, imports)
  3. Build — constructs a directed graph with import/call/containment edges
  4. Cluster — detects communities using Louvain algorithm, auto-labels them
  5. Analyze — finds god nodes, entry points, circular deps, dead code, architecture patterns
  6. Report — generates a token-optimized Markdown summary
  7. Export — outputs JSON graph data and interactive HTML visualization

🤖 Agent Prompt — Copy & Paste to Any AI Agent

Give any AI coding agent (GitHub Copilot, Cursor, Claude, ChatGPT, Windsurf, Cline, etc.) instant full-project awareness. Just copy the prompt below and paste it at the start of your chat session.

Step 1 — Install codemap-zero

Windows (PowerShell):

pip install codemap-zero

Mac / Linux (Terminal):

pip install codemap-zero

Step 2 — Scan your project

Windows:

cd C:\path\to\your\project
codemap scan .

Mac / Linux:

cd /path/to/your/project
codemap scan .

This creates a codemap-zero/ folder with three files:

File What it contains
codemap-zero/PROJECT_MAP.md Compact codebase summary (~3K tokens instead of 50K+)
codemap-zero/codemap.json Full dependency graph as structured data
codemap-zero/codemap.html Interactive visualization (open in browser)

Step 3 — Copy this prompt and paste it to your AI agent

Click the copy button (top-right of the code block) and paste it into any AI agent chat.

You have access to a project that has been scanned with codemap-zero.
Before doing anything else, read the file codemap-zero/PROJECT_MAP.md in the project root.
This file is your primary codebase context.

codemap-zero/PROJECT_MAP.md contains:
• Complete project structure with every file, class, function, and their relationships
• Import and call dependency graph between all modules
• Auto-detected logical clusters/modules (e.g. "auth", "database", "api", "ui")
• Architecture analysis: entry points, god nodes, circular dependencies, dead code
• Complexity and coupling metrics per file
• Framework and language detection

SMART TOKEN MANAGEMENT:
• Do NOT read every file to understand the project. codemap-zero/PROJECT_MAP.md already has
  a compressed summary of the entire codebase in ~3K tokens instead of 50K+.
• When you need to edit a file, check codemap-zero/PROJECT_MAP.md first to see what depends
  on that file and what it depends on. This avoids breaking changes.
• When adding features, check which cluster/module it belongs to and follow
  existing patterns.
• When answering questions about the codebase, refer to codemap-zero/PROJECT_MAP.md first.
  Only read individual files when you need exact implementation details.

MEMORY MANAGEMENT:
• Treat codemap-zero/PROJECT_MAP.md as your persistent project memory. It captures the full
  architecture in a compact format that fits in your context window.
• If you have a memory/notes system, store the key architectural insights from
  codemap-zero/PROJECT_MAP.md there: main clusters, entry points, critical dependencies,
  and known issues (god nodes, circular deps).
• When the conversation gets long, you don't need to re-read source files.
  codemap-zero/PROJECT_MAP.md has the structural truth.
• After making significant changes (new files, moved modules, renamed things),
  ask the user to re-run "codemap scan ." and re-read the updated codemap-zero/PROJECT_MAP.md.

RULES:
1. Always read codemap-zero/PROJECT_MAP.md FIRST before starting any task.
2. Use the dependency graph to understand impact before editing any file.
3. Never read files one-by-one to "explore" — the map already tells you the structure.
4. If codemap-zero/PROJECT_MAP.md shows circular dependencies or god nodes, flag them to the user.
5. When suggesting refactors, reference the cluster/module structure from the map.
6. If codemap-zero/codemap.json exists, you can parse it for programmatic access to the full graph data.

This approach saves 50-100x tokens compared to reading every file individually.

Why this works

Without codemap-zero With codemap-zero
AI reads files one-by-one AI reads one 3K-token map
Burns 50K–100K+ tokens exploring Full context in seconds
Misses dependencies, breaks things Sees the full dependency graph
Forgets project structure mid-chat Compact map fits in context window
No architecture awareness Knows clusters, god nodes, dead code

Development

git clone https://github.com/Jerry4539/codemap-zero.git
cd codemap-zero
pip install -e ".[dev]"
codemap scan .

Contributing

Contributions are welcome! Please open an issue or pull request on GitHub.

Note: The PyPI package name is codemap-zero (pip install codemap-zero), but the CLI command is codemap.

License

MIT — see LICENSE for details.


Developed by Jerry4539

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

codemap_zero-0.1.7.tar.gz (78.4 kB view details)

Uploaded Source

Built Distribution

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

codemap_zero-0.1.7-py3-none-any.whl (79.8 kB view details)

Uploaded Python 3

File details

Details for the file codemap_zero-0.1.7.tar.gz.

File metadata

  • Download URL: codemap_zero-0.1.7.tar.gz
  • Upload date:
  • Size: 78.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for codemap_zero-0.1.7.tar.gz
Algorithm Hash digest
SHA256 894f2a24499fd8dfc37aa052c37461ea5607290e5ecf48d7d817aec7b32b0c53
MD5 b760f5fe48e9ec27bd02182fc6b1aa9f
BLAKE2b-256 17ad731538f246730c38f65b3a45fe7e18afe6b694232b01f7ea5aa83c3d93ed

See more details on using hashes here.

File details

Details for the file codemap_zero-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: codemap_zero-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 79.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for codemap_zero-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 a270eda67dad0192eb99e50b9e429b27bd7d5e9e5a8585d0d3033f7068497258
MD5 4cb1ae087c6d8265e7ad0217b753b75e
BLAKE2b-256 d4f957af882031de485ba93157dd060995f4891c7bce74f2534b1d0deeeb99f9

See more details on using hashes here.

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