codemap 0.3.0rc3

CLI tool that generates optimized markdown docs and streamline Git workflows

CodeMap

[!Caution] CodeMap is currently in active development. Use with caution and expect breaking changes.

Overview

CodeMap is an AI-powered developer toolkit designed to enhance your coding workflow. It offers features for code analysis, documentation generation, and Git process streamlining, all accessible through an interactive CLI with multi-LLM support.

[!Important] For detailed information on all features and commands, please visit our documentation site: codemap.run

Features

• 🎯 Token-optimized documentation generation
• 📝 Rich markdown output with code structure
• 🌳 Repository structure visualization
• 🔄 Smart Git commit assistance with AI-generated messages
• 🔃 AI-powered PR creation and management
• 💬 Ask questions about your codebase using RAG
• 🔍 Index and search your repository for semantic understanding

Installation

[!Important] CodeMap currently only supports Unix-based platforms (macOS, Linux). Windows users should use WSL.

[!Tip] After installation, use codemap or the alias cm.

[!Note] Ensure uv is installed: curl -LsSf https://astral.sh/uv/install.sh | sh To learn more aboyt uv Click here

Global Installation

# Stable version:
uv tool install codemap

# Development Version:
uv tool install codemap --prerelease allow

Updating

uv tool upgrade codemap

Uninstalling

uv tool uninstall codemap

For more detailed installation options and troubleshooting, see the Installation Guide on our documentation site.

Configuration

CodeMap can be configured using a .codemap.yml file in your project root.

For a full list of configuration options and examples, refer to the Configuration Guide on our documentation site.

Development Setup

Interested in contributing? Please read our Code of Conduct and Contributing Guidelines.

1. Clone: git clone https://github.com/SarthakMishra/codemap.git && cd codemap
2. Prerequisites: Install Task, uv, and Python 3.12+.
3. Setup Env: uv venv && source .venv/bin/activate (or appropriate activation command for your shell)
4. Install Deps: uv sync --dev
5. Verify: task -l lists available tasks. task ci runs checks and tests.

Detailed contribution instructions are in the Contributing Guide.

Acknowledgments

CodeMap relies on these excellent open-source libraries and models:

• LiteLLM
• NumPy
• Pygments
• Python-dotenv
• PyYAML
• Questionary
• Requests
• Rich
• Typer
• Sentence-Transformers
• And many development tools like ruff, pytest, isort, pyright.

Models

• Code Embeddings: Leverages models like Qodo/Qodo-Embed-1-1.5B.
• LLM Support: Compatible with OpenAI, Anthropic, Groq, Mistral, Cohere, Together AI, OpenRouter via LiteLLM.

Special Thanks

• Cursor
• OpenHands
• GitHub Actions
• Img Shields
• Codecov

License

This project is licensed under the MIT License - see the LICENSE file for details.