CodeCompass logo

CodeCompass

by alvinveroy

CodeCompass is an AI coding assistant for Vibe Coding, leveraging the Model Context Protocol (MCP) to connect Git repositories to AI assistants. It can run locally with Ollama for privacy or be configured with OpenAI for cloud power, integrating with VSCode, Cursor, and Claude for seamless development.

View on GitHub

Last updated: N/A

What is CodeCompass?

CodeCompass is an AI-powered coding companion that transforms Git repositories into an AI-driven knowledge base, empowering Vibe Coding. As an MCP server, it connects AI assistants to your codebase, delivering context-aware coding assistance.

How to use CodeCompass?

Install CodeCompass using npm, npx, or Docker. Configure it with either local models (Ollama) or cloud models (OpenAI, DeepSeek) by setting environment variables. Interact with CodeCompass via MCP using tools optimized for Vibe Coding, such as searching code, getting repository context, and generating suggestions. Integrate it with IDEs like VSCode, Cursor, Zed, and Claude for a seamless workflow.

Key features of CodeCompass

  • Local Privacy with Ollama

  • Cloud Flexibility (OpenAI, DeepSeek)

  • Agentic RAG

  • Vibe Coding Ready

  • Developer-Friendly Integrations

  • Metrics & Diagnostics

  • Project Management (TaskMaster AI)

  • Knowledge Graph (MCP Memory)

  • Library Documentation (Context7)

Use cases of CodeCompass

  • Debugging complex code

  • Implementing new features with AI-generated code

  • Exploring and understanding large codebases

  • Onboarding new developers with AI-driven insights

FAQ from CodeCompass

What is Vibe Coding?

Vibe Coding lets developers use natural language prompts to instruct AI to generate code.

What is the Model Context Protocol (MCP)?

MCP is an open standard that connects AI assistants to data sources, such as Git repositories, for relevant responses.

How do I choose between Ollama and OpenAI?

Ollama provides local privacy, while OpenAI offers enhanced performance via cloud models. Choose based on your project's security and performance requirements.

Which IDEs are supported?

CodeCompass integrates with VSCode, Cursor, Zed, Claude Desktop, and Claude Code.

How can I contribute to CodeCompass?

See the CONTRIBUTING.md file in the CodeCompass GitHub repository for guidelines.