🚀 CodeBoarding – The Google Maps for Your Codebase

CodeBoarding is your interactive, high-level map for any complex codebase. It's the missing layer you need to navigate, understand, orchestrate, and monitor your code, whether you're working solo, with a team, or guiding your favorite AI coding assistant.

Note: CodeBoarding is in active development and we're shipping updates fast! We would love your feedback. Connect with us at codeboarding@gmail.com or submit ideas via our feedback form.

✨ Why CodeBoarding?

Modern codebases are complex, and with AI assistants, we often write less code but need to understand more.

Ever wonder what your favorite AI agent just generated? Do you want to change just one thing in the output, but you're unsure where to start and now face hours of navigating and understanding unfamiliar code?

That's exactly where CodeBoarding helps. It gives you a high-level map to quickly understand the generated code, allowing you to locate what you need and supply precise context to your agent in minutes.

🌟 Key Features

• 🗺️ Instant Codebase Visualization: Get a high-level, easy-to-understand overview of your entire codebase structure without reading a single line of code.
• 🧭 Interactive Exploration: The map is fully interactive. Click on any component to zoom in, inspect its dependencies, and understand its role in the system.
• 🧠 AI-Powered Explanations: Using Google's Gemini, CodeBoarding automatically generates concise, clear descriptions for each of your components.
• 🔗 Seamless Code-to-Map Linking: Instantly jump from a visual node on the map directly to the corresponding source code in your editor.
• 🤖 Supercharge Your AI Coding Assistant: Copy the context of a single component or an entire map to your clipboard. Paste it into your AI chat to give it the context it needs to generate better code, faster.
• 🔄 Real-Time Change Tracking: As you or your coding agent edit files, the corresponding components on the map are highlighted, giving you a live view of what's being modified.

🚀 Getting Started

1. Install the CodeBoarding extension from the Marketplace.
2. Open your project folder in VS Code.
3. Click the CodeBoarding icon in the VS Code side panel to open the view.
4. Press the Sync button in the top-right corner to generate your code map.
5. Explore your interactive map once it appears!

Supported Languages:

🔒 Your Privacy and Security are Important to us

Your code is your business. We designed CodeBoarding with a local-first approach.

• Local-First Analysis: All code parsing and graph construction happens entirely on your local machine. Your code never leaves your computer.
• Secure API Communication: For the generation we send minimal parts of the codebase directly to the Gemini API. We do not proxy your requests, and we never see or store your code.

💖 Support and Contribute

CodeBoarding is powered by our open-source engine. We're building this in the open and welcome your support!

⭐ Give us a star on GitHub: It helps us gain visibility and grow the community! https://github.com/CodeBoarding/CodeBoarding

🐞 Report a bug or suggest a feature: Open an issue on our GitHub repository.

📌 Release Notes

0.2.0 (Current Release)

• 🚀 Feature: Real-time file change tracking! Nodes on the map now update to show which components are being edited.
• ✨ Improvement: Enhanced support for Python projects with better module resolution.
• ⚙️ Backend: Upgraded to use Google's powerful and efficient Gemini 1.5 Flash model for faster and more accurate descriptions.
• ✅ Platform Support: Confirmed support for Windows, macOS, and Linux.

0.1.0

• Initial public release.
• Core visualization engine for python projects.

🎉 Happy exploring! We can't wait to see how you use CodeBoarding.