ai-software-architect
starsforks
How to install ai-software-architect?
codenamev/ai-software-architect
$git clone https://github.com/codenamev/ai-software-architectAI-powered architecture documentation framework with ADRs, reviews, and pragmatic mode. Now available as Claude Code Plugin for easiest installation.
README.md
| 1 | # AI Software Architect |
| 2 | |
| 3 | A markdown-based framework for implementing rigorous software architecture practices in any project, with specialized AI assistant integration. |
| 4 | |
| 5 | <div> |
| 6 | <a href="https://www.loom.com/share/b83f478045e04bb9ba7e70f5fe057d14"> |
| 7 | <p>Introducing AI Software Architect 🚀 - Watch Video</p> |
| 8 | </a> |
| 9 | <a href="https://www.loom.com/share/b83f478045e04bb9ba7e70f5fe057d14"> |
| 10 | <img style="max-width:300px;" src="https://cdn.loom.com/sessions/thumbnails/b83f478045e04bb9ba7e70f5fe057d14-901889c69de34909-full-play.gif"> |
| 11 | </a> |
| 12 | </div> |
| 13 | |
| 14 | ## Overview |
| 15 | |
| 16 | This framework provides a structured approach to: |
| 17 | |
| 18 | 1. **Architecture Documentation** - Templates and processes for documenting architectural decisions |
| 19 | 2. **Architecture Reviews** - A multi-perspective review process with specialized reviewers |
| 20 | 3. **Architecture Recalibration** - Process for translating reviews into concrete implementation plans |
| 21 | 4. **Progress Tracking** - Tools for monitoring the implementation of architectural changes |
| 22 | 5. **AI Integration** - Seamless collaboration with AI coding assistants |
| 23 | |
| 24 | For detailed usage instructions, see [USAGE.md](USAGE.md). For troubleshooting and advanced usage, see [TROUBLESHOOTING.md](TROUBLESHOOTING.md). |
| 25 | |
| 26 | ## Installation |
| 27 | |
| 28 | Choose the installation method for your AI assistant: |
| 29 | |
| 30 | ### Claude Code Installation |
| 31 | |
| 32 | Claude Code supports three installation methods: |
| 33 | |
| 34 | **Option 1: Claude Code Plugin (Recommended)** 🆕 |
| 35 | |
| 36 | Install via the Claude Code plugin system with automatic updates: |
| 37 | |
| 38 | ```bash |
| 39 | # In Claude Code, run these commands: |
| 40 | /plugin marketplace add codenamev/ai-software-architect |
| 41 | /plugin install ai-software-architect@ai-software-architect |
| 42 | ``` |
| 43 | |
| 44 | That's it! The framework is now available in all your projects — including the seven skills, MCP server, and generated subagents as a single unit. |
| 45 | |
| 46 | See [USAGE-WITH-CLAUDE-PLUGIN.md](USAGE-WITH-CLAUDE-PLUGIN.md) for detailed installation guide, troubleshooting, and comparison with other methods. |
| 47 | |
| 48 | **Benefits**: Simplest installation, automatic updates, works across all projects, no manual file management, ships skills + MCP + hooks as a unit |
| 49 | |
| 50 | **When to use**: You use Claude Code and want the most streamlined experience with automatic updates. |
| 51 | |
| 52 | --- |
| 53 | |
| 54 | **Option 2: MCP Server** |
| 55 | |
| 56 | ```bash |
| 57 | npm install -g ai-software-architect |
| 58 | ``` |
| 59 | |
| 60 | Then configure in `~/.claude/config.json`: |
| 61 | ```json |
| 62 | { |
| 63 | "mcpServers": { |
| 64 | "ai-software-architect": { |
| 65 | "command": "mcp", |
| 66 | "args": [] |
| 67 | } |
| 68 | } |
| 69 | } |
| 70 | ``` |
| 71 | |
| 72 | **Benefits**: Programmatic automation, external tool integration, advanced project analysis |
| 73 | |
| 74 | **When to use**: You need programmatic access or integration with other MCP-compatible tools. |
| 75 | |
| 76 | --- |
| 77 | |
| 78 | **Option 3: Traditional Setup** |
| 79 | |
| 80 | ``` |
| 81 | Setup architecture using: https://github.com/codenamev/ai-software-architect |
| 82 | ``` |
| 83 | |
| 84 | See [USAGE-WITH-CLAUDE.md](USAGE-WITH-CLAUDE.md) for detailed instructions. |
| 85 | |
| 86 | **Benefits**: No installation required, works immediately, maximum flexibility |
| 87 | |
| 88 | **When to use**: Quick experiments, no installation permissions, or maximum customization needs. |
| 89 | |
| 90 | ### Cursor Installation |
| 91 | |
| 92 | If you're using Cursor, you have two options: |
| 93 | |
| 94 | **Option 1: MCP Server (Recommended)** |
| 95 | ```bash |
| 96 | npm install -g ai-software-architect |
| 97 | ``` |
| 98 | Then configure in Cursor settings (`settings.json`): |
| 99 | ```json |
| 100 | { |
| 101 | "mcp.servers": { |
| 102 | "ai-software-architect": { |
| 103 | "command": "mcp", |
| 104 | "args": [] |
| 105 | } |
| 106 | } |
| 107 | } |
| 108 | ``` |
| 109 | |
| 110 | **Option 2: Traditional Setup** |
| 111 | ``` |
| 112 | Setup architecture using @https://github.com/codenamev/ai-software-architect |
| 113 | ``` |
| 114 | See [USAGE-WITH-CURSOR.md](USAGE-WITH-CURSOR.md) for detailed traditional setup instructions. |
| 115 | |
| 116 | ### GitHub Copilot / Codex Installation |
| 117 | |
| 118 | **MCP Support**: GitHub Copilot and Codex currently have limited MCP support. Use the traditional setup method: |
| 119 | |
| 120 | ``` |
| 121 | Setup architecture using: https://github.com/codenamev/ai-software-architect |
| 122 | ``` |
| 123 | |
| 124 | See [USAGE-WITH-CODEX.md](USAGE-WITH-CODEX.md) for detailed setup instructions. The framework will be configured with context files that GitHub Copilot and Codex can automatically understand. |
| 125 | |
| 126 | ## Installation Method Comparison |
| 127 | |
| 128 | Choose the right installation method for your workflow: |
| 129 | |
| 130 | | Feature | Plugin 🆕 | MCP Server | Traditional | Best For | |
| 131 | |---------|----------|------------|-------------|----------| |
| 132 | | **Installation** | Two commands | npm install -g | Clone repo | Plugin: Simplest<br>MCP: Programmatic<br>Traditional: Quick | |
| 133 | | **Setup Complexity** | ⭐ Simplest | ⭐⭐ Medium | ⭐ Simple | Plugin easiest | |
| 134 | | **AI Assistants** | Claude Code | Claude, Cursor | All assistants | Plugin: Claude only<br>MCP: Claude, Cursor<br>Traditional: Universal | |
| 135 | | **Invocation** | Automatic (MCP + Skills) | Programmatic tools | Natural language | Plugin: Seamless<br>MCP: Precise<br>Traditional: Flexible | |
| 136 | | **Dependencies** | Node.js ≥18 (auto) | Node.js ≥18 | None | Traditional: No deps<br>Plugin & MCP: Node auto-managed | |
| 137 | | **Auto-Updates** | ✅ `/plugin update` | ✅ `npm update` | ❌ Git pull | Plugin & MCP: Auto-update | |
| 138 | | **Offline Use** | ⚠️ Needs npm | ⚠️ Needs npm | ✅ Full | Traditional: Offli |
People who liked this also viewed
6 picksType
- Figma-Context-MCPMCP server to provide Figma layout information to AI coding agents like CursorMCP ServersJul 2026
- sunnysideFigma-Context-MCPA comprehensive Model Context Protocol (MCP) server that bridges Figma designs with AI development workflows. It provides 30 specialized tools for extracting pixel-perfect code, assets, and component structures directly from Figma designs.MCP ServersApr 2026
- figma-console-mcpYour design system as an API. Connect AI to Figma for extraction, creation, and debugging.MCP ServersJul 2026
- dcc-mcp-coreCore runtime and shared tooling for DCC-MCP: safe, skill-first MCP integration across Maya, Blender, Houdini, Photoshop, and custom DCC hosts.MCP ServersJul 2026
- godot-aiProduction-grade MCP server and AI tools for the Godot engine. A Snap to install. Totally free and fun.MCP ServersJul 2026
- freecad-mcpFreeCAD MCP(Model Context Protocol) serverMCP ServersJul 2026
