CodeAura VS Code Extension

Overview

The CodeAura VS Code Extension enhances your development experience by providing an intuitive way to visualize sequence diagrams, access automated documentation, and browse your CodeAura repositories directly within VS Code.

This extension is designed primarily for viewing documentation, while the full CodeAura AI platform offers additional features such as chat-based interactions with documentation, AI-driven code generation, and intelligent project insights.

To explore the full suite of features, visit CodeAura.

Features

• Sequence Diagrams: Click on any file to view its sequence diagrams.
• Project Documentation: Click on a folder to display the related documentation.
• CodeAura Panel: View all your repositories from CodeAura, explore different functionalities for each project, and access related documentation and diagrams—all in one place.
• Seamless Integration: Works alongside the CodeAura AI platform for advanced AI-driven development assistance.

Getting Started

Sign Up & Get Your API Key

To use this extension, you need an API key from the CodeAura platform.

1. Sign up at CodeAura AI.
2. After signing in, retrieve your API key from your User Settings:
   Get API Key.
3. Integrate your repository with the CodeAura platform.

Install the Extension

1. Open VS Code.
2. Navigate to Extensions (Ctrl + Shift + X).
3. Search for "CodeAura" and click Install.

Add Your API Key

1. Open the Command Palette (Ctrl + Shift + P).
2. Search for "Show CodeAura" and select it.
3. In the CodeAura panel, locate the API key input field.
4. Paste your CodeAura API Key and save it.

Set up Your Project

1. Go to CodeAura Project List View
2. Download the VS Code Config for your project or repository.
3. Copy the file in the root folder of your repository.

Once your API key is added, you're ready to use the extension.

How to Use

View Sequence Diagrams

• Right-click on a file in your workspace.
• Select "Show Diagrams"
• All associated diagrams will be displayed.

View Documentation

• Right-click on a folder.
• Select "Show Documentation."
• The documentation will be displayed in a panel.

Explore Projects in the CodeAura Panel

• Open the Command Palette (Ctrl + Shift + P).
• Search for "Show CodeAura"
• Browse your repositories, documentation, and diagrams.

Why Use CodeAura?

CodeAura is a powerful AI assistant for developers, providing tools to:

• Generate real-time, AI-driven documentation
• Interact with your code using chat-based conversations
• Automate code generation and improve productivity

While the VS Code extension focuses on documentation viewing, you can unlock the full AI-powered experience on the CodeAura AI platform.

Support & Feedback

For any issues, suggestions, or feature requests:

• Contact us at info@codeaura.ai