aiteam-x 0.14.4 → 0.14.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -21
- package/README.en.md +7 -574
- package/README.md +569 -574
- package/README.pt.md +591 -0
- package/package.json +80 -72
- package/scripts/cli.mjs +236 -236
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2026 INOSX
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 INOSX
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.en.md
CHANGED
|
@@ -1,574 +1,7 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
[](https://www.npmjs.com/package/aiteam-x)
|
|
10
|
-
[](https://nextjs.org/)
|
|
11
|
-
[](https://react.dev/)
|
|
12
|
-
[](https://www.typescriptlang.org/)
|
|
13
|
-
[](https://github.com/bmad-method)
|
|
14
|
-
[](LICENSE)
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
npx 4aiteam-x@latest
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
---
|
|
21
|
-
|
|
22
|
-
## Overview
|
|
23
|
-
|
|
24
|
-
**AITeam Team Overview** is an interactive dashboard that turns AI agent management into a visual, intuitive experience. Inspired by *sim manager*-style simulation games, the panel displays BMAD agents as pixel-art characters in a virtual office, allowing you to:
|
|
25
|
-
|
|
26
|
-
- **Visualize** each agent's status and location in real time — in 2D pixel art or a 3D isometric office (Three.js)
|
|
27
|
-
- **Customize** the experience with 4 visual themes (Pixel Bots, Chibi, Hybrid, Teams) — each with distinct palettes and avatars
|
|
28
|
-
- **Interact** directly with agents through a resizable lateral chat drawer with SSE streaming
|
|
29
|
-
- **Create rooms** to group agents into custom work contexts
|
|
30
|
-
- **Review diffs** of files modified by agents with inline approval/rejection before persisting changes
|
|
31
|
-
- **Orchestrate** workflows such as Party Mode and brainstorming sessions via the workflow panel
|
|
32
|
-
- **Monitor** usage metrics via a gamified Quest Log (messages, tokens in/out) and view tool calls in real time
|
|
33
|
-
- **Persist** context and memories between work sessions with LLM extraction, compaction, and automatic migration
|
|
34
|
-
- **Update** the platform with one click via integrated self-update (check, download, merge, restart)
|
|
35
|
-
|
|
36
|
-
The project uses the **BMAD Method** as the agent framework, natively integrating with the **Cursor Agent CLI** and **Cursor ACP** (Agent Client Protocol) for bidirectional LLM communication.
|
|
37
|
-
|
|
38
|
-
---
|
|
39
|
-
|
|
40
|
-
## Screenshots
|
|
41
|
-
|
|
42
|
-
### Main Dashboard
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
*Virtual office with Jarvis Office, Kitchen, and individual workspaces. Bottom bar with avatars and sprint progress (14/14 — 100%).*
|
|
47
|
-
|
|
48
|
-
---
|
|
49
|
-
|
|
50
|
-
### Agent Chat Window
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
*Real-time conversation window with BMad Master. Each agent responds with text streaming and Markdown support.*
|
|
55
|
-
|
|
56
|
-
---
|
|
57
|
-
|
|
58
|
-
### Memory Vault
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
*Per-agent memory management panel. Categories: decisions, lessons, tasks, projects, handoffs. Real-time BM25 search.*
|
|
63
|
-
|
|
64
|
-
---
|
|
65
|
-
|
|
66
|
-
### Agent Filters
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
*Status filters (All / Working) and Module filters (BMGD / BMM / CORE) for segmented agent views.*
|
|
71
|
-
|
|
72
|
-
---
|
|
73
|
-
|
|
74
|
-
## Key Features
|
|
75
|
-
|
|
76
|
-
### Pixel Art Dashboard + 3D Scene
|
|
77
|
-
- **2D/3D Toggle**: switch between the classic pixel art grid and a 3D isometric office (Three.js / React Three Fiber)
|
|
78
|
-
- **3D Scene**: isometric environment with models loaded via `ModelLoader`, dynamic lighting (`DayNightLight`), agents as 3D characters (`AgentCharacter`), and pathfinding (`three-pathfinding`)
|
|
79
|
-
- **Collapsible sidebar**: lateral navigation with agents organized by module, custom rooms, and real-time status indicators
|
|
80
|
-
- Shared rooms: **Jarvis Office**, **Kitchen** — with agent activity context
|
|
81
|
-
- Individual workspace grid per agent with module indicators (BMGD / BMM / CORE / BMB)
|
|
82
|
-
- Pixel art or image-based avatars (depending on theme) with real-time visual status
|
|
83
|
-
- Bottom bar with compact avatars and sprint timeline with granular per-story progress
|
|
84
|
-
- Day/night cycle and ambient effects (reflected in both 2D and 3D)
|
|
85
|
-
- **Starfield Canvas**: background animation with stellar particles as a decorative visual effect
|
|
86
|
-
|
|
87
|
-
### Agent Interaction
|
|
88
|
-
- Agent selection (click) or multi-selection (Ctrl+click) for batch commands
|
|
89
|
-
- **Chat Drawer**: resizable panel pinned to the right with real-time SSE streaming (replaced floating windows)
|
|
90
|
-
- Per-agent input history (↑ to navigate previous commands)
|
|
91
|
-
- **Rich Message Rendering**: responses segmented into Markdown, terminal blocks, tool call indicators, and collapsible thinking blocks
|
|
92
|
-
- **Thinking Block**: expandable view of the model's internal reasoning (chain-of-thought)
|
|
93
|
-
- **Tool Call Indicators**: real-time badges showing agent actions (Read, Edit, Terminal, Grep, etc.) with contextual summaries
|
|
94
|
-
- **Copy button**: appears on hover over agent responses for one-click copy
|
|
95
|
-
- **Context menu**: right-click on any agent to see agent-specific MDC commands
|
|
96
|
-
- Stop button to cancel ongoing processing
|
|
97
|
-
- Conversation history persisted across reloads
|
|
98
|
-
- Escape shortcut to close the drawer
|
|
99
|
-
|
|
100
|
-
### Diff Approval (Change Review)
|
|
101
|
-
- **Pre-command snapshot**: the system captures file state before each agent command and compares after the response, detecting changes with precision
|
|
102
|
-
- **Inline diff cards**: unified diff cards appear directly in the agent conversation with per-line syntax highlighting (additions, removals, context)
|
|
103
|
-
- **Granular approval**: Approve/Deny buttons per individual file, or "Approve All" for batch acceptance
|
|
104
|
-
- **Automatic revert**: denied files are reverted to their original content via `/api/files/revert`
|
|
105
|
-
- Visual counters of added/removed lines per file and status badges (Approved / Reverted)
|
|
106
|
-
|
|
107
|
-
### Theme System
|
|
108
|
-
- **4 visual themes**: Pixel Bots (cyberpunk), Chibi (anime), Hybrid (tech), Teams (corporate)
|
|
109
|
-
- **Dynamic avatars**: Chibi and Hybrid themes use image-based avatars; Pixel Bots and Teams use SVG pixel art
|
|
110
|
-
- **ThemePicker**: visual selector with color preview and icon per theme
|
|
111
|
-
- **Persistence**: selected theme saved in `localStorage` and applied via CSS custom properties
|
|
112
|
-
|
|
113
|
-
### Chat Rooms (Custom Rooms)
|
|
114
|
-
- **Free creation**: group any combination of agents into themed rooms via `CreateRoomModal`
|
|
115
|
-
- **Integrated sidebar**: rooms appear in the side bar with icon and member list
|
|
116
|
-
- **RoomTransition**: smooth transition animation when switching between rooms
|
|
117
|
-
- **API persistence**: rooms saved on the server (`/api/rooms`) and synchronized across reloads
|
|
118
|
-
|
|
119
|
-
### Quest Log (Activity Log)
|
|
120
|
-
- **Gamified panel**: RPG-style visualization of each agent's activities
|
|
121
|
-
- **Per-agent status**: active (in conversation), complete (last session), idle (no activity)
|
|
122
|
-
- **Metrics**: message count, tokens consumed, and last message sent
|
|
123
|
-
- **Inline avatar**: each quest displays the corresponding agent's pixel art avatar
|
|
124
|
-
|
|
125
|
-
### Model Selector & Filters
|
|
126
|
-
- **Model Bar**: LLM model selection applied to all agents
|
|
127
|
-
- **Cursor ACP**: dynamic submenu listing all models available in the user's Cursor account (Claude, GPT, Gemini, Grok, etc.)
|
|
128
|
-
- **Direct models**: Composer 2, Claude Opus/Sonnet, GPT-5.x, Gemini, Grok, Kimi
|
|
129
|
-
- **Status Filter**: All / Working — displays real-time counter (e.g. 14/14)
|
|
130
|
-
- **Module Filter**: BMGD / BMM / CORE — segments agents by area
|
|
131
|
-
|
|
132
|
-
### Cursor ACP (Agent Client Protocol)
|
|
133
|
-
- Direct communication with Cursor via JSON-RPC 2.0 over stdio (`agent acp`)
|
|
134
|
-
- Automatic discovery of available models via ACP session `configOptions`
|
|
135
|
-
- Per-session model switching via `session/set_config_option`
|
|
136
|
-
- Persistent ACP process with 30-min session TTL and automatic reconnection
|
|
137
|
-
- Streaming tool calls with rich metadata (type, title, summarized output)
|
|
138
|
-
- Error fallback with actionable messages for the user
|
|
139
|
-
|
|
140
|
-
### BMAD Orchestration
|
|
141
|
-
- Automatic detection of Party Mode and active workflows
|
|
142
|
-
- Agents dynamically move to rooms according to the workflow
|
|
143
|
-
- Session state persisted on disk and synchronized via SSE
|
|
144
|
-
- Per-agent message and token metrics
|
|
145
|
-
|
|
146
|
-
### Persistent Memory System (v2.2)
|
|
147
|
-
- **Memory Vault**: full visual panel with 5 categories (decisions, lessons, tasks, projects, handoffs)
|
|
148
|
-
- **Auto-extract via LLM**: when closing a session, the system analyzes the conversation and automatically extracts structured memories
|
|
149
|
-
- **Badge 🤖 llm**: automatically extracted entries are flagged for 10 minutes with veto option
|
|
150
|
-
- **BM25 Search**: relevance-based semantic search within each agent's vault
|
|
151
|
-
- **Context Injection**: relevant memories automatically injected when starting new sessions (2,000-token budget)
|
|
152
|
-
- **Automatic compaction**: `/api/memory/compact` cleans old checkpoints, merges duplicates, and rebuilds indexes
|
|
153
|
-
- **Data migration**: `/api/memory/migrate` updates data structures from previous versions automatically
|
|
154
|
-
- **Auto-save**: conversations saved every 30s + save on unload via `sendBeacon`
|
|
155
|
-
- **Session Checkpoint**: history preserved even across unexpected restarts
|
|
156
|
-
- **Shared Memory**: `_project.md` injected into all agents as global context
|
|
157
|
-
|
|
158
|
-
### Self-Update
|
|
159
|
-
- **Automatic check**: `/api/version/check` compares local version with the NPM registry
|
|
160
|
-
- **UpdateModal**: step-by-step interface with visual progress (download → merge → install → restart)
|
|
161
|
-
- **Smart merge**: updates only template files without overwriting local configurations
|
|
162
|
-
- **Automatic restart**: restarts the development server after the update
|
|
163
|
-
|
|
164
|
-
### Notifications & Easter Eggs
|
|
165
|
-
- **Event Toast**: visual notification system with 4 types (success, error, info, milestone) and auto-dismiss
|
|
166
|
-
- **Easter Eggs**: hidden interactions in the virtual office (fridge, coffee machine, and more) with rarities (common, rare, legendary)
|
|
167
|
-
- **Sound system**: optional sound effects for interactions and discoveries
|
|
168
|
-
|
|
169
|
-
### Portability & Installation (v1.0)
|
|
170
|
-
- **Dynamic Discovery**: automatically detects BMAD agents via CSV/YAML — no hardcoding
|
|
171
|
-
- **Cross-platform**: works on Windows, macOS, and Linux
|
|
172
|
-
- **Web Setup Wizard**: `/setup` in the browser — 3 animated phases: machine scan, review, step-by-step configuration
|
|
173
|
-
- **CLI Setup Wizard**: `npm run setup` — interactive terminal alternative (6 steps)
|
|
174
|
-
- **Health Gate**: if not configured, automatically redirects to `/setup`
|
|
175
|
-
- **Flexible Config**: local `aiteam.config.json` + `AITEAM_BMAD_ROOT` for external/CI instances
|
|
176
|
-
|
|
177
|
-
---
|
|
178
|
-
|
|
179
|
-
## Tech Stack
|
|
180
|
-
|
|
181
|
-
| Layer | Technology | Version |
|
|
182
|
-
|-------|-----------|---------|
|
|
183
|
-
| Framework | Next.js (App Router) | 15.x |
|
|
184
|
-
| UI | React | 19.x |
|
|
185
|
-
| 3D Engine | Three.js + React Three Fiber + Drei | 0.183 / 9.5 / 10.7 |
|
|
186
|
-
| Language | TypeScript | 5.x |
|
|
187
|
-
| Styling | CSS custom (design system with 4 themes) | — |
|
|
188
|
-
| Font | VT323 (Google Fonts) | — |
|
|
189
|
-
| Backend | Next.js API Routes + SSE (22 endpoints) | — |
|
|
190
|
-
| Diff Engine | diff (npm) | 8.x |
|
|
191
|
-
| Search | MiniSearch (BM25) | 7.2.x |
|
|
192
|
-
| Pathfinding | three-pathfinding | 1.3.x |
|
|
193
|
-
| Agents | Cursor Agent CLI + ACP | latest |
|
|
194
|
-
| Protocol | ACP (JSON-RPC 2.0 / stdio) | v1 |
|
|
195
|
-
| Parsing | yaml (npm) | 2.8.x |
|
|
196
|
-
| Tests | Vitest + v8 coverage | 4.x |
|
|
197
|
-
| Agent Framework | BMAD Method | — |
|
|
198
|
-
|
|
199
|
-
---
|
|
200
|
-
|
|
201
|
-
## Quick Start
|
|
202
|
-
|
|
203
|
-
### Prerequisites
|
|
204
|
-
|
|
205
|
-
| Requirement | Required | Notes |
|
|
206
|
-
|-------------|----------|-------|
|
|
207
|
-
| Node.js >= 18 | Yes | `node --version` |
|
|
208
|
-
| BMAD Framework | Yes | See [Installation Guide](docs/installation-guide.md) |
|
|
209
|
-
| Cursor IDE | Yes | Generates the Cursor Agent CLI on first launch |
|
|
210
|
-
| Git | Yes | — |
|
|
211
|
-
|
|
212
|
-
> **Supported platforms:** Windows 10/11, macOS, Linux
|
|
213
|
-
|
|
214
|
-
### Installation
|
|
215
|
-
|
|
216
|
-
**Option 1 — One command (recommended):**
|
|
217
|
-
|
|
218
|
-
```bash
|
|
219
|
-
npx 4aiteam-x@latest
|
|
220
|
-
```
|
|
221
|
-
|
|
222
|
-
Creates the project in the current directory (must be empty). Or specify a folder name:
|
|
223
|
-
|
|
224
|
-
```bash
|
|
225
|
-
npx 4aiteam-x@latest my-project
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
The command downloads the template, installs dependencies, runs the setup wizard, and starts the server automatically.
|
|
229
|
-
|
|
230
|
-
**Option 2 — Manual installation:**
|
|
231
|
-
|
|
232
|
-
```bash
|
|
233
|
-
# 1. Clone the repository
|
|
234
|
-
git clone https://github.com/INOSX/AITeam.git
|
|
235
|
-
cd AITeam
|
|
236
|
-
|
|
237
|
-
# 2. Install dependencies
|
|
238
|
-
npm install
|
|
239
|
-
|
|
240
|
-
# 3. Run the setup wizard
|
|
241
|
-
npm run setup
|
|
242
|
-
|
|
243
|
-
# 4. Start the development server
|
|
244
|
-
npm run dev
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
The dashboard will be available at **http://localhost:3000**.
|
|
248
|
-
|
|
249
|
-
> If setup hasn't been completed, the system automatically redirects to `http://localhost:3000/setup` — an animated wizard that detects the environment, shows what's ready, and lets you configure everything through the browser.
|
|
250
|
-
|
|
251
|
-
> **CLI alternative:** `npm run setup` runs the interactive wizard in the terminal.
|
|
252
|
-
|
|
253
|
-
### Available Scripts
|
|
254
|
-
|
|
255
|
-
| Command | Description |
|
|
256
|
-
|---------|-------------|
|
|
257
|
-
| `npm run setup` | **Interactive setup wizard** (first install) |
|
|
258
|
-
| `npm run dev` | Start the development server (port 3000) |
|
|
259
|
-
| `npm run dev:clean` | Start with cache cleanup (resolves state issues) |
|
|
260
|
-
| `npm run build` | Generate the production build (with pre-build validations) |
|
|
261
|
-
| `npm run start` | Start the production server |
|
|
262
|
-
| `npm run lint` | Run the linter (ESLint) |
|
|
263
|
-
| `npm run test` | Run tests with Vitest |
|
|
264
|
-
| `npm run test:watch` | Tests in watch mode (re-runs on save) |
|
|
265
|
-
|
|
266
|
-
### Utility Scripts
|
|
267
|
-
|
|
268
|
-
| Script | Description |
|
|
269
|
-
|--------|-------------|
|
|
270
|
-
| `node scripts/import-conversations.mjs` | Import conversation history into the vault |
|
|
271
|
-
| `node scripts/generate-chibi-logo.mjs` | Generate chibi-style logo assets |
|
|
272
|
-
| `node scripts/crop-avatars.mjs` | Crop avatars for image-based themes |
|
|
273
|
-
|
|
274
|
-
> All scripts require the server running at `localhost:3000`.
|
|
275
|
-
|
|
276
|
-
---
|
|
277
|
-
|
|
278
|
-
## Project Structure
|
|
279
|
-
|
|
280
|
-
```
|
|
281
|
-
AITeam/
|
|
282
|
-
├── app/ # Next.js App Router
|
|
283
|
-
│ ├── api/ # API Routes (backend) — 22 endpoints
|
|
284
|
-
│ │ ├── acp/
|
|
285
|
-
│ │ │ └── models/route.ts # GET: available models via ACP
|
|
286
|
-
│ │ ├── agents/
|
|
287
|
-
│ │ │ ├── route.ts # GET: list agents with status
|
|
288
|
-
│ │ │ ├── command/route.ts # POST: send command via SSE (CLI or ACP) + file diffs
|
|
289
|
-
│ │ │ └── menus/route.ts # GET: agent context menus
|
|
290
|
-
│ │ ├── bridge/route.ts # GET: ACP health check
|
|
291
|
-
│ │ ├── config/route.ts # GET: BMAD configuration
|
|
292
|
-
│ │ ├── files/
|
|
293
|
-
│ │ │ └── revert/route.ts # POST: revert file to original content (diff denial)
|
|
294
|
-
│ │ ├── memory/
|
|
295
|
-
│ │ │ ├── route.ts # GET/POST: memory and conversations (legacy)
|
|
296
|
-
│ │ │ ├── vault/route.ts # GET/POST/PUT/DELETE: structured vault
|
|
297
|
-
│ │ │ ├── search/route.ts # GET: BM25 search
|
|
298
|
-
│ │ │ ├── checkpoint/route.ts # POST: session checkpoint
|
|
299
|
-
│ │ │ ├── compact/route.ts # POST: data compaction (cleanup + merge + reindex)
|
|
300
|
-
│ │ │ └── migrate/route.ts # POST: data structure migration from previous versions
|
|
301
|
-
│ │ ├── rooms/route.ts # GET/POST: custom agent rooms
|
|
302
|
-
│ │ ├── session/
|
|
303
|
-
│ │ │ ├── route.ts # GET/POST: active session
|
|
304
|
-
│ │ │ └── stream/route.ts # GET: SSE for session changes
|
|
305
|
-
│ │ ├── sprint/route.ts # GET/POST: sprint status
|
|
306
|
-
│ │ ├── terminal/
|
|
307
|
-
│ │ │ └── execute/route.ts # POST: terminal command execution
|
|
308
|
-
│ │ ├── version/
|
|
309
|
-
│ │ │ ├── check/route.ts # GET: check latest version on NPM
|
|
310
|
-
│ │ │ ├── update/route.ts # POST: SSE download + merge + install
|
|
311
|
-
│ │ │ └── restart/route.ts # POST: restart the dev server
|
|
312
|
-
│ │ └── workflows/route.ts # GET: available workflows
|
|
313
|
-
│ ├── actions/
|
|
314
|
-
│ │ └── setup-save.ts # Server Action: saves aiteam.config.json
|
|
315
|
-
│ ├── setup/
|
|
316
|
-
│ │ ├── page.tsx # Setup page (health gate + Server Component)
|
|
317
|
-
│ │ └── SetupWizard.tsx # Animated 3-phase wizard (Client Component)
|
|
318
|
-
│ ├── globals.css # Design system with 4 themes (800+ lines)
|
|
319
|
-
│ ├── layout.tsx # Root layout (VT323, pt-BR)
|
|
320
|
-
│ ├── error.tsx # Error boundary
|
|
321
|
-
│ └── page.tsx # Main page (health gate)
|
|
322
|
-
│
|
|
323
|
-
├── components/ # React Components (~49 files)
|
|
324
|
-
│ ├── rooms/ # Virtual office rooms (2D)
|
|
325
|
-
│ │ ├── ConferenceRoom.tsx
|
|
326
|
-
│ │ ├── JarvisOffice.tsx
|
|
327
|
-
│ │ └── Kitchen.tsx
|
|
328
|
-
│ ├── scene/ # 3D Scene (Three.js / R3F)
|
|
329
|
-
│ │ ├── Scene3D.tsx # Main 3D canvas
|
|
330
|
-
│ │ ├── OfficeEnvironment.tsx # 3D office environment
|
|
331
|
-
│ │ ├── ModelLoader.tsx # 3D model loader
|
|
332
|
-
│ │ ├── DayNightLight.tsx # Day/night lighting system
|
|
333
|
-
│ │ └── AgentCharacter.tsx # 3D agent character
|
|
334
|
-
│ ├── AgentContextMenu.tsx # Per-agent context menu
|
|
335
|
-
│ ├── AgentDetail.tsx # Detailed agent view
|
|
336
|
-
│ ├── AgentListItem.tsx # Sidebar list item
|
|
337
|
-
│ ├── AgentsProvider.tsx # Global Context Provider
|
|
338
|
-
│ ├── BottomBar.tsx # Bottom bar with avatars and sprint
|
|
339
|
-
│ ├── ChatDrawer.tsx # Resizable lateral chat drawer + inline diffs
|
|
340
|
-
│ ├── CommandPopup.tsx # Multi-agent popup
|
|
341
|
-
│ ├── CopyButton.tsx # Copy button for responses
|
|
342
|
-
│ ├── CreateRoomModal.tsx # Modal for creating custom rooms
|
|
343
|
-
│ ├── DayNightCycle.tsx # Day/night cycle (2D)
|
|
344
|
-
│ ├── DiffViewer.tsx # Diff viewer with inline approval/rejection
|
|
345
|
-
│ ├── EasterEggs.tsx # Hidden office interactions
|
|
346
|
-
│ ├── EventToast.tsx # Toast notification system
|
|
347
|
-
│ ├── FilterContext.tsx # Filter context (status + module)
|
|
348
|
-
│ ├── Layout.tsx # Main shell
|
|
349
|
-
│ ├── MainContent.tsx # Main orchestrator
|
|
350
|
-
│ ├── MarkdownRenderer.tsx # Custom Markdown renderer
|
|
351
|
-
│ ├── MemoryVault.tsx # Memory Vault dashboard (modal)
|
|
352
|
-
│ ├── MessageRenderer.tsx # Segmented renderer (MD, terminal, tools, thinking)
|
|
353
|
-
│ ├── ModelBar.tsx # Model selection bar and filters
|
|
354
|
-
│ ├── PixelAvatar.tsx # Pixel art SVG / image-based avatar
|
|
355
|
-
│ ├── QuestLog.tsx # Gamified agent activity panel
|
|
356
|
-
│ ├── RoomTransition.tsx # Room transition animation
|
|
357
|
-
│ ├── Sidebar.tsx # Collapsible sidebar (agents + rooms)
|
|
358
|
-
│ ├── SpeechBubble.tsx # Individual speech bubble
|
|
359
|
-
│ ├── SpeechBubbleOverlay.tsx # Chat overlay system
|
|
360
|
-
│ ├── SprintPanel.tsx # Dedicated sprint panel
|
|
361
|
-
│ ├── StarfieldCanvas.tsx # Background stellar particle animation
|
|
362
|
-
│ ├── TerminalBlock.tsx # Terminal block in responses
|
|
363
|
-
│ ├── ThemePicker.tsx # Visual theme selector
|
|
364
|
-
│ ├── ThemeProvider.tsx # Theme context provider
|
|
365
|
-
│ ├── ThinkingBlock.tsx # Collapsible reasoning block (thinking)
|
|
366
|
-
│ ├── ThinkingBubble.tsx # Animated thinking indicator
|
|
367
|
-
│ ├── ToolCallIndicator.tsx # Real-time tool call badge
|
|
368
|
-
│ ├── TopBar.tsx # Top bar with title and controls
|
|
369
|
-
│ ├── UpdateModal.tsx # Self-update modal with step-by-step progress
|
|
370
|
-
│ ├── ViewToggle.tsx # 2D ↔ 3D toggle
|
|
371
|
-
│ ├── WorkflowPanel.tsx # BMAD workflow panel with module filter
|
|
372
|
-
│ ├── WorkspaceCell.tsx # Individual workspace cell
|
|
373
|
-
│ ├── WorkspaceGrid.tsx # Workspace grid
|
|
374
|
-
│ └── WorkspaceProps.tsx # Shared workspace props
|
|
375
|
-
│
|
|
376
|
-
├── lib/ # Business logic and utilities
|
|
377
|
-
│ ├── acp-client.ts # ACP client (JSON-RPC 2.0 over stdio)
|
|
378
|
-
│ ├── acp-manager.ts # ACP session manager
|
|
379
|
-
│ ├── aiteam-config.ts # Config loader (env var > file > defaults)
|
|
380
|
-
│ ├── diff.ts # Unified diff engine (computeUnifiedDiff)
|
|
381
|
-
│ ├── health.ts # Health check: BMAD, Cursor CLI, config
|
|
382
|
-
│ ├── mock-agents.ts # Mock data for testing and preview
|
|
383
|
-
│ ├── model-config.ts # Available LLM model options
|
|
384
|
-
│ ├── parseMultiAgentResponse.ts # Multi-agent response parser
|
|
385
|
-
│ ├── setup-discovery.ts # Extended discovery for the web wizard
|
|
386
|
-
│ ├── sound.ts # Sound effects system
|
|
387
|
-
│ ├── synergy.ts # Agent synergy logic
|
|
388
|
-
│ ├── theme.ts # Theme definitions (4 themes + metadata)
|
|
389
|
-
│ ├── types.ts # Global TypeScript types
|
|
390
|
-
│ ├── useAgents.ts # Agent management hook
|
|
391
|
-
│ ├── version.ts # Version check (NPM registry)
|
|
392
|
-
│ ├── bmad/ # BMAD Integration
|
|
393
|
-
│ │ ├── discovery.ts # Dynamic BMAD scanner + Cursor CLI detection
|
|
394
|
-
│ │ ├── agent-mapping.ts # BmadAgent -> Agent mapping
|
|
395
|
-
│ │ ├── chat-sessions.ts # Chat session persistence
|
|
396
|
-
│ │ ├── memory-bank.ts # Memory bank integration
|
|
397
|
-
│ │ ├── parse-agents.ts # agent-manifest.csv parser
|
|
398
|
-
│ │ ├── parse-config.ts # config.yaml parser
|
|
399
|
-
│ │ ├── parse-persona.ts # Persona (.mdc) parser
|
|
400
|
-
│ │ ├── parse-session.ts # Session state + SSE
|
|
401
|
-
│ │ ├── parse-sprint.ts # sprint-status.yaml parser
|
|
402
|
-
│ │ └── parse-workflows.ts # Workflows parser
|
|
403
|
-
│ └── memory/ # Memory system v2.2
|
|
404
|
-
│ ├── compact.ts # Data compaction and cleanup
|
|
405
|
-
│ ├── inject.ts # Context injection (BM25 + budget)
|
|
406
|
-
│ ├── migrate.ts # Cross-version structure migration
|
|
407
|
-
│ ├── search.ts # BM25 search engine
|
|
408
|
-
│ ├── session.ts # Session lifecycle (sleep/recover)
|
|
409
|
-
│ ├── types.ts # Memory system types
|
|
410
|
-
│ ├── vault.ts # Structured vault CRUD
|
|
411
|
-
│ └── __tests__/ # Unit tests (Vitest)
|
|
412
|
-
│ ├── inject.test.ts
|
|
413
|
-
│ ├── session.test.ts
|
|
414
|
-
│ ├── vault.test.ts
|
|
415
|
-
│ ├── search.test.ts
|
|
416
|
-
│ └── migrate.test.ts
|
|
417
|
-
│
|
|
418
|
-
├── .memory/ # Memory Bank (persistent, gitignored)
|
|
419
|
-
│ ├── _project.md # Global context — injected into all agents
|
|
420
|
-
│ ├── {agent-id}.md # Individual memory bank per agent
|
|
421
|
-
│ ├── conversations/ # Conversation history (JSON)
|
|
422
|
-
│ └── .vault/ # Structured vault and extraction queue
|
|
423
|
-
│
|
|
424
|
-
├── docs/ # Project documentation
|
|
425
|
-
│ ├── index.md # Main documentation index
|
|
426
|
-
│ ├── screenshots/ # UI screenshots
|
|
427
|
-
│ ├── project-overview-aiteam-x.md # Project overview (generated)
|
|
428
|
-
│ ├── architecture-aiteam-x.md # Detailed architecture (generated)
|
|
429
|
-
│ ├── api-contracts-aiteam-x.md # API contracts — 22 endpoints (generated)
|
|
430
|
-
│ ├── component-inventory-aiteam-x.md # Component inventory (generated)
|
|
431
|
-
│ ├── development-guide-aiteam-x.md # Development guide (generated)
|
|
432
|
-
│ ├── source-tree-analysis.md # Source tree analysis (generated)
|
|
433
|
-
│ ├── installation-guide.md # Full installation guide (original)
|
|
434
|
-
│ ├── architecture.md # System architecture (original)
|
|
435
|
-
│ ├── api-reference.md # Complete API reference (original)
|
|
436
|
-
│ ├── developer-guide.md # Developer guide (original)
|
|
437
|
-
│ ├── user-guide.md # End-user guide
|
|
438
|
-
│ ├── memory-system.md # Memory system technical architecture
|
|
439
|
-
│ ├── memory-system-guide.md # Memory system functional guide
|
|
440
|
-
│ ├── memory-system-comparison.md # Memory system comparative analysis
|
|
441
|
-
│ ├── agent-catalog.md # Complete BMAD agent catalog
|
|
442
|
-
│ ├── sprint-status.yaml # Current sprint status
|
|
443
|
-
│ └── superpowers/ # Future features (specs + plans)
|
|
444
|
-
│ ├── specs/ # Design documents
|
|
445
|
-
│ └── plans/ # Implementation plans
|
|
446
|
-
│
|
|
447
|
-
├── hooks/ # Custom React hooks
|
|
448
|
-
│ └── useVersionCheck.ts # Version check hook (NPM registry)
|
|
449
|
-
│
|
|
450
|
-
├── scripts/ # Utility scripts
|
|
451
|
-
│ ├── setup.mjs # Interactive setup wizard (6 steps)
|
|
452
|
-
│ ├── cli.mjs # CLI for npx 4aiteam-x (package entry point)
|
|
453
|
-
│ ├── safe-build.mjs # Safe build with pre-build validations
|
|
454
|
-
│ ├── clean-start.mjs # Dev server with cache cleanup
|
|
455
|
-
│ ├── import-conversations.mjs # History import into vault
|
|
456
|
-
│ ├── generate-chibi-logo.mjs # Chibi logo asset generation
|
|
457
|
-
│ └── crop-avatars.mjs # Avatar cropping for image-based themes
|
|
458
|
-
│
|
|
459
|
-
├── aiteam.config.example.json # Configuration example (reference)
|
|
460
|
-
├── .cursor/ # Cursor IDE rules and skills
|
|
461
|
-
│ └── rules/bmad/ # BMAD rules (.mdc): agents and workflows
|
|
462
|
-
│
|
|
463
|
-
├── package.json
|
|
464
|
-
├── tsconfig.json
|
|
465
|
-
├── next.config.ts
|
|
466
|
-
└── .gitignore
|
|
467
|
-
```
|
|
468
|
-
|
|
469
|
-
---
|
|
470
|
-
|
|
471
|
-
## Documentation
|
|
472
|
-
|
|
473
|
-
### Generated Documentation (document-project workflow)
|
|
474
|
-
|
|
475
|
-
| Document | Level | Description |
|
|
476
|
-
|----------|-------|-------------|
|
|
477
|
-
| [Documentation Index](docs/index.md) | All | Main entry point for all documentation |
|
|
478
|
-
| [Project Overview](docs/project-overview-aiteam-x.md) | Executive | Executive summary, stack, metrics, and features |
|
|
479
|
-
| [Detailed Architecture](docs/architecture-aiteam-x.md) | Architectural | Patterns, decisions, diagrams, and layers |
|
|
480
|
-
| [API Contracts](docs/api-contracts-aiteam-x.md) | Technical | 22 endpoints with request/response schemas |
|
|
481
|
-
| [Component Inventory](docs/component-inventory-aiteam-x.md) | Technical | ~49 components, hierarchy, state, and patterns |
|
|
482
|
-
| [Development Guide](docs/development-guide-aiteam-x.md) | Developer | Setup, commands, conventions, and troubleshooting |
|
|
483
|
-
| [Source Code Analysis](docs/source-tree-analysis.md) | Technical | Annotated structure with purpose of each directory |
|
|
484
|
-
|
|
485
|
-
### Original Documentation
|
|
486
|
-
|
|
487
|
-
| Document | Level | Description |
|
|
488
|
-
|----------|-------|-------------|
|
|
489
|
-
| [Installation Guide](docs/installation-guide.md) | Beginner | Step-by-step installation, setup wizard, troubleshooting |
|
|
490
|
-
| [Architecture](docs/architecture.md) | Technical/Architectural | Diagrams, data flows, design decisions |
|
|
491
|
-
| [API Reference](docs/api-reference.md) | Technical | Endpoints, parameters, request/response examples |
|
|
492
|
-
| [Developer Guide](docs/developer-guide.md) | Developer | Setup, conventions, how to contribute |
|
|
493
|
-
| [User Guide](docs/user-guide.md) | End User | How to use the dashboard, interact with agents, Memory Vault |
|
|
494
|
-
| [Memory System (technical)](docs/memory-system.md) | Technical/Conceptual | Layered architecture of the memory system |
|
|
495
|
-
| [Memory Guide (functional)](docs/memory-system-guide.md) | End User | How to use the Memory Vault, case studies, best practices |
|
|
496
|
-
| [System Comparison](docs/memory-system-comparison.md) | Technical | Comparative analysis of memory systems |
|
|
497
|
-
| [Agent Catalog](docs/agent-catalog.md) | Reference | All agents, specialties, and how to work with each one |
|
|
498
|
-
|
|
499
|
-
---
|
|
500
|
-
|
|
501
|
-
## BMAD Agents
|
|
502
|
-
|
|
503
|
-
The system automatically discovers agents from `bmad/_cfg/agent-manifest.csv`. The default installation includes 14 agents:
|
|
504
|
-
|
|
505
|
-
| Persona | Role | Module |
|
|
506
|
-
|---------|------|--------|
|
|
507
|
-
| **BMad Master** | Main orchestrator, knowledge custodian | core |
|
|
508
|
-
| **BMad Builder** | BMAD module, agent, and workflow creation | core |
|
|
509
|
-
| **Mary** | Business Analyst — research and business requirements | bmm |
|
|
510
|
-
| **John** | Product Manager — PRD, epics, product management | bmm |
|
|
511
|
-
| **Winston** | Architect — system architecture and tech spec | bmm |
|
|
512
|
-
| **Sally** | UX Designer — experience and interface design | bmm |
|
|
513
|
-
| **Bob** | Scrum Master — sprint planning and code review | bmm |
|
|
514
|
-
| **Amelia** | Developer — story and feature implementation | bmm |
|
|
515
|
-
| **Murat** | Test Architect — testing strategy and design | bmm |
|
|
516
|
-
| **Paige** | Tech Writer — technical documentation and knowledge | bmm |
|
|
517
|
-
| **Cloud Dragonborn** | Game Architect — game architecture and systems | bmgd |
|
|
518
|
-
| **Samus Shepard** | Game Designer — GDD, narrative, and game design | bmgd |
|
|
519
|
-
| **Link Freeman** | Game Developer — game implementation | bmgd |
|
|
520
|
-
| **Max** | Game Scrum Master — agile management for game dev | bmgd |
|
|
521
|
-
|
|
522
|
-
> See the [Agent Catalog](docs/agent-catalog.md) for details on each agent's specialties and commands.
|
|
523
|
-
|
|
524
|
-
---
|
|
525
|
-
|
|
526
|
-
## Configuration
|
|
527
|
-
|
|
528
|
-
4AITEAM-X uses a local `aiteam.config.json` file (gitignored) generated by `npm run setup`. For advanced configuration, create a `.env.local`:
|
|
529
|
-
|
|
530
|
-
```env
|
|
531
|
-
# Alternate path to the BMAD installation
|
|
532
|
-
# Useful for: BMAD in another directory, CI/CD, multiple projects
|
|
533
|
-
AITEAM_BMAD_ROOT=/path/to/your/bmad-project
|
|
534
|
-
|
|
535
|
-
# Overrides the memory directory (useful for testing)
|
|
536
|
-
MEMORY_DIR_OVERRIDE=/custom/path/.memory
|
|
537
|
-
```
|
|
538
|
-
|
|
539
|
-
**Configuration priority for `bmadRoot`:**
|
|
540
|
-
```
|
|
541
|
-
AITEAM_BMAD_ROOT (env var) > aiteam.config.json > "./" (default)
|
|
542
|
-
```
|
|
543
|
-
|
|
544
|
-
See the [Installation Guide](docs/installation-guide.md) for all configuration scenarios.
|
|
545
|
-
|
|
546
|
-
---
|
|
547
|
-
|
|
548
|
-
## Contributing
|
|
549
|
-
|
|
550
|
-
1. Fork the repository
|
|
551
|
-
2. Create a branch from `develop` (`git checkout -b feature/my-feature develop`)
|
|
552
|
-
3. Make your changes following project conventions
|
|
553
|
-
4. Ensure `npm run lint` and `npm run build` pass without errors
|
|
554
|
-
5. Open a Pull Request to `develop`
|
|
555
|
-
|
|
556
|
-
> Report bugs or suggest improvements? Open an [issue on GitHub](https://github.com/INOSX/AITeam/issues).
|
|
557
|
-
|
|
558
|
-
See the [Developer Guide](docs/developer-guide.md) for code conventions, commit patterns, and architecture details.
|
|
559
|
-
|
|
560
|
-
---
|
|
561
|
-
|
|
562
|
-
## License
|
|
563
|
-
|
|
564
|
-
This project is distributed under the MIT License. See [LICENSE](LICENSE) for details.
|
|
565
|
-
|
|
566
|
-
---
|
|
567
|
-
|
|
568
|
-
## Author
|
|
569
|
-
|
|
570
|
-
**Mario Mayerle (MaMFLux)** — [INOSX](https://inosx.com)
|
|
571
|
-
|
|
572
|
-
---
|
|
573
|
-
|
|
574
|
-
*Built with the BMAD Method — where AI agents work as a team.* | v0.14.1
|
|
1
|
+
# English README location
|
|
2
|
+
|
|
3
|
+
The canonical **English** project README is **[README.md](./README.md)** at the repository root.
|
|
4
|
+
|
|
5
|
+
For **Portuguese**, see **[README.pt.md](./README.pt.md)**.
|
|
6
|
+
|
|
7
|
+
This file is kept so existing links to `README.en.md` continue to work.
|