aiteam-x 0.14.1 → 0.14.2
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/README.en.md +207 -58
- package/README.md +329 -180
- package/package.json +3 -1
- package/scripts/cli.mjs +8 -8
package/README.en.md
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
<p align="right">
|
|
2
|
-
<a href="README.md">
|
|
2
|
+
<a href="README.md">Português</a> | <strong>English</strong>
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
5
|
# AITeam Team Overview
|
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
[](LICENSE)
|
|
15
15
|
|
|
16
16
|
```bash
|
|
17
|
-
npx
|
|
17
|
+
npx 4aiteam-x@latest
|
|
18
18
|
```
|
|
19
19
|
|
|
20
20
|
---
|
|
@@ -23,11 +23,15 @@ npx aiteam-x@latest
|
|
|
23
23
|
|
|
24
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
25
|
|
|
26
|
-
- **Visualize** each agent's status and location in real time
|
|
27
|
-
- **
|
|
28
|
-
- **
|
|
29
|
-
- **
|
|
30
|
-
- **
|
|
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)
|
|
31
35
|
|
|
32
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.
|
|
33
37
|
|
|
@@ -69,23 +73,54 @@ The project uses the **BMAD Method** as the agent framework, natively integratin
|
|
|
69
73
|
|
|
70
74
|
## Key Features
|
|
71
75
|
|
|
72
|
-
### Pixel Art Dashboard
|
|
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
|
|
73
80
|
- Shared rooms: **Jarvis Office**, **Kitchen** — with agent activity context
|
|
74
|
-
- Individual workspace grid per agent with module indicators (BMGD / BMM / CORE)
|
|
75
|
-
- Pixel
|
|
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
|
|
76
83
|
- Bottom bar with compact avatars and sprint timeline with granular per-story progress
|
|
77
|
-
- Day/night cycle and ambient effects
|
|
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
|
|
78
86
|
|
|
79
87
|
### Agent Interaction
|
|
80
88
|
- Agent selection (click) or multi-selection (Ctrl+click) for batch commands
|
|
81
|
-
-
|
|
82
|
-
-
|
|
83
|
-
-
|
|
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
|
|
84
94
|
- **Copy button**: appears on hover over agent responses for one-click copy
|
|
85
95
|
- **Context menu**: right-click on any agent to see agent-specific MDC commands
|
|
86
96
|
- Stop button to cancel ongoing processing
|
|
87
97
|
- Conversation history persisted across reloads
|
|
88
|
-
-
|
|
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
|
|
89
124
|
|
|
90
125
|
### Model Selector & Filters
|
|
91
126
|
- **Model Bar**: LLM model selection applied to all agents
|
|
@@ -99,6 +134,7 @@ The project uses the **BMAD Method** as the agent framework, natively integratin
|
|
|
99
134
|
- Automatic discovery of available models via ACP session `configOptions`
|
|
100
135
|
- Per-session model switching via `session/set_config_option`
|
|
101
136
|
- Persistent ACP process with 30-min session TTL and automatic reconnection
|
|
137
|
+
- Streaming tool calls with rich metadata (type, title, summarized output)
|
|
102
138
|
- Error fallback with actionable messages for the user
|
|
103
139
|
|
|
104
140
|
### BMAD Orchestration
|
|
@@ -107,16 +143,29 @@ The project uses the **BMAD Method** as the agent framework, natively integratin
|
|
|
107
143
|
- Session state persisted on disk and synchronized via SSE
|
|
108
144
|
- Per-agent message and token metrics
|
|
109
145
|
|
|
110
|
-
### Persistent Memory System (v2.
|
|
146
|
+
### Persistent Memory System (v2.2)
|
|
111
147
|
- **Memory Vault**: full visual panel with 5 categories (decisions, lessons, tasks, projects, handoffs)
|
|
112
148
|
- **Auto-extract via LLM**: when closing a session, the system analyzes the conversation and automatically extracts structured memories
|
|
113
149
|
- **Badge 🤖 llm**: automatically extracted entries are flagged for 10 minutes with veto option
|
|
114
150
|
- **BM25 Search**: relevance-based semantic search within each agent's vault
|
|
115
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
|
|
116
154
|
- **Auto-save**: conversations saved every 30s + save on unload via `sendBeacon`
|
|
117
155
|
- **Session Checkpoint**: history preserved even across unexpected restarts
|
|
118
156
|
- **Shared Memory**: `_project.md` injected into all agents as global context
|
|
119
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
|
+
|
|
120
169
|
### Portability & Installation (v1.0)
|
|
121
170
|
- **Dynamic Discovery**: automatically detects BMAD agents via CSV/YAML — no hardcoding
|
|
122
171
|
- **Cross-platform**: works on Windows, macOS, and Linux
|
|
@@ -133,14 +182,18 @@ The project uses the **BMAD Method** as the agent framework, natively integratin
|
|
|
133
182
|
|-------|-----------|---------|
|
|
134
183
|
| Framework | Next.js (App Router) | 15.x |
|
|
135
184
|
| UI | React | 19.x |
|
|
185
|
+
| 3D Engine | Three.js + React Three Fiber + Drei | 0.183 / 9.5 / 10.7 |
|
|
136
186
|
| Language | TypeScript | 5.x |
|
|
137
|
-
| Styling | CSS custom (
|
|
187
|
+
| Styling | CSS custom (design system with 4 themes) | — |
|
|
138
188
|
| Font | VT323 (Google Fonts) | — |
|
|
139
|
-
| Backend | Next.js API Routes + SSE | — |
|
|
140
|
-
|
|
|
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 |
|
|
141
193
|
| Agents | Cursor Agent CLI + ACP | latest |
|
|
142
194
|
| Protocol | ACP (JSON-RPC 2.0 / stdio) | v1 |
|
|
143
195
|
| Parsing | yaml (npm) | 2.8.x |
|
|
196
|
+
| Tests | Vitest + v8 coverage | 4.x |
|
|
144
197
|
| Agent Framework | BMAD Method | — |
|
|
145
198
|
|
|
146
199
|
---
|
|
@@ -163,13 +216,13 @@ The project uses the **BMAD Method** as the agent framework, natively integratin
|
|
|
163
216
|
**Option 1 — One command (recommended):**
|
|
164
217
|
|
|
165
218
|
```bash
|
|
166
|
-
npx
|
|
219
|
+
npx 4aiteam-x@latest
|
|
167
220
|
```
|
|
168
221
|
|
|
169
222
|
Creates the project in the current directory (must be empty). Or specify a folder name:
|
|
170
223
|
|
|
171
224
|
```bash
|
|
172
|
-
npx
|
|
225
|
+
npx 4aiteam-x@latest my-project
|
|
173
226
|
```
|
|
174
227
|
|
|
175
228
|
The command downloads the template, installs dependencies, runs the setup wizard, and starts the server automatically.
|
|
@@ -203,18 +256,20 @@ The dashboard will be available at **http://localhost:3000**.
|
|
|
203
256
|
|---------|-------------|
|
|
204
257
|
| `npm run setup` | **Interactive setup wizard** (first install) |
|
|
205
258
|
| `npm run dev` | Start the development server (port 3000) |
|
|
206
|
-
| `npm run
|
|
259
|
+
| `npm run dev:clean` | Start with cache cleanup (resolves state issues) |
|
|
260
|
+
| `npm run build` | Generate the production build (with pre-build validations) |
|
|
207
261
|
| `npm run start` | Start the production server |
|
|
208
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) |
|
|
209
265
|
|
|
210
266
|
### Utility Scripts
|
|
211
267
|
|
|
212
268
|
| Script | Description |
|
|
213
269
|
|--------|-------------|
|
|
214
|
-
| `node scripts/extract-memories.mjs --all` | Extract memories from historical conversations via LLM |
|
|
215
|
-
| `node scripts/extract-memories.mjs --agent bmad-master` | Extract memories for a specific agent |
|
|
216
|
-
| `node scripts/extract-memories.mjs --all --dry-run` | Simulate extraction without saving |
|
|
217
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 |
|
|
218
273
|
|
|
219
274
|
> All scripts require the server running at `localhost:3000`.
|
|
220
275
|
|
|
@@ -225,82 +280,140 @@ The dashboard will be available at **http://localhost:3000**.
|
|
|
225
280
|
```
|
|
226
281
|
AITeam/
|
|
227
282
|
├── app/ # Next.js App Router
|
|
228
|
-
│ ├── api/ # API Routes (backend)
|
|
283
|
+
│ ├── api/ # API Routes (backend) — 22 endpoints
|
|
229
284
|
│ │ ├── acp/
|
|
230
285
|
│ │ │ └── models/route.ts # GET: available models via ACP
|
|
231
286
|
│ │ ├── agents/
|
|
232
287
|
│ │ │ ├── route.ts # GET: list agents with status
|
|
233
|
-
│ │ │ ├── command/route.ts # POST: send command via SSE (CLI or ACP)
|
|
288
|
+
│ │ │ ├── command/route.ts # POST: send command via SSE (CLI or ACP) + file diffs
|
|
234
289
|
│ │ │ └── menus/route.ts # GET: agent context menus
|
|
235
290
|
│ │ ├── bridge/route.ts # GET: ACP health check
|
|
236
291
|
│ │ ├── config/route.ts # GET: BMAD configuration
|
|
292
|
+
│ │ ├── files/
|
|
293
|
+
│ │ │ └── revert/route.ts # POST: revert file to original content (diff denial)
|
|
237
294
|
│ │ ├── memory/
|
|
238
295
|
│ │ │ ├── route.ts # GET/POST: memory and conversations (legacy)
|
|
239
296
|
│ │ │ ├── vault/route.ts # GET/POST/PUT/DELETE: structured vault
|
|
240
297
|
│ │ │ ├── search/route.ts # GET: BM25 search
|
|
241
298
|
│ │ │ ├── checkpoint/route.ts # POST: session checkpoint
|
|
242
|
-
│ │ │ ├──
|
|
243
|
-
│ │ │ └──
|
|
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
|
|
244
302
|
│ │ ├── session/
|
|
245
303
|
│ │ │ ├── route.ts # GET/POST: active session
|
|
246
304
|
│ │ │ └── stream/route.ts # GET: SSE for session changes
|
|
247
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
|
|
248
312
|
│ │ └── workflows/route.ts # GET: available workflows
|
|
249
313
|
│ ├── actions/
|
|
250
314
|
│ │ └── setup-save.ts # Server Action: saves aiteam.config.json
|
|
251
315
|
│ ├── setup/
|
|
252
316
|
│ │ ├── page.tsx # Setup page (health gate + Server Component)
|
|
253
317
|
│ │ └── SetupWizard.tsx # Animated 3-phase wizard (Client Component)
|
|
254
|
-
│ ├── globals.css #
|
|
318
|
+
│ ├── globals.css # Design system with 4 themes (800+ lines)
|
|
255
319
|
│ ├── layout.tsx # Root layout (VT323, pt-BR)
|
|
256
320
|
│ ├── error.tsx # Error boundary
|
|
257
321
|
│ └── page.tsx # Main page (health gate)
|
|
258
322
|
│
|
|
259
|
-
├── components/ # React Components
|
|
260
|
-
│ ├── rooms/ # Virtual office rooms
|
|
323
|
+
├── components/ # React Components (~49 files)
|
|
324
|
+
│ ├── rooms/ # Virtual office rooms (2D)
|
|
261
325
|
│ │ ├── ConferenceRoom.tsx
|
|
262
326
|
│ │ ├── JarvisOffice.tsx
|
|
263
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
|
|
264
334
|
│ ├── AgentContextMenu.tsx # Per-agent context menu
|
|
335
|
+
│ ├── AgentDetail.tsx # Detailed agent view
|
|
336
|
+
│ ├── AgentListItem.tsx # Sidebar list item
|
|
265
337
|
│ ├── AgentsProvider.tsx # Global Context Provider
|
|
338
|
+
│ ├── BottomBar.tsx # Bottom bar with avatars and sprint
|
|
339
|
+
│ ├── ChatDrawer.tsx # Resizable lateral chat drawer + inline diffs
|
|
266
340
|
│ ├── CommandPopup.tsx # Multi-agent popup
|
|
267
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
|
|
268
347
|
│ ├── FilterContext.tsx # Filter context (status + module)
|
|
269
|
-
│ ├── Layout.tsx #
|
|
270
|
-
│ ├── MainContent.tsx # Main orchestrator
|
|
348
|
+
│ ├── Layout.tsx # Main shell
|
|
349
|
+
│ ├── MainContent.tsx # Main orchestrator
|
|
271
350
|
│ ├── MarkdownRenderer.tsx # Custom Markdown renderer
|
|
272
351
|
│ ├── MemoryVault.tsx # Memory Vault dashboard (modal)
|
|
352
|
+
│ ├── MessageRenderer.tsx # Segmented renderer (MD, terminal, tools, thinking)
|
|
273
353
|
│ ├── ModelBar.tsx # Model selection bar and filters
|
|
274
|
-
│ ├── PixelAvatar.tsx # Pixel art SVG avatar
|
|
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
|
|
275
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)
|
|
276
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
|
|
277
372
|
│ ├── WorkspaceCell.tsx # Individual workspace cell
|
|
278
|
-
│
|
|
373
|
+
│ ├── WorkspaceGrid.tsx # Workspace grid
|
|
374
|
+
│ └── WorkspaceProps.tsx # Shared workspace props
|
|
279
375
|
│
|
|
280
376
|
├── lib/ # Business logic and utilities
|
|
281
377
|
│ ├── acp-client.ts # ACP client (JSON-RPC 2.0 over stdio)
|
|
282
378
|
│ ├── acp-manager.ts # ACP session manager
|
|
283
379
|
│ ├── aiteam-config.ts # Config loader (env var > file > defaults)
|
|
380
|
+
│ ├── diff.ts # Unified diff engine (computeUnifiedDiff)
|
|
284
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
|
|
285
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)
|
|
286
392
|
│ ├── bmad/ # BMAD Integration
|
|
287
393
|
│ │ ├── discovery.ts # Dynamic BMAD scanner + Cursor CLI detection
|
|
288
394
|
│ │ ├── agent-mapping.ts # BmadAgent -> Agent mapping
|
|
289
395
|
│ │ ├── chat-sessions.ts # Chat session persistence
|
|
396
|
+
│ │ ├── memory-bank.ts # Memory bank integration
|
|
290
397
|
│ │ ├── parse-agents.ts # agent-manifest.csv parser
|
|
291
398
|
│ │ ├── parse-config.ts # config.yaml parser
|
|
292
399
|
│ │ ├── parse-persona.ts # Persona (.mdc) parser
|
|
293
400
|
│ │ ├── parse-session.ts # Session state + SSE
|
|
294
401
|
│ │ ├── parse-sprint.ts # sprint-status.yaml parser
|
|
295
402
|
│ │ └── parse-workflows.ts # Workflows parser
|
|
296
|
-
│
|
|
297
|
-
│
|
|
298
|
-
│
|
|
299
|
-
│
|
|
300
|
-
│
|
|
301
|
-
│
|
|
302
|
-
│
|
|
303
|
-
│
|
|
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
|
|
304
417
|
│
|
|
305
418
|
├── .memory/ # Memory Bank (persistent, gitignored)
|
|
306
419
|
│ ├── _project.md # Global context — injected into all agents
|
|
@@ -309,21 +422,39 @@ AITeam/
|
|
|
309
422
|
│ └── .vault/ # Structured vault and extraction queue
|
|
310
423
|
│
|
|
311
424
|
├── docs/ # Project documentation
|
|
425
|
+
│ ├── index.md # Main documentation index
|
|
312
426
|
│ ├── screenshots/ # UI screenshots
|
|
313
|
-
│ ├──
|
|
314
|
-
│ ├── architecture.md
|
|
315
|
-
│ ├── api-
|
|
316
|
-
│ ├──
|
|
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)
|
|
317
437
|
│ ├── user-guide.md # End-user guide
|
|
318
438
|
│ ├── memory-system.md # Memory system technical architecture
|
|
319
439
|
│ ├── memory-system-guide.md # Memory system functional guide
|
|
440
|
+
│ ├── memory-system-comparison.md # Memory system comparative analysis
|
|
320
441
|
│ ├── agent-catalog.md # Complete BMAD agent catalog
|
|
321
|
-
│
|
|
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)
|
|
322
449
|
│
|
|
323
450
|
├── scripts/ # Utility scripts
|
|
324
451
|
│ ├── setup.mjs # Interactive setup wizard (6 steps)
|
|
325
|
-
│ ├──
|
|
326
|
-
│
|
|
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
|
|
327
458
|
│
|
|
328
459
|
├── aiteam.config.example.json # Configuration example (reference)
|
|
329
460
|
├── .cursor/ # Cursor IDE rules and skills
|
|
@@ -339,6 +470,20 @@ AITeam/
|
|
|
339
470
|
|
|
340
471
|
## Documentation
|
|
341
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
|
+
|
|
342
487
|
| Document | Level | Description |
|
|
343
488
|
|----------|-------|-------------|
|
|
344
489
|
| [Installation Guide](docs/installation-guide.md) | Beginner | Step-by-step installation, setup wizard, troubleshooting |
|
|
@@ -348,6 +493,7 @@ AITeam/
|
|
|
348
493
|
| [User Guide](docs/user-guide.md) | End User | How to use the dashboard, interact with agents, Memory Vault |
|
|
349
494
|
| [Memory System (technical)](docs/memory-system.md) | Technical/Conceptual | Layered architecture of the memory system |
|
|
350
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 |
|
|
351
497
|
| [Agent Catalog](docs/agent-catalog.md) | Reference | All agents, specialties, and how to work with each one |
|
|
352
498
|
|
|
353
499
|
---
|
|
@@ -379,7 +525,7 @@ The system automatically discovers agents from `bmad/_cfg/agent-manifest.csv`. T
|
|
|
379
525
|
|
|
380
526
|
## Configuration
|
|
381
527
|
|
|
382
|
-
|
|
528
|
+
4AITEAM-X uses a local `aiteam.config.json` file (gitignored) generated by `npm run setup`. For advanced configuration, create a `.env.local`:
|
|
383
529
|
|
|
384
530
|
```env
|
|
385
531
|
# Alternate path to the BMAD installation
|
|
@@ -401,12 +547,15 @@ See the [Installation Guide](docs/installation-guide.md) for all configuration s
|
|
|
401
547
|
|
|
402
548
|
## Contributing
|
|
403
549
|
|
|
404
|
-
1.
|
|
405
|
-
2.
|
|
406
|
-
3.
|
|
407
|
-
4.
|
|
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).
|
|
408
557
|
|
|
409
|
-
See the [Developer Guide](docs/developer-guide.md) for details.
|
|
558
|
+
See the [Developer Guide](docs/developer-guide.md) for code conventions, commit patterns, and architecture details.
|
|
410
559
|
|
|
411
560
|
---
|
|
412
561
|
|
|
@@ -422,4 +571,4 @@ This project is distributed under the MIT License. See [LICENSE](LICENSE) for de
|
|
|
422
571
|
|
|
423
572
|
---
|
|
424
573
|
|
|
425
|
-
*Built with the BMAD Method — where AI agents work as a team.*
|
|
574
|
+
*Built with the BMAD Method — where AI agents work as a team.* | v0.14.1
|