🌟 About
Vxplain helps developers understand any codebase. This powerful VS Code extension reduces onboarding time from weeks to minutes by automatically generating visual representations of your code architecture and logic flows.
🚀 Key Features
| Preview |
Feature |
AI Required |
Description |
 |
Architecture Diagrams |
Yes |
Generate high-level design diagrams of your codebase architecture automatically. |
 |
Interactive Call Graphs |
No |
Visualize the relationships between functions, classes, and modules with interactive call graphs. |
 |
Directory Tree Visualization |
No |
Instantly see your project's complete file structure in one organized view, making navigation effortless and intuitive. |
 |
Code-to-Diagram Generation |
Yes |
Generate diagrams of code snippets to quickly understand control flow, structure and business logic. |
 |
Multi-level Summaries |
Yes |
Generate summaries of the overview, architecture, and code files. |
 |
Bring Your Own LLMs (Coming Soon) |
NA |
Bring your own LLMs to generate diagrams of your codebase. |
And more coming soon...
- Chat Support: Request Sophisticated visual representations of specific components from your code.
- Visual PR Reviews: Review code changes with clear, interactive visualizations.
- Visual Debugging: Debug code with interactive visualizations.
- Dependency Analysis: Comprehensive visualization of module interdependencies.
🛠️ Use Cases
- Legacy Code Modernization: Quickly understand older codebases before implementing changes.
- Accelerated Onboarding: Help new team members understand complex systems in hours instead of weeks.
- Technical Knowledge Transfer: Streamline explanations during team transitions with visual references.
- Architecture Documentation: Generate visual artifacts that capture system design clearly and comprehensively.
- Code Reviews & Planning: Enhance technical discussions with clear representations of code structure.
💻 Commands
Vxplain: Generate DiagramVxplain: View Call GraphVxplain: Open Extension | Ctrl+Alt+v (Windows/Linux) or Cmd+Alt+v (Mac)Vxplain: Open Settings | Ctrl+Alt+s (Windows/Linux) or Cmd+Alt+s (Mac)Vxplain: Check for Updates
You can access these commands via the command palette (Ctrl+Shift+P or Cmd+Shift+P).
⚙️ Configuration And Settings
You can modify these settings by pressing ⌘ + ⌥ + s or Ctrl + Alt + s.
Enable AI Features: Toggle AI features, so that you can use the extension without AI features. This will disable architecture diagrams, summaries, code-to-diagram generation. Default: trueEnable Analytics: Toggle analytics and crash data collection to help improve Vxplain. Default: trueEnable Auto Start: Toggle if the extension starts automatically when you open VS Code. Default: true
🔒 Privacy Notice
API Providers
OpenAI
- OpenAI has a 30-day retention policy.
- OpenAI doesn't use this data in training.
- We're working with OpenAI to implement a zero-day retention policy.
Vxplain
- We never store your code or outputs on our servers.
- All diagrams and analysis are stored in your local storage only.
💡 No source code, file contents are ever included in the telemetry data.
Change Privacy Settings
Use settings to disable analytics and AI features.
If you have any questions about our Privacy Policy practices, please don't hesitate to reach out to us at raman.tehlan@vxplain.in.
❓ FAQ
Can I disable AI features?
Yes, you can disable AI features. However, this will disable architecture diagrams, summaries, code-to-diagram generation. Only function call graph and directory tree visualization will work. If that's what you need, you can update Vxplain: Enable Ai Features to false in the settings.
If disabled, you won't need any active internet connection to use the extension. Everything happens locally.
What configuration options are available?
Right now, configuration options are limited. We are working on it.
We will bring support to exclude the files and folders from analysis, control depth of analysis, and more.
Can I use my own LLMs?
No, we are working on it. We will bring your own LLMs support soon. Even supporting local LLMs is on our roadmap.
What usage data is collected? Can I disable it?
Yes, you can disable analytics. If you disable analytics, we will not collect any data at all. Which means, even the crash reports will not be collected and you will have to manually send them to us.
We collect usage data which is needed to improve vxplain experience, such as clicks, error logs, performance metrics, session replays and similar metrics. We never collect any source code, file contents, or any other sensitive data.
Will this be open source?
We are still in early stages of development and eventurally, either all or some parts of the code will be open source.
Transform how you understand code with Vxplain
Visit vxplain.in to learn more
