✨ Bevel Neo4j Visualization ✨

Dive deep into your codebase like never before! The Bevel Neo4j Visualization extension transforms your Bevel-generated knowledge graphs (and other Neo4j data) into stunning, interactive visualizations, directly within VS Code. Understand complex relationships, query your code's structure with natural language, and supercharge your development workflow.

🚀 Overview

The Bevel Neo4j Visualization extension is your dedicated window into the intricate world of your software projects, visualized as a Neo4j graph. It works seamlessly with the main Bevel Software VS Code Extension (required for Bevel-specific features) to help you:

• Visualize Code Structure: See classes, functions, dependencies, and more as an interactive graph.
• Query with AI: Ask questions about your codebase in plain English and get Cypher queries generated automatically.
• Explore Bevel Knowledge Graphs: Export the rich knowledge graphs created by the Bevel Software extension into your own Neo4j instance for detailed exploration.
• Connect to Any Neo4j DB: Visualize and query data from any of your Neo4j databases.

Stop guessing, start seeing!

🌟 Core Features

• Interactive Neo4j Graph Visualization: Powered by Neo4j's NVL (Neo4j Visualization Library), providing a smooth and intuitive experience.
  • Pan, zoom, drag nodes, and click to inspect properties.
• Dual Connection Modes:
  • 🌍 Bevel API Mode:
    • Export Bevel Graphs: Seamlessly export knowledge graphs (generated by the main Bevel Software extension) into your Neo4j instance. This is key to visualizing Bevel's understanding of your code.
    • AI-Powered Cypher Generation: Leverage Bevel's AI to translate natural language questions about your analyzed codebase into executable Cypher queries.
  • 🔌 Direct Neo4j Mode:
    • Connect directly to any Neo4j database (local, server, AuraDB).
    • Run custom Cypher queries and visualize the results from your existing data.
    • AI-Powered Cypher Generation can also be used, potentially leveraging your database's schema.
• Integrated Query Editor: Write, edit, and execute Cypher queries directly in the visualization panel.
• AI Query Assistant:
  • Don't know Cypher? No problem! Ask questions like "Show me all functions that call other functions" or "Find classes with more than 5 methods."
  • See the generated Cypher, edit it, or run it instantly.
• Node Properties Panel: Click on any node to see its detailed properties.
• Configurable Connection: Easily set up and save your Neo4j connection details.

🛠️ Prerequisites

1. VS Code: Version ^1.84.0 or higher.
2. Bevel Software VS Code Extension: This is essential! You need the main Bevel Software extension installed and active. It's responsible for analyzing your code and creating the knowledge graph that this visualization tool can then export and display. It also powers the codebase-aware AI features.
   • Find it on the VS Code Marketplace (or search for bevel-software.bevel).
3. A Neo4j Instance: You'll need a running Neo4j database (version 4.x or 5.x recommended, AuraDB, local, or server) to connect to and store/visualize graph data.

💡 Getting Started & How to Use

Follow these steps to unlock the power of graph visualization for your code:

1. Install Extensions:

   • Ensure the main Bevel Software extension is installed from the VS Code Marketplace.
   • Install this Bevel Neo4j Visualization extension (bevel-software.bevel-neo4j-viz).

2. Analyze Your Project (with the main Bevel Software extension):

   • Open your codebase in VS Code.
   • Run the command Bevel: Re-/Analyze Project from the Command Palette (Ctrl+Shift+P or Cmd+Shift+P). This allows the main Bevel extension to analyze your code and build its internal knowledge graph. This step is crucial for the "Bevel API Mode" to have data to export.

3. Open the Neo4j Visualization Tab:

   • Run the command Bevel: Open Neo4j Visualization from the Command Palette. This will open a new tab with the visualization interface.

4. Configure & Connect to Your Neo4j Instance:

   • In the "Neo4j Visualization" tab, you'll find a control panel (usually on the left).
   • Enter your Neo4j Instance Details:
     • URI (e.g., bolt://localhost:7687 or neo4j+s://your-aura-instance.databases.neo4j.io)
     • Username
     • Password
   • Choose Connection Mode & Act:
     • 🌍 Bevel API Mode (Recommended for Bevel-analyzed codebases):
       1. Select this mode using the toggle (it might be the default).
       2. Click "Connect".
       3. IMPORTANT: Once connected, click "Export Project". This step takes the knowledge graph that the main Bevel Software extension created from your code (in step 2) and loads it into your connected Neo4j instance.
       4. After the export is complete, you can start querying and visualizing this rich, codebase-specific graph!
     • 🔌 Direct Neo4j Mode:
       1. Select this mode using the toggle.
       2. Click "Connect". This connects directly to your specified Neo4j database, allowing you to work with any data already present in it.
   • The connection status will be displayed in the panel.

5. Query & Visualize Your Graph:

   • Cypher Query Editor Tab:
     • Write or paste your Cypher queries directly.
     • Click "Execute Query" to see the results visualized.
   • Query Generator Tab (AI-Powered!):
     • Type your question about the codebase in plain English (especially powerful in Bevel API mode after exporting your project).
     • Click "Generate Cypher Query".
     • Review the AI-generated Cypher. You can then:
       • Click "Edit in Query Editor" to refine it.
       • Click "Run Query Now" to execute it immediately and see the visualization.
   • Interact with the graph: zoom, pan, and click on nodes/relationships to see their details in the properties panel (usually on the right).

⚙️ Configuration

The extension uses VS Code's settings to store your Neo4j connection URI and username for convenience. The password is not stored in settings.json for security reasons but is handled per session or prompted if needed.

You can view the stored configuration in your VS Code settings (settings.json) under neo4j.connection:

{
  "neo4j.connection": {
    "uri": "bolt://localhost:7687",
    "username": "neo4j"
    // Password is not stored here
  }
}

It's generally recommended to manage connection details through the UI in the visualization tab. Successful connections will save the URI and username for future sessions.

🤝 Contributing

We love contributions from the community! If you'd like to contribute, please:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes.
4. Submit a pull request with a clear description of your changes. (Please refer to a CONTRIBUTING.md file if one exists in the repository for more detailed guidelines.)

💬 Support & Feedback

Encountering issues, have a suggestion, or just want to share your experience? We'd love to hear from you! Please email juan@bevel.software. We're committed to providing support and improving the extension.

Happy Graphing! 👨‍💻👩‍💻🕸️ Made with ❤️ by the Bevel Software Team.