Atlas AI - VS Code Extension

An AI-powered coding assistant for Visual Studio Code that helps you write better code with explanations, documentation, bug detection, and refactoring suggestions.

Features

🤖 AI-Powered Code Analysis

• Explain Code: Select code and get an instant explanation of what it does
• Generate Documentation: Auto-generate JSDoc comments and documentation
• Find Bugs: Analyze code for potential issues and bugs
• Refactor Code: Get suggestions to improve code quality and readability

💬 Interactive Chat Interface

• AI Chat Panel: Dedicated sidebar for conversational AI assistance
• Ask Questions: Send messages directly to Atlas AI from the command palette
• Chat History: View all previous questions and responses
• Clear Chat: Reset conversation history with one command

⚡ Quick Access

• Right-click context menu for all commands
• Keyboard shortcut: Ctrl+Alt+E to explain selected code
• Chat keyboard shortcut: Ctrl+Alt+C to open chat input
• Command palette access to all features
• Dedicated AI Assistant panel with chat interface

Usage

Code Analysis Methods

Method 1: Context Menu

1. Select code in your editor
2. Right-click to open the context menu
3. Choose from:
   • "Atlas AI: Explain Selected Code"
   • "Atlas AI: Generate Documentation"
   • "Atlas AI: Find Bugs in Selected Code"
   • "Atlas AI: Refactor Selected Code"

Method 2: Keyboard Shortcut

1. Select code in your editor
2. Press Ctrl+Alt+E (or Cmd+Alt+E on Mac) to explain the code

Method 3: Command Palette

1. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
2. Type "Atlas AI:" to see all available commands
3. Select a command to execute

Chat Interface

Method 1: Chat Panel in Sidebar

1. Click the Atlas AI icon in the Activity Bar (left sidebar)
2. The AI Assistant panel opens showing chat history
3. Click "Send Chat Message" to open the input dialog

Method 2: Keyboard Shortcut

1. Press Ctrl+Alt+C (or Cmd+Alt+C on Mac)
2. Type your question in the input box
3. Press Enter to send

Method 3: Command Palette

1. Press Ctrl+Shift+P (or Cmd+Shift+P on Mac)
2. Type "Atlas AI: Send Chat Message"
3. Type your question and press Enter

Clear Chat History

• Use Command Palette: Ctrl+Shift+P → "Atlas AI: Clear Chat History"
• Or click the clear button in the Chat panel title bar

Commands

Configuration

API Key Setup (For Real AI Features)

To enable full AI capabilities with real API responses:

1. Open VS Code Settings (Ctrl+,)
2. Search for "Atlas AI"
3. Configure:
   • API Provider: Choose OpenAI, Anthropic, or other supported services
   • API Key: Enter your API key
   • Model: Select preferred AI model

Supported Providers

• OpenAI (GPT-4, GPT-3.5)
• Anthropic Claude
• Local LLM models

Example Workflows

Documenting Legacy Code

1. Select the function or class
2. Run "Atlas AI: Generate Documentation"
3. Review the generated JSDoc comments
4. Copy and integrate into your code

Code Review and Optimization

1. Select a code block
2. Run "Atlas AI: Find Bugs in Selected Code"
3. Review suggestions
4. Run "Atlas AI: Refactor Selected Code" for improvements

Learning and Understanding

1. Select unfamiliar code
2. Run "Atlas AI: Explain Selected Code"
3. Read the explanation in the output panel

Development

Prerequisites

• Node.js 14+
• npm 6+
• VS Code 1.120.0+

Setup

npm install

Run Extension in Development Mode

1. Press F5 in VS Code to launch the extension host
2. A new VS Code window opens with the extension loaded
3. Test the commands in the new window

Build

npm run compile

Watch Mode (Development)

npm run watch

Project Structure

atlas-ai/
├── src/
│   └── extension.js          # Main extension file
├── .vscode/
│   ├── launch.json           # Debug configuration
│   └── tasks.json            # Build tasks
├── package.json              # Extension manifest
├── README.md                 # This file
└── .vscodeignore            # Files to ignore when packaging

Extension Capabilities

Current Features

• ✅ Code explanation (simulated)
• ✅ Documentation generation (simulated)
• ✅ Bug detection suggestions (simulated)
• ✅ Refactoring recommendations (simulated)
• ✅ Context menu integration
• ✅ Keyboard shortcuts
• ✅ Output panel for results
• ✅ Chat interface with message history
• ✅ Tree view for chat display
• ✅ Clear chat history functionality

Planned Features

• 🔄 Real-time code suggestions
• 🔄 AI-powered code completion
• 🔄 Integration with OpenAI API
• 🔄 Custom model support
• 🔄 Batch code analysis
• 🔄 Code quality metrics
• 🔄 Performance optimization suggestions
• 🔄 Multi-language support for chat
• 🔄 Code snippet sharing from chat

Troubleshooting

Commands not appearing

• Make sure code is selected before right-clicking
• Try accessing commands through the Command Palette (Ctrl+Shift+P)

Extension not loading

• Check the Output panel for error messages
• Ensure Node.js is installed: node --version
• Reinstall dependencies: npm install

API features not working

• Verify API key is configured in settings
• Check internet connection
• Confirm API service is available

License

MIT License - See LICENSE file for details

Support

For issues, suggestions, or contributions:

• Report bugs on GitHub Issues
• Submit feature requests
• Contribute code via pull requests

Acknowledgments

Built with ❤️ using the VS Code Extension API

Enjoy coding with Atlas AI! 🚀