CodeCompass 🌐

Welcome to CodeCompass, your AI-powered coding assistant designed to enhance your development experience. This tool connects Git repositories to advanced AI assistants like Claude, ensuring you have the support you need while maintaining your privacy. With integration options for Ollama and OpenAI, you can choose the setup that works best for you.

Table of Contents

• Features
• Installation
• Usage
• Integrations
• Contributing
• License
• Contact

Features

• AI-Powered Assistance: Leverage the capabilities of AI to assist in coding tasks.
• Privacy-Focused: Use Ollama for local processing or OpenAI for cloud capabilities, depending on your needs.
• Seamless Integration: Works with popular development tools like VSCode and Cursor.
• Code Navigation: Easily search and navigate through your codebase.
• Model Context Protocol (MCP): Efficiently manage context for AI interactions.
• Large Language Models: Utilize cutting-edge models for enhanced coding support.

Installation

To get started with CodeCompass, follow these steps:

1. Clone the repository:

   git clone https://github.com/Pinochollo/CodeCompass.git

2. Navigate to the project directory:

   cd CodeCompass

3. Install the required dependencies:

   npm install

4. Run the application:

   npm start

For the latest releases, visit here. Download the necessary files and execute them to ensure you have the latest features and fixes.

Usage

After installation, you can start using CodeCompass in your development workflow. Here’s how to get started:

1. Connect to Your Git Repository: Open CodeCompass and connect to your existing Git repositories.
2. Choose Your AI Assistant: Select between Ollama for local processing or OpenAI for cloud-based assistance.
3. Start Coding: Use the integrated tools to search your codebase, navigate files, and receive coding suggestions.

Example Commands

• To search for a specific function:

  codecompass search functionName

• To get suggestions on a code snippet:

  codecompass suggest "Your code snippet here"

Integrations

CodeCompass integrates seamlessly with various development tools, enhancing your coding experience:

• VSCode: Use CodeCompass directly within your favorite code editor.
• Cursor: Benefit from intelligent coding assistance while using Cursor.
• Other Tools: Explore additional integrations as we expand our ecosystem.

Contributing

We welcome contributions from the community. If you want to help improve CodeCompass, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or fix:

   git checkout -b feature/YourFeature

3. Make your changes and commit them:

   git commit -m "Add some feature"

4. Push to the branch:

   git push origin feature/YourFeature

5. Open a pull request.

Your contributions help us improve and expand the capabilities of CodeCompass.

License

CodeCompass is licensed under the MIT License. See the LICENSE file for more details.

Contact

For any questions or feedback, please reach out via the issues section on GitHub or contact us directly at [your-email@example.com].

To explore the latest releases, visit here for updates and new features.

---

Thank you for checking out CodeCompass! We look forward to your feedback and contributions. Happy coding!