How ruvnet/sparc-ide works
Project Type and Purpose
• SPARC IDE is a desktop IDE distribution (Electron/VSCodium-based) customized for AI-native, prompt-driven development. It bundles:
• The VSCodium core UI
• Roo Code extension for AI workflows
• SPARC-specific extensions and themes
• Packaging for Linux, macOS, Windows
• CI/build/test infrastructure
• Secure AI service integration (MCP server & external AI APIs)
File Structure
• Top-level directories designate major subsystems:
• /src: extension code, configs, templates
• /scripts: build, packaging, setup, verification
• /package: final installers, manifests, security reports
• /extensions: Roo Code VSIX and signature assets
• /tests & /test-reports: automated test suites & outputs
• /.roo: rules library for the Roo Code agent framework
• Configuration files (package/manifest.json, src/config/*.json) drive packaging and runtime behavior.
• Build artifacts are produced under /dist or /package.
README for Additional Insights
• Architecture overview lives in docs/1_architecture_overview.md.
• SPARC methodology phases correlate to templates in src/sparc-workflow/templates.
• Dependencies: Node.js, Yarn, Electron/VSCodium, external AI endpoints, MCP server.
1. VSCodium Core (Electron UI + Editor API)
2. SPARC IDE Extension Suite:
– Roo Code Extension
– SPARC Workflow Extension (phase templates, UI commands)
– Theme & Keybindings Module
3. Configuration Manager (loads src/config/*.json)
4. AI Integration Layer:
– MCP Client (Model Context Protocol client library)
– AI Service Connectors (OpenRouter, Claude, GPT-4, Gemini)
– Secure Key Store (encrypted env var manager)
5. Packaging & Distribution:
– Build Scripts (scripts/*.sh, .ps1, .bat)
– Platform Installers (DEB, RPM, DMG, EXE, NSIS)
– Extension Verification (public key + signature)
6. CI/Test Infrastructure:
– Automated Tests (tests/*)
– Reporting (test-reports/)
7. External Services:
– MCP Server (HTTPS API)
– AI Model Endpoints
• User invokes SPARC commands in VSCode → Extension Suite
• Extension Suite reads/writes via Configuration Manager
• When AI features are used → AI Integration Layer → MCP Server → External AI Models
• Packaging Scripts consume build artifacts from Extension Suite & Branding → produce installers
• CI/Test Infrastructure triggers scripts and reports back status
c. Architectural Patterns & Principles:
• Plugin Architecture (VSCode extension host)
• Layered Separation (UI layer, Extension logic, Integration layer, Packaging layer)
• Secure-by-design (encrypted key store, signature verification)
• Cross-Platform Packaging Abstraction
d. Key Technologies & Frameworks:
• Electron / VSCodium
• Node.js & Yarn
• VSCode Extension API (TypeScript/JavaScript)
• Shell scripts, PowerShell, NSIS
• HTTPS / REST (MCP, AI services)
• JSON-based configuration & manifest files