BrainGrid VS Code Extension

Access AI-optimized development tasks and manage requirements directly in your IDE. Compatible with VS Code, Cursor, Windsurf, and other VS Code-based editors.

Overview

The BrainGrid extension brings your AI-generated requirements and tasks directly into your development environment. It provides a seamless workflow for viewing, managing, and executing development tasks that are optimized for AI coding assistants.

Key Features

• 📋 Requirements Management: View and manage development requirements with real-time status tracking
• ✅ Task Workflow: Access detailed tasks, mark them as complete, and track progress
• 👥 Team Collaboration: See both your assigned tasks and all team requirements
• 🎯 Smart Filtering: Filter by status (Planned, In Progress, Completed) and search across requirements
• 📊 Compact View: Toggle between normal and compact views for efficient task browsing
• 🔄 One-Click Copy: Copy task details instantly for use with AI coding assistants
• 💾 Persistent State: Your view preferences and filters are saved between sessions

Installation

From VS Code Marketplace (Recommended)

1. Open VS Code, Cursor, or your VS Code-based editor
2. Press Cmd+Shift+X (Mac) or Ctrl+Shift+X (Windows/Linux) to open Extensions
3. Search for "BrainGrid"
4. Click "Install"

From VSIX File

1. Download the latest .vsix file from releases
2. Press Cmd+Shift+P (Mac) or Ctrl+Shift+P (Windows/Linux)
3. Run "Extensions: Install from VSIX..."
4. Select the downloaded file

For Developers

# Clone the repository
git clone https://github.com/BrainGridAI/braingrid-extension.git
cd braingrid-extension

# Install dependencies
npm install

# Build the extension
npm run compile

# For development with watch mode
npm run watch

# Package the extension
npm run package

Getting Started

1. Sign In: Click the "Sign In" button in the BrainGrid panel to authenticate
2. View Requirements: Browse your assigned tasks in "My Requirements" or all team tasks in "All"
3. Use Tasks:
   • Click on a requirement to see its tasks
   • Click "Copy" to copy task content for your AI assistant
   • For planned tasks, use "Copy and Start Task" to copy and update status
   • Mark tasks complete when done

Keyboard Shortcuts

• Cmd+K / Ctrl+K: Toggle compact view
• Cmd+Shift+R / Ctrl+Shift+R: Refresh requirements
• Escape: Return to list view from requirement details

Configuration

The extension can be configured through VS Code settings:

• braingrid.apiUrl: API endpoint (default: https://app.braingrid.ai)
• braingrid.debug: Enable debug logging (default: false)

Development

Project Structure

braingrid-extension/
├── src/
│   ├── extension.ts          # Extension entry point
│   ├── services/             # API and authentication services
│   ├── webview/              # React-based UI components
│   │   ├── components/       # React components
│   │   └── styles/           # CSS styles
│   └── utils/                # Utilities and helpers
├── resources/                # Icons and assets
└── package.json             # Extension manifest

Building from Source

# Development build with source maps
npm run compile

# Production build (minified, no console logs)
npm run compile:prod

# Watch mode for development
npm run watch

# Run tests
npm test

# Package for distribution
npm run package

Key Technologies

• Frontend: React with TypeScript for the webview UI
• Backend: VS Code Extension API with TypeScript
• Build: Webpack with separate configs for extension and webview
• Authentication: OAuth2 flow with local callback server
• State Management: VS Code workspace state persistence

Privacy & Security

• Authentication tokens are stored securely in VS Code's secret storage
• No source code is read or transmitted by the extension
• Minimal telemetry: only authentication and error events
• All data transmission is over HTTPS

Troubleshooting

Extension Not Loading

1. Check VS Code version (requires 1.80.0+)
2. Reload VS Code window: Cmd+R / Ctrl+R
3. Check output panel for errors: View → Output → BrainGrid Extension

Authentication Issues

1. Ensure you have a BrainGrid account
2. Check your internet connection
3. Try signing out and back in
4. Clear VS Code cache if needed

Tasks Not Showing

1. Verify you're signed in (check header status)
2. Try refreshing with the refresh button
3. Check filters - you might have filtered out all tasks
4. Switch between "My Requirements" and "All" tabs

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Tips

1. Use the debug configuration in VS Code to test the extension
2. Enable braingrid.debug setting for detailed logging
3. The webview uses React DevTools when in development mode
4. Console logs are automatically removed in production builds

Support

• Documentation: braingrid.ai/docs
• Issues: GitHub Issues
• Email: support@braingrid.ai

License

Copyright (c) 2025 BrainGrid AI, Inc. All rights reserved.

This extension is proprietary software. See LICENSE for details.