orchestrix 16.0.2 → 16.0.3
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.md +204 -43
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,80 +1,241 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Orchestrix
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
**One command to install multi-agent AI infrastructure into any project.**
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
[English](#english) | [中文](#中文)
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<a href="https://www.npmjs.com/package/orchestrix"><img src="https://img.shields.io/npm/v/orchestrix.svg" alt="npm version"></a>
|
|
9
|
+
<a href="https://www.npmjs.com/package/orchestrix"><img src="https://img.shields.io/npm/dm/orchestrix.svg" alt="npm downloads"></a>
|
|
10
|
+
<a href="https://github.com/dorayo/orchestrix/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/orchestrix.svg" alt="license"></a>
|
|
11
|
+
<a href="https://nodejs.org"><img src="https://img.shields.io/node/v/orchestrix.svg" alt="node version"></a>
|
|
12
|
+
</p>
|
|
6
13
|
|
|
7
14
|
```bash
|
|
8
15
|
npx orchestrix install
|
|
9
16
|
```
|
|
10
17
|
|
|
11
|
-
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
<a id="english"></a>
|
|
21
|
+
|
|
22
|
+
## English
|
|
23
|
+
|
|
24
|
+
### What is Orchestrix?
|
|
12
25
|
|
|
13
|
-
|
|
26
|
+
Orchestrix is a multi-agent framework that turns your coding assistant into a coordinated team. One Developer, one Scrum Master, one QA Engineer, one Architect — each running in its own terminal, automatically handing off work to one another.
|
|
14
27
|
|
|
15
|
-
|
|
16
|
-
|------|---------|
|
|
17
|
-
| `.claude/commands/o.md` | `/o dev`, `/o sm` — activate agents |
|
|
18
|
-
| `.claude/commands/o-help.md` | `/o-help` — list available agents |
|
|
19
|
-
| `.claude/commands/o-status.md` | `/o-status` — check server status |
|
|
20
|
-
| `.mcp.json` | MCP Server configuration (merged with existing) |
|
|
21
|
-
| `.orchestrix-core/core-config.yaml` | Project configuration |
|
|
22
|
-
| `.orchestrix-core/scripts/start-orchestrix.sh` | tmux multi-agent session launcher |
|
|
23
|
-
| `.orchestrix-core/scripts/handoff-detector.sh` | Auto HANDOFF routing between agents |
|
|
24
|
-
| `.claude/settings.local.json` | Claude Code Stop hook for HANDOFF detection |
|
|
25
|
-
| `.env.local` | License key storage (gitignored) |
|
|
28
|
+
This CLI installs all the infrastructure needed to make that happen.
|
|
26
29
|
|
|
27
|
-
|
|
30
|
+
### Quick Start
|
|
28
31
|
|
|
29
32
|
```bash
|
|
30
|
-
|
|
31
|
-
npx orchestrix
|
|
32
|
-
npx orchestrix upgrade # Upgrade to latest version
|
|
33
|
-
npx orchestrix uninstall # Remove Orchestrix files
|
|
33
|
+
cd your-project
|
|
34
|
+
npx orchestrix install
|
|
34
35
|
```
|
|
35
36
|
|
|
36
|
-
|
|
37
|
+
You'll be prompted for your license key. Once done, open the project in [Claude Code](https://claude.ai/download) and type `/o dev` to activate your first agent.
|
|
38
|
+
|
|
39
|
+
### What Gets Installed
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
your-project/
|
|
43
|
+
├── .claude/
|
|
44
|
+
│ ├── commands/
|
|
45
|
+
│ │ ├── o.md # /o dev, /o sm — activate agents
|
|
46
|
+
│ │ ├── o-help.md # /o-help — list agents
|
|
47
|
+
│ │ └── o-status.md # /o-status — check status
|
|
48
|
+
│ └── settings.local.json # Stop hook for HANDOFF detection
|
|
49
|
+
├── .orchestrix-core/
|
|
50
|
+
│ ├── core-config.yaml # Project configuration
|
|
51
|
+
│ └── scripts/
|
|
52
|
+
│ ├── start-orchestrix.sh # tmux 4-agent launcher
|
|
53
|
+
│ └── handoff-detector.sh # Auto HANDOFF routing
|
|
54
|
+
├── .mcp.json # MCP Server config (merged)
|
|
55
|
+
└── .env.local # License key (gitignored)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Commands
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
npx orchestrix install # Install into current project
|
|
62
|
+
npx orchestrix doctor # Health check
|
|
63
|
+
npx orchestrix upgrade # Upgrade to latest
|
|
64
|
+
npx orchestrix uninstall # Clean removal
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
#### Install Options
|
|
37
68
|
|
|
38
69
|
| Flag | Description |
|
|
39
70
|
|------|-------------|
|
|
40
|
-
| `--key <KEY>` |
|
|
41
|
-
| `--offline` | Use
|
|
42
|
-
| `--force` | Overwrite all files
|
|
43
|
-
| `--no-hooks` | Skip Stop hook
|
|
44
|
-
| `--no-scripts` | Skip tmux scripts
|
|
71
|
+
| `--key <KEY>` | Provide license key (skip prompt) |
|
|
72
|
+
| `--offline` | Use bundled files only, no network |
|
|
73
|
+
| `--force` | Overwrite all files |
|
|
74
|
+
| `--no-hooks` | Skip Claude Code Stop hook |
|
|
75
|
+
| `--no-scripts` | Skip tmux automation scripts |
|
|
45
76
|
| `--no-mcp` | Skip .mcp.json modification |
|
|
46
77
|
|
|
47
|
-
|
|
78
|
+
### Agent Activation
|
|
48
79
|
|
|
49
|
-
|
|
80
|
+
After installation, use these commands in Claude Code:
|
|
50
81
|
|
|
51
82
|
```
|
|
52
|
-
/o dev #
|
|
53
|
-
/o sm #
|
|
54
|
-
/o qa #
|
|
55
|
-
/o architect #
|
|
56
|
-
/o
|
|
83
|
+
/o dev # Full Stack Developer
|
|
84
|
+
/o sm # Scrum Master
|
|
85
|
+
/o qa # QA Engineer
|
|
86
|
+
/o architect # Solution Architect
|
|
87
|
+
/o pm # Product Manager
|
|
88
|
+
/o po # Product Owner
|
|
89
|
+
/o analyst # Business Analyst
|
|
90
|
+
/o ux-expert # UX Expert
|
|
91
|
+
/o-help # Show all agents
|
|
57
92
|
```
|
|
58
93
|
|
|
59
94
|
### tmux Multi-Agent Automation
|
|
60
95
|
|
|
61
|
-
|
|
96
|
+
Run 4 agents in parallel with automatic work handoff:
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
bash .orchestrix-core/scripts/start-orchestrix.sh
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
This creates a tmux session with 4 windows:
|
|
103
|
+
|
|
104
|
+
| Window | Agent | Role |
|
|
105
|
+
|--------|-------|------|
|
|
106
|
+
| 0 | Architect | System design, tech decisions |
|
|
107
|
+
| 1 | SM | Story management, workflow coordination |
|
|
108
|
+
| 2 | Dev | Implementation, debugging |
|
|
109
|
+
| 3 | QA | Testing, quality verification |
|
|
110
|
+
|
|
111
|
+
When one agent finishes and issues a HANDOFF, the `handoff-detector.sh` hook automatically routes the command to the target agent's window.
|
|
112
|
+
|
|
113
|
+
### Design Principles
|
|
114
|
+
|
|
115
|
+
- **Smart merge** — `.mcp.json` and `settings.local.json` are deep-merged. Your existing config is never lost.
|
|
116
|
+
- **Idempotent** — Run `install` as many times as you want. No duplicate hooks, no overwritten customizations.
|
|
117
|
+
- **Offline ready** — `--offline` installs from bundled files. Works behind firewalls.
|
|
118
|
+
- **Zero dependencies** — Pure Node.js built-ins. No `node_modules` bloat.
|
|
119
|
+
|
|
120
|
+
### Related Projects
|
|
121
|
+
|
|
122
|
+
| Project | Description |
|
|
123
|
+
|---------|-------------|
|
|
124
|
+
| [Orchestrix MCP Server](https://github.com/dorayo/orchestrix-mcp-server) | Central server for agent definitions and configurations |
|
|
125
|
+
| [orchestrix-yuri](https://www.npmjs.com/package/orchestrix-yuri) | Meta-orchestrator — project lifecycle management with memory |
|
|
126
|
+
| [orchestrix-starter](https://github.com/dorayo/orchestrix-starter) | `/create-project` skill for scaffolding new projects |
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
<a id="中文"></a>
|
|
131
|
+
|
|
132
|
+
## 中文
|
|
133
|
+
|
|
134
|
+
### Orchestrix 是什么？
|
|
135
|
+
|
|
136
|
+
Orchestrix 是一个多 Agent 协作框架，将你的编程助手变成一支协调有序的团队。一个 Developer、一个 Scrum Master、一个 QA Engineer、一个 Architect —— 各自运行在独立终端中，通过 HANDOFF 机制自动交接工作。
|
|
137
|
+
|
|
138
|
+
本 CLI 工具一键安装所有基础设施。
|
|
139
|
+
|
|
140
|
+
### 快速开始
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
cd your-project
|
|
144
|
+
npx orchestrix install
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
按提示输入 License Key 即可完成安装。然后在 [Claude Code](https://claude.ai/download) 中打开项目，输入 `/o dev` 激活你的第一个 Agent。
|
|
148
|
+
|
|
149
|
+
### 安装了哪些文件
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
your-project/
|
|
153
|
+
├── .claude/
|
|
154
|
+
│ ├── commands/
|
|
155
|
+
│ │ ├── o.md # /o dev, /o sm — 激活 Agent
|
|
156
|
+
│ │ ├── o-help.md # /o-help — 查看可用 Agent
|
|
157
|
+
│ │ └── o-status.md # /o-status — 查看状态
|
|
158
|
+
│ └── settings.local.json # Claude Code Stop Hook（HANDOFF 检测）
|
|
159
|
+
├── .orchestrix-core/
|
|
160
|
+
│ ├── core-config.yaml # 项目配置
|
|
161
|
+
│ └── scripts/
|
|
162
|
+
│ ├── start-orchestrix.sh # tmux 四 Agent 启动器
|
|
163
|
+
│ └── handoff-detector.sh # HANDOFF 自动路由
|
|
164
|
+
├── .mcp.json # MCP Server 配置（智能合并）
|
|
165
|
+
└── .env.local # License Key 存储（已 gitignore）
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### 命令
|
|
169
|
+
|
|
170
|
+
```bash
|
|
171
|
+
npx orchestrix install # 安装到当前项目
|
|
172
|
+
npx orchestrix doctor # 健康检查
|
|
173
|
+
npx orchestrix upgrade # 升级到最新版本
|
|
174
|
+
npx orchestrix uninstall # 卸载
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
#### 安装选项
|
|
178
|
+
|
|
179
|
+
| 参数 | 说明 |
|
|
180
|
+
|------|------|
|
|
181
|
+
| `--key <KEY>` | 指定 License Key（跳过交互提示） |
|
|
182
|
+
| `--offline` | 离线模式，使用内置文件（不联网） |
|
|
183
|
+
| `--force` | 强制覆盖所有文件 |
|
|
184
|
+
| `--no-hooks` | 跳过 Claude Code Stop Hook |
|
|
185
|
+
| `--no-scripts` | 跳过 tmux 自动化脚本 |
|
|
186
|
+
| `--no-mcp` | 跳过 .mcp.json 修改 |
|
|
187
|
+
|
|
188
|
+
### Agent 激活
|
|
189
|
+
|
|
190
|
+
安装完成后，在 Claude Code 中使用：
|
|
191
|
+
|
|
192
|
+
```
|
|
193
|
+
/o dev # 全栈开发工程师
|
|
194
|
+
/o sm # Scrum Master
|
|
195
|
+
/o qa # QA 测试工程师
|
|
196
|
+
/o architect # 系统架构师
|
|
197
|
+
/o pm # 产品经理
|
|
198
|
+
/o po # 产品负责人
|
|
199
|
+
/o analyst # 商业分析师
|
|
200
|
+
/o ux-expert # UX 设计专家
|
|
201
|
+
/o-help # 查看所有 Agent
|
|
202
|
+
```
|
|
203
|
+
|
|
204
|
+
### tmux 多 Agent 自动化
|
|
205
|
+
|
|
206
|
+
四个 Agent 并行运行，自动交接工作：
|
|
62
207
|
|
|
63
208
|
```bash
|
|
64
209
|
bash .orchestrix-core/scripts/start-orchestrix.sh
|
|
65
210
|
```
|
|
66
211
|
|
|
67
|
-
|
|
212
|
+
创建一个 tmux 会话，包含 4 个窗口：
|
|
213
|
+
|
|
214
|
+
| 窗口 | Agent | 职责 |
|
|
215
|
+
|------|-------|------|
|
|
216
|
+
| 0 | Architect | 系统设计、技术决策 |
|
|
217
|
+
| 1 | SM | Story 管理、工作流协调 |
|
|
218
|
+
| 2 | Dev | 编码实现、调试 |
|
|
219
|
+
| 3 | QA | 测试、质量验证 |
|
|
220
|
+
|
|
221
|
+
当某个 Agent 完成工作并发出 HANDOFF 指令时，`handoff-detector.sh` 会自动将命令路由到目标 Agent 的窗口。
|
|
222
|
+
|
|
223
|
+
### 设计理念
|
|
224
|
+
|
|
225
|
+
- **智能合并** — `.mcp.json` 和 `settings.local.json` 采用深度合并，已有配置永远不会丢失。
|
|
226
|
+
- **幂等安装** — 重复运行 `install` 完全安全，不会产生重复 Hook 或覆盖你定制过的配置。
|
|
227
|
+
- **离线就绪** — `--offline` 从内置文件安装，防火墙内也能用。
|
|
228
|
+
- **零依赖** — 纯 Node.js 内建模块，无 `node_modules` 膨胀。
|
|
68
229
|
|
|
69
|
-
|
|
70
|
-
- **Idempotent**: Safe to run multiple times. Won't duplicate hooks or overwrite customized `core-config.yaml`.
|
|
71
|
-
- **Offline ready**: Use `--offline` to install from bundled files without network access.
|
|
72
|
-
- **Zero dependencies**: Pure Node.js built-ins only.
|
|
230
|
+
### 相关项目
|
|
73
231
|
|
|
74
|
-
|
|
232
|
+
| 项目 | 说明 |
|
|
233
|
+
|------|------|
|
|
234
|
+
| [Orchestrix MCP Server](https://github.com/dorayo/orchestrix-mcp-server) | Agent 定义和配置的中央服务器 |
|
|
235
|
+
| [orchestrix-yuri](https://www.npmjs.com/package/orchestrix-yuri) | 元编排器 — 带记忆的项目全生命周期管理 |
|
|
236
|
+
| [orchestrix-starter](https://github.com/dorayo/orchestrix-starter) | `/create-project` 技能，用于脚手架创建新项目 |
|
|
75
237
|
|
|
76
|
-
|
|
77
|
-
- [orchestrix-yuri](https://www.npmjs.com/package/orchestrix-yuri) — Meta-orchestrator for project lifecycle management
|
|
238
|
+
---
|
|
78
239
|
|
|
79
240
|
## License
|
|
80
241
|
|