oh-my-claude-sisyphus 3.5.5 → 3.5.7
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 +58 -343
- package/commands/mcp-setup.md +75 -64
- package/commands/omc-setup.md +51 -0
- package/dist/__tests__/analytics/tokscale-adapter.test.d.ts +2 -0
- package/dist/__tests__/analytics/tokscale-adapter.test.d.ts.map +1 -0
- package/dist/__tests__/analytics/tokscale-adapter.test.js +79 -0
- package/dist/__tests__/analytics/tokscale-adapter.test.js.map +1 -0
- package/dist/analytics/cost-estimator.d.ts +14 -0
- package/dist/analytics/cost-estimator.d.ts.map +1 -1
- package/dist/analytics/cost-estimator.js +65 -0
- package/dist/analytics/cost-estimator.js.map +1 -1
- package/dist/analytics/index.d.ts +1 -0
- package/dist/analytics/index.d.ts.map +1 -1
- package/dist/analytics/index.js +4 -0
- package/dist/analytics/index.js.map +1 -1
- package/dist/analytics/query-engine.d.ts +3 -0
- package/dist/analytics/query-engine.d.ts.map +1 -1
- package/dist/analytics/query-engine.js +87 -0
- package/dist/analytics/query-engine.js.map +1 -1
- package/dist/analytics/token-tracker.d.ts +3 -0
- package/dist/analytics/token-tracker.d.ts.map +1 -1
- package/dist/analytics/token-tracker.js +89 -0
- package/dist/analytics/token-tracker.js.map +1 -1
- package/dist/analytics/tokscale-adapter.d.ts +71 -0
- package/dist/analytics/tokscale-adapter.d.ts.map +1 -0
- package/dist/analytics/tokscale-adapter.js +223 -0
- package/dist/analytics/tokscale-adapter.js.map +1 -0
- package/dist/analytics/types.d.ts +17 -0
- package/dist/analytics/types.d.ts.map +1 -1
- package/dist/analytics/types.js +5 -0
- package/dist/analytics/types.js.map +1 -1
- package/dist/cli/analytics.js +35 -0
- package/dist/cli/analytics.js.map +1 -1
- package/dist/cli/commands/agents.d.ts.map +1 -1
- package/dist/cli/commands/agents.js +4 -2
- package/dist/cli/commands/agents.js.map +1 -1
- package/dist/cli/commands/stats.d.ts.map +1 -1
- package/dist/cli/commands/stats.js +6 -1
- package/dist/cli/commands/stats.js.map +1 -1
- package/dist/cli/index.js +95 -35
- package/dist/cli/index.js.map +1 -1
- package/dist/cli/utils/tokscale-launcher.d.ts +18 -0
- package/dist/cli/utils/tokscale-launcher.d.ts.map +1 -0
- package/dist/cli/utils/tokscale-launcher.js +64 -0
- package/dist/cli/utils/tokscale-launcher.js.map +1 -0
- package/dist/features/auto-update.js +5 -5
- package/dist/features/auto-update.js.map +1 -1
- package/dist/hud/types.d.ts +6 -2
- package/dist/hud/types.d.ts.map +1 -1
- package/dist/hud/types.js.map +1 -1
- package/dist/hud/usage-api.d.ts.map +1 -1
- package/dist/hud/usage-api.js +13 -1
- package/dist/hud/usage-api.js.map +1 -1
- package/docs/ARCHITECTURE.md +80 -397
- package/docs/FEATURES.md +396 -1981
- package/docs/MIGRATION.md +4 -4
- package/docs/REFERENCE.md +545 -0
- package/docs/SYNC-SYSTEM.md +6 -6
- package/package.json +2 -1
- package/scripts/sync-metadata.ts +2 -2
- package/skills/mcp-setup/SKILL.md +63 -75
- package/skills/omc-setup/SKILL.md +51 -0
- package/docs/FULL-README.md +0 -1001
package/docs/MIGRATION.md
CHANGED
|
@@ -131,7 +131,7 @@ The package has been renamed to better reflect its purpose and improve discovera
|
|
|
131
131
|
npm install -g oh-my-claude-sisyphus
|
|
132
132
|
|
|
133
133
|
# New
|
|
134
|
-
npm install -g oh-my-
|
|
134
|
+
npm install -g oh-my-claude-sisyphus
|
|
135
135
|
```
|
|
136
136
|
|
|
137
137
|
### What Changed
|
|
@@ -302,7 +302,7 @@ npm uninstall -g oh-my-claude-sisyphus
|
|
|
302
302
|
#### 2. Install New Package
|
|
303
303
|
|
|
304
304
|
```bash
|
|
305
|
-
npm install -g oh-my-
|
|
305
|
+
npm install -g oh-my-claude-sisyphus
|
|
306
306
|
```
|
|
307
307
|
|
|
308
308
|
#### 3. Rename Local Project Directories
|
|
@@ -363,7 +363,7 @@ After migration, verify your setup:
|
|
|
363
363
|
|
|
364
364
|
1. **Check installation**:
|
|
365
365
|
```bash
|
|
366
|
-
npm list -g oh-my-
|
|
366
|
+
npm list -g oh-my-claude-sisyphus
|
|
367
367
|
```
|
|
368
368
|
|
|
369
369
|
2. **Verify directories exist**:
|
|
@@ -763,7 +763,7 @@ After upgrading, verify new features:
|
|
|
763
763
|
|
|
764
764
|
1. **Check installation**:
|
|
765
765
|
```bash
|
|
766
|
-
npm list -g oh-my-
|
|
766
|
+
npm list -g oh-my-claude-sisyphus
|
|
767
767
|
```
|
|
768
768
|
|
|
769
769
|
2. **Test ultrapilot**:
|
|
@@ -0,0 +1,545 @@
|
|
|
1
|
+
# Reference Documentation
|
|
2
|
+
|
|
3
|
+
Complete reference for oh-my-claudecode. For quick start, see the main [README.md](../README.md).
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## Table of Contents
|
|
8
|
+
|
|
9
|
+
- [Installation](#installation)
|
|
10
|
+
- [Configuration](#configuration)
|
|
11
|
+
- [Agents (32 Total)](#agents-32-total)
|
|
12
|
+
- [Skills (35 Total)](#skills-35-total)
|
|
13
|
+
- [Slash Commands](#slash-commands)
|
|
14
|
+
- [Hooks System](#hooks-system)
|
|
15
|
+
- [Magic Keywords](#magic-keywords)
|
|
16
|
+
- [Platform Support](#platform-support)
|
|
17
|
+
- [Troubleshooting](#troubleshooting)
|
|
18
|
+
- [Changelog](#changelog)
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Installation
|
|
23
|
+
|
|
24
|
+
Choose **ONE** installation method. Do not mix methods.
|
|
25
|
+
|
|
26
|
+
### Option A: Claude Code Plugin (Recommended)
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
# From terminal:
|
|
30
|
+
claude plugin install oh-my-claude-sisyphus
|
|
31
|
+
|
|
32
|
+
# Or from within Claude Code:
|
|
33
|
+
/oh-my-claudecode:plugin oh-my-claude-sisyphus
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Uses Node.js hooks from the plugin directory. Integrates directly with Claude Code's plugin system.
|
|
37
|
+
|
|
38
|
+
### Option B: Via npm (Windows & Cross-Platform)
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
npm install -g oh-my-claude-sisyphus
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
> **Windows Users**: This is the recommended installation method. Requires Node.js 20+.
|
|
45
|
+
|
|
46
|
+
### Option C: Curl One-Liner (Deprecated)
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
curl -fsSL https://raw.githubusercontent.com/Yeachan-Heo/oh-my-claudecode/main/scripts/install.sh | bash
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
> **Deprecated**: This method installs bash hooks to `~/.claude/` which can conflict with plugin installations. Use the plugin method above instead.
|
|
53
|
+
|
|
54
|
+
### Manual Install (macOS/Linux)
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
git clone https://github.com/Yeachan-Heo/oh-my-claude-sisyphus.git
|
|
58
|
+
cd oh-my-claude-sisyphus
|
|
59
|
+
chmod +x scripts/install.sh
|
|
60
|
+
./scripts/install.sh
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Requirements
|
|
64
|
+
|
|
65
|
+
- [Claude Code](https://docs.anthropic.com/claude-code) installed
|
|
66
|
+
- One of:
|
|
67
|
+
- **Claude Max/Pro subscription** (recommended for individuals)
|
|
68
|
+
- **Anthropic API key** (`ANTHROPIC_API_KEY` environment variable)
|
|
69
|
+
- **Windows**: Node.js 20+ (for npm installation)
|
|
70
|
+
- **macOS/Linux**: Bash shell (default) or Node.js 20+ (optional)
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Configuration
|
|
75
|
+
|
|
76
|
+
### Project-Scoped Configuration (Recommended)
|
|
77
|
+
|
|
78
|
+
Configure omc for the current project only:
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
/oh-my-claudecode:omc-setup
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
- Creates `./.claude/CLAUDE.md` in your current project
|
|
85
|
+
- Configuration applies only to this project
|
|
86
|
+
- Won't affect other projects or global settings
|
|
87
|
+
- **Safe**: Preserves your global CLAUDE.md
|
|
88
|
+
|
|
89
|
+
### Global Configuration
|
|
90
|
+
|
|
91
|
+
Configure omc for all Claude Code sessions:
|
|
92
|
+
|
|
93
|
+
```
|
|
94
|
+
/oh-my-claudecode:omc-setup
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
- Creates `~/.claude/CLAUDE.md` globally
|
|
98
|
+
- Configuration applies to all projects
|
|
99
|
+
- **Warning**: Completely overwrites existing `~/.claude/CLAUDE.md`
|
|
100
|
+
|
|
101
|
+
### What Configuration Enables
|
|
102
|
+
|
|
103
|
+
| Feature | Without | With omc Config |
|
|
104
|
+
|---------|---------|-----------------|
|
|
105
|
+
| Agent delegation | Manual only | Automatic based on task |
|
|
106
|
+
| Keyword detection | Disabled | ultrawork, search, analyze |
|
|
107
|
+
| Todo continuation | Basic | Enforced completion |
|
|
108
|
+
| Model routing | Default | Smart tier selection |
|
|
109
|
+
| Skill composition | None | Auto-combines skills |
|
|
110
|
+
|
|
111
|
+
### Configuration Precedence
|
|
112
|
+
|
|
113
|
+
If both configurations exist, **project-scoped takes precedence** over global:
|
|
114
|
+
|
|
115
|
+
```
|
|
116
|
+
./.claude/CLAUDE.md (project) → Overrides → ~/.claude/CLAUDE.md (global)
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### When to Re-run Setup
|
|
120
|
+
|
|
121
|
+
- **First time**: Run after installation (choose project or global)
|
|
122
|
+
- **After updates**: Re-run to get the latest configuration
|
|
123
|
+
- **Different machines**: Run on each machine where you use Claude Code
|
|
124
|
+
- **New projects**: Run `/oh-my-claudecode:omc-setup --local` in each project that needs omc
|
|
125
|
+
|
|
126
|
+
> **NOTE**: After updating the plugin (via `npm update`, `git pull`, or Claude Code's plugin update), you MUST re-run `/oh-my-claudecode:omc-setup` to apply the latest CLAUDE.md changes.
|
|
127
|
+
|
|
128
|
+
### Agent Customization
|
|
129
|
+
|
|
130
|
+
Edit agent files in `~/.claude/agents/` to customize behavior:
|
|
131
|
+
|
|
132
|
+
```yaml
|
|
133
|
+
---
|
|
134
|
+
name: architect
|
|
135
|
+
description: Your custom description
|
|
136
|
+
tools: Read, Grep, Glob, Bash, Edit
|
|
137
|
+
model: opus # or sonnet, haiku
|
|
138
|
+
---
|
|
139
|
+
|
|
140
|
+
Your custom system prompt here...
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Project-Level Config
|
|
144
|
+
|
|
145
|
+
Create `.claude/CLAUDE.md` in your project for project-specific instructions:
|
|
146
|
+
|
|
147
|
+
```markdown
|
|
148
|
+
# Project Context
|
|
149
|
+
|
|
150
|
+
This is a TypeScript monorepo using:
|
|
151
|
+
- Bun runtime
|
|
152
|
+
- React for frontend
|
|
153
|
+
- PostgreSQL database
|
|
154
|
+
|
|
155
|
+
## Conventions
|
|
156
|
+
- Use functional components
|
|
157
|
+
- All API routes in /src/api
|
|
158
|
+
- Tests alongside source files
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
## Agents (32 Total)
|
|
164
|
+
|
|
165
|
+
Always use `oh-my-claudecode:` prefix when calling via Task tool.
|
|
166
|
+
|
|
167
|
+
### By Domain and Tier
|
|
168
|
+
|
|
169
|
+
| Domain | LOW (Haiku) | MEDIUM (Sonnet) | HIGH (Opus) |
|
|
170
|
+
|--------|-------------|-----------------|-------------|
|
|
171
|
+
| **Analysis** | `architect-low` | `architect-medium` | `architect` |
|
|
172
|
+
| **Execution** | `executor-low` | `executor` | `executor-high` |
|
|
173
|
+
| **Search** | `explore` | `explore-medium` | `explore-high` |
|
|
174
|
+
| **Research** | `researcher-low` | `researcher` | - |
|
|
175
|
+
| **Frontend** | `designer-low` | `designer` | `designer-high` |
|
|
176
|
+
| **Docs** | `writer` | - | - |
|
|
177
|
+
| **Visual** | - | `vision` | - |
|
|
178
|
+
| **Planning** | - | - | `planner` |
|
|
179
|
+
| **Critique** | - | - | `critic` |
|
|
180
|
+
| **Pre-Planning** | - | - | `analyst` |
|
|
181
|
+
| **Testing** | - | `qa-tester` | `qa-tester-high` |
|
|
182
|
+
| **Security** | `security-reviewer-low` | - | `security-reviewer` |
|
|
183
|
+
| **Build** | `build-fixer-low` | `build-fixer` | - |
|
|
184
|
+
| **TDD** | `tdd-guide-low` | `tdd-guide` | - |
|
|
185
|
+
| **Code Review** | `code-reviewer-low` | - | `code-reviewer` |
|
|
186
|
+
| **Data Science** | `scientist-low` | `scientist` | `scientist-high` |
|
|
187
|
+
|
|
188
|
+
### Agent Selection Guide
|
|
189
|
+
|
|
190
|
+
| Task Type | Best Agent | Model |
|
|
191
|
+
|-----------|------------|-------|
|
|
192
|
+
| Quick code lookup | `explore` | haiku |
|
|
193
|
+
| Find files/patterns | `explore` or `explore-medium` | haiku/sonnet |
|
|
194
|
+
| Complex architectural search | `explore-high` | opus |
|
|
195
|
+
| Simple code change | `executor-low` | haiku |
|
|
196
|
+
| Feature implementation | `executor` | sonnet |
|
|
197
|
+
| Complex refactoring | `executor-high` | opus |
|
|
198
|
+
| Debug simple issue | `architect-low` | haiku |
|
|
199
|
+
| Debug complex issue | `architect` | opus |
|
|
200
|
+
| UI component | `designer` | sonnet |
|
|
201
|
+
| Complex UI system | `designer-high` | opus |
|
|
202
|
+
| Write docs/comments | `writer` | haiku |
|
|
203
|
+
| Research docs/APIs | `researcher` | sonnet |
|
|
204
|
+
| Analyze images/diagrams | `vision` | sonnet |
|
|
205
|
+
| Strategic planning | `planner` | opus |
|
|
206
|
+
| Review/critique plan | `critic` | opus |
|
|
207
|
+
| Pre-planning analysis | `analyst` | opus |
|
|
208
|
+
| Test CLI interactively | `qa-tester` | sonnet |
|
|
209
|
+
| Security review | `security-reviewer` | opus |
|
|
210
|
+
| Quick security scan | `security-reviewer-low` | haiku |
|
|
211
|
+
| Fix build errors | `build-fixer` | sonnet |
|
|
212
|
+
| Simple build fix | `build-fixer-low` | haiku |
|
|
213
|
+
| TDD workflow | `tdd-guide` | sonnet |
|
|
214
|
+
| Quick test suggestions | `tdd-guide-low` | haiku |
|
|
215
|
+
| Code review | `code-reviewer` | opus |
|
|
216
|
+
| Quick code check | `code-reviewer-low` | haiku |
|
|
217
|
+
| Data analysis/stats | `scientist` | sonnet |
|
|
218
|
+
| Quick data inspection | `scientist-low` | haiku |
|
|
219
|
+
| Complex ML/hypothesis | `scientist-high` | opus |
|
|
220
|
+
|
|
221
|
+
---
|
|
222
|
+
|
|
223
|
+
## Skills (35 Total)
|
|
224
|
+
|
|
225
|
+
### Core Skills
|
|
226
|
+
|
|
227
|
+
| Skill | Description | Manual Command |
|
|
228
|
+
|-------|-------------|----------------|
|
|
229
|
+
| `orchestrate` | Multi-agent orchestration mode | - |
|
|
230
|
+
| `autopilot` | Full autonomous execution from idea to working code | `/oh-my-claudecode:autopilot` |
|
|
231
|
+
| `ultrawork` | Maximum performance with parallel agents | `/oh-my-claudecode:ultrawork` |
|
|
232
|
+
| `ultrapilot` | Parallel autopilot with 3-5x speedup | `/oh-my-claudecode:ultrapilot` |
|
|
233
|
+
| `swarm` | N coordinated agents with task claiming | `/oh-my-claudecode:swarm` |
|
|
234
|
+
| `pipeline` | Sequential agent chaining | `/oh-my-claudecode:pipeline` |
|
|
235
|
+
| `ecomode` | Token-efficient parallel execution | `/oh-my-claudecode:ecomode` |
|
|
236
|
+
| `ralph` | Self-referential development until completion | `/oh-my-claudecode:ralph` |
|
|
237
|
+
| `ralph-init` | Initialize PRD for structured task tracking | `/oh-my-claudecode:ralph-init` |
|
|
238
|
+
| `ultraqa` | Autonomous QA cycling workflow | `/oh-my-claudecode:ultraqa` |
|
|
239
|
+
| `plan` | Start planning session | `/oh-my-claudecode:plan` |
|
|
240
|
+
| `ralplan` | Iterative planning (Planner+Architect+Critic) | `/oh-my-claudecode:ralplan` |
|
|
241
|
+
| `review` | Review work plans with critic | `/oh-my-claudecode:review` |
|
|
242
|
+
|
|
243
|
+
### Enhancement Skills
|
|
244
|
+
|
|
245
|
+
| Skill | Description | Manual Command |
|
|
246
|
+
|-------|-------------|----------------|
|
|
247
|
+
| `deepinit` | Hierarchical AGENTS.md codebase documentation | `/oh-my-claudecode:deepinit` |
|
|
248
|
+
| `deepsearch` | Thorough multi-strategy codebase search | `/oh-my-claudecode:deepsearch` |
|
|
249
|
+
| `analyze` | Deep analysis and investigation | `/oh-my-claudecode:analyze` |
|
|
250
|
+
| `research` | Parallel scientist orchestration | `/oh-my-claudecode:research` |
|
|
251
|
+
| `frontend-ui-ux` | Designer-turned-developer UI/UX expertise | (silent activation) |
|
|
252
|
+
| `git-master` | Git expert for atomic commits and history | (silent activation) |
|
|
253
|
+
| `tdd` | TDD enforcement: test-first development | `/oh-my-claudecode:tdd` |
|
|
254
|
+
| `learner` | Extract reusable skill from session | `/oh-my-claudecode:learner` |
|
|
255
|
+
|
|
256
|
+
### Utility Skills
|
|
257
|
+
|
|
258
|
+
| Skill | Description | Manual Command |
|
|
259
|
+
|-------|-------------|----------------|
|
|
260
|
+
| `note` | Save notes to compaction-resilient notepad | `/oh-my-claudecode:note` |
|
|
261
|
+
| `cancel` | Unified cancellation for all modes | `/oh-my-claudecode:cancel` |
|
|
262
|
+
| `omc-setup` | One-time setup wizard | `/oh-my-claudecode:omc-setup` |
|
|
263
|
+
| `doctor` | Diagnose and fix installation issues | `/oh-my-claudecode:doctor` |
|
|
264
|
+
| `help` | Show OMC usage guide | `/oh-my-claudecode:help` |
|
|
265
|
+
| `hud` | Configure HUD statusline | `/oh-my-claudecode:hud` |
|
|
266
|
+
| `release` | Automated release workflow | `/oh-my-claudecode:release` |
|
|
267
|
+
| `mcp-setup` | Configure MCP servers | `/oh-my-claudecode:mcp-setup` |
|
|
268
|
+
| `learn-about-omc` | Usage pattern analysis | `/oh-my-claudecode:learn-about-omc` |
|
|
269
|
+
|
|
270
|
+
---
|
|
271
|
+
|
|
272
|
+
## Slash Commands
|
|
273
|
+
|
|
274
|
+
All skills are available as slash commands with the prefix `/oh-my-claudecode:`.
|
|
275
|
+
|
|
276
|
+
| Command | Description |
|
|
277
|
+
|---------|-------------|
|
|
278
|
+
| `/oh-my-claudecode:orchestrate <task>` | Activate multi-agent orchestration mode |
|
|
279
|
+
| `/oh-my-claudecode:autopilot <task>` | Full autonomous execution |
|
|
280
|
+
| `/oh-my-claudecode:ultrawork <task>` | Maximum performance mode with parallel agents |
|
|
281
|
+
| `/oh-my-claudecode:ultrapilot <task>` | Parallel autopilot (3-5x faster) |
|
|
282
|
+
| `/oh-my-claudecode:swarm <N>:<agent> <task>` | Coordinated agent swarm |
|
|
283
|
+
| `/oh-my-claudecode:pipeline <stages>` | Sequential agent chaining |
|
|
284
|
+
| `/oh-my-claudecode:ecomode <task>` | Token-efficient parallel execution |
|
|
285
|
+
| `/oh-my-claudecode:ralph-init <task>` | Initialize PRD for structured task tracking |
|
|
286
|
+
| `/oh-my-claudecode:ralph <task>` | Self-referential loop until task completion |
|
|
287
|
+
| `/oh-my-claudecode:ultraqa <goal>` | Autonomous QA cycling workflow |
|
|
288
|
+
| `/oh-my-claudecode:plan <description>` | Start planning session |
|
|
289
|
+
| `/oh-my-claudecode:ralplan <description>` | Iterative planning with consensus |
|
|
290
|
+
| `/oh-my-claudecode:review [plan-path]` | Review a plan with critic |
|
|
291
|
+
| `/oh-my-claudecode:deepsearch <query>` | Thorough multi-strategy codebase search |
|
|
292
|
+
| `/oh-my-claudecode:deepinit [path]` | Index codebase with hierarchical AGENTS.md files |
|
|
293
|
+
| `/oh-my-claudecode:analyze <target>` | Deep analysis and investigation |
|
|
294
|
+
| `/oh-my-claudecode:research <topic>` | Parallel research orchestration |
|
|
295
|
+
| `/oh-my-claudecode:tdd <feature>` | TDD workflow enforcement |
|
|
296
|
+
| `/oh-my-claudecode:learner` | Extract reusable skill from session |
|
|
297
|
+
| `/oh-my-claudecode:note <content>` | Save notes to notepad.md |
|
|
298
|
+
| `/oh-my-claudecode:cancel` | Unified cancellation |
|
|
299
|
+
| `/oh-my-claudecode:omc-setup` | One-time setup wizard |
|
|
300
|
+
| `/oh-my-claudecode:doctor` | Diagnose and fix installation issues |
|
|
301
|
+
| `/oh-my-claudecode:help` | Show OMC usage guide |
|
|
302
|
+
| `/oh-my-claudecode:hud` | Configure HUD statusline |
|
|
303
|
+
| `/oh-my-claudecode:release` | Automated release workflow |
|
|
304
|
+
| `/oh-my-claudecode:mcp-setup` | Configure MCP servers |
|
|
305
|
+
|
|
306
|
+
---
|
|
307
|
+
|
|
308
|
+
## Hooks System
|
|
309
|
+
|
|
310
|
+
Oh-my-claudecode includes 19 lifecycle hooks that enhance Claude Code's behavior.
|
|
311
|
+
|
|
312
|
+
### Core Hooks
|
|
313
|
+
|
|
314
|
+
| Hook | Description |
|
|
315
|
+
|------|-------------|
|
|
316
|
+
| `rules-injector` | Dynamic rules injection with YAML frontmatter parsing |
|
|
317
|
+
| `omc-orchestrator` | Enforces orchestrator behavior and delegation |
|
|
318
|
+
| `auto-slash-command` | Automatic slash command detection and execution |
|
|
319
|
+
| `keyword-detector` | Magic keyword detection (ultrawork, search, analyze) |
|
|
320
|
+
| `ralph-loop` | Self-referential development loop management |
|
|
321
|
+
| `todo-continuation` | Ensures todo list completion |
|
|
322
|
+
| `notepad` | Compaction-resilient memory system with three-tier storage |
|
|
323
|
+
|
|
324
|
+
### Context & Recovery
|
|
325
|
+
|
|
326
|
+
| Hook | Description |
|
|
327
|
+
|------|-------------|
|
|
328
|
+
| `context-window-limit-recovery` | Token limit error handling and recovery |
|
|
329
|
+
| `preemptive-compaction` | Context usage monitoring to prevent limits |
|
|
330
|
+
| `session-recovery` | Session state recovery on crashes |
|
|
331
|
+
| `directory-readme-injector` | README context injection |
|
|
332
|
+
|
|
333
|
+
### Quality & Validation
|
|
334
|
+
|
|
335
|
+
| Hook | Description |
|
|
336
|
+
|------|-------------|
|
|
337
|
+
| `comment-checker` | BDD detection and directive filtering |
|
|
338
|
+
| `thinking-block-validator` | Extended thinking validation |
|
|
339
|
+
| `empty-message-sanitizer` | Empty message handling |
|
|
340
|
+
| `edit-error-recovery` | Automatic recovery from edit errors |
|
|
341
|
+
| `post-tool-use` | Remember tag auto-capture to notepad system |
|
|
342
|
+
|
|
343
|
+
### Environment & Notifications
|
|
344
|
+
|
|
345
|
+
| Hook | Description |
|
|
346
|
+
|------|-------------|
|
|
347
|
+
| `non-interactive-env` | CI/non-interactive environment handling |
|
|
348
|
+
| `agent-usage-reminder` | Reminder to use specialized agents |
|
|
349
|
+
| `background-notification` | Background task completion notifications |
|
|
350
|
+
|
|
351
|
+
---
|
|
352
|
+
|
|
353
|
+
## Magic Keywords
|
|
354
|
+
|
|
355
|
+
Just include these words anywhere in your prompt to activate enhanced modes:
|
|
356
|
+
|
|
357
|
+
| Keyword | Effect |
|
|
358
|
+
|---------|--------|
|
|
359
|
+
| `ultrawork`, `ulw`, `uw` | Activates parallel agent orchestration |
|
|
360
|
+
| `ecomode`, `eco`, `efficient`, `save-tokens`, `budget` | Token-efficient parallel execution |
|
|
361
|
+
| `autopilot`, `build me`, `I want a` | Full autonomous execution |
|
|
362
|
+
| `ultrapilot`, `parallel build`, `swarm build` | Parallel autopilot (3-5x faster) |
|
|
363
|
+
| `ralph`, `don't stop`, `must complete` | Persistence until verified complete |
|
|
364
|
+
| `plan this`, `plan the` | Planning interview workflow |
|
|
365
|
+
| `ralplan` | Iterative planning consensus |
|
|
366
|
+
| `search`, `find`, `locate` | Enhanced search mode |
|
|
367
|
+
| `analyze`, `investigate`, `debug` | Deep analysis mode |
|
|
368
|
+
| `research`, `analyze data`, `statistics` | Parallel research orchestration |
|
|
369
|
+
| `tdd`, `test first`, `red green` | TDD workflow enforcement |
|
|
370
|
+
| `swarm N agents` | Coordinated agent swarm |
|
|
371
|
+
| `pipeline`, `chain agents` | Sequential agent chaining |
|
|
372
|
+
| `stop`, `cancel`, `abort` | Unified cancellation |
|
|
373
|
+
|
|
374
|
+
### Examples
|
|
375
|
+
|
|
376
|
+
```bash
|
|
377
|
+
# In Claude Code:
|
|
378
|
+
|
|
379
|
+
# Maximum parallelism
|
|
380
|
+
ultrawork implement user authentication with OAuth
|
|
381
|
+
|
|
382
|
+
# Token-efficient parallelism
|
|
383
|
+
eco fix all TypeScript errors
|
|
384
|
+
|
|
385
|
+
# Enhanced search
|
|
386
|
+
find all files that import the utils module
|
|
387
|
+
|
|
388
|
+
# Deep analysis
|
|
389
|
+
analyze why the tests are failing
|
|
390
|
+
|
|
391
|
+
# Autonomous execution
|
|
392
|
+
autopilot: build a todo app with React
|
|
393
|
+
|
|
394
|
+
# Parallel autopilot
|
|
395
|
+
ultrapilot: build a fullstack todo app
|
|
396
|
+
|
|
397
|
+
# Persistence mode
|
|
398
|
+
ralph: refactor the authentication module
|
|
399
|
+
|
|
400
|
+
# Planning session
|
|
401
|
+
plan this feature
|
|
402
|
+
|
|
403
|
+
# TDD workflow
|
|
404
|
+
tdd: implement password validation
|
|
405
|
+
|
|
406
|
+
# Coordinated swarm
|
|
407
|
+
swarm 5 agents: fix all lint errors
|
|
408
|
+
|
|
409
|
+
# Agent chaining
|
|
410
|
+
pipeline: analyze → fix → test this bug
|
|
411
|
+
```
|
|
412
|
+
|
|
413
|
+
---
|
|
414
|
+
|
|
415
|
+
## Platform Support
|
|
416
|
+
|
|
417
|
+
### Operating Systems
|
|
418
|
+
|
|
419
|
+
| Platform | Install Method | Hook Type |
|
|
420
|
+
|----------|---------------|-----------|
|
|
421
|
+
| **Windows** | `npm install -g` | Node.js (.mjs) |
|
|
422
|
+
| **macOS** | curl or npm | Bash (.sh) |
|
|
423
|
+
| **Linux** | curl or npm | Bash (.sh) |
|
|
424
|
+
|
|
425
|
+
> **Note**: Bash hooks are fully portable across macOS and Linux (no GNU-specific dependencies).
|
|
426
|
+
|
|
427
|
+
> **Advanced**: Set `OMC_USE_NODE_HOOKS=1` to use Node.js hooks on macOS/Linux.
|
|
428
|
+
|
|
429
|
+
### Available Tools
|
|
430
|
+
|
|
431
|
+
| Tool | Status | Description |
|
|
432
|
+
|------|--------|-------------|
|
|
433
|
+
| **Read** | ✅ Available | Read files |
|
|
434
|
+
| **Write** | ✅ Available | Create files |
|
|
435
|
+
| **Edit** | ✅ Available | Modify files |
|
|
436
|
+
| **Bash** | ✅ Available | Run shell commands |
|
|
437
|
+
| **Glob** | ✅ Available | Find files by pattern |
|
|
438
|
+
| **Grep** | ✅ Available | Search file contents |
|
|
439
|
+
| **WebSearch** | ✅ Available | Search the web |
|
|
440
|
+
| **WebFetch** | ✅ Available | Fetch web pages |
|
|
441
|
+
| **Task** | ✅ Available | Spawn subagents |
|
|
442
|
+
| **TodoWrite** | ✅ Available | Track tasks |
|
|
443
|
+
|
|
444
|
+
### LSP Tools (Real Implementation)
|
|
445
|
+
|
|
446
|
+
| Tool | Status | Description |
|
|
447
|
+
|------|--------|-------------|
|
|
448
|
+
| `lsp_hover` | ✅ Implemented | Get type info and documentation at position |
|
|
449
|
+
| `lsp_goto_definition` | ✅ Implemented | Jump to symbol definition |
|
|
450
|
+
| `lsp_find_references` | ✅ Implemented | Find all usages of a symbol |
|
|
451
|
+
| `lsp_document_symbols` | ✅ Implemented | Get file outline (functions, classes, etc.) |
|
|
452
|
+
| `lsp_workspace_symbols` | ✅ Implemented | Search symbols across workspace |
|
|
453
|
+
| `lsp_diagnostics` | ✅ Implemented | Get errors, warnings, hints |
|
|
454
|
+
| `lsp_prepare_rename` | ✅ Implemented | Check if rename is valid |
|
|
455
|
+
| `lsp_rename` | ✅ Implemented | Rename symbol across project |
|
|
456
|
+
| `lsp_code_actions` | ✅ Implemented | Get available refactorings |
|
|
457
|
+
| `lsp_code_action_resolve` | ✅ Implemented | Get details of a code action |
|
|
458
|
+
| `lsp_servers` | ✅ Implemented | List available language servers |
|
|
459
|
+
| `lsp_diagnostics_directory` | ✅ Implemented | Project-level type checking |
|
|
460
|
+
|
|
461
|
+
> **Note**: LSP tools require language servers to be installed (typescript-language-server, pylsp, rust-analyzer, gopls, etc.). Use `lsp_servers` to check installation status.
|
|
462
|
+
|
|
463
|
+
### AST Tools (ast-grep Integration)
|
|
464
|
+
|
|
465
|
+
| Tool | Status | Description |
|
|
466
|
+
|------|--------|-------------|
|
|
467
|
+
| `ast_grep_search` | ✅ Implemented | Pattern-based code search using AST matching |
|
|
468
|
+
| `ast_grep_replace` | ✅ Implemented | Pattern-based code transformation |
|
|
469
|
+
|
|
470
|
+
> **Note**: AST tools use [@ast-grep/napi](https://ast-grep.github.io/) for structural code matching. Supports meta-variables like `$VAR` (single node) and `$$$` (multiple nodes).
|
|
471
|
+
|
|
472
|
+
---
|
|
473
|
+
|
|
474
|
+
## Troubleshooting
|
|
475
|
+
|
|
476
|
+
### Diagnose Installation Issues
|
|
477
|
+
|
|
478
|
+
```bash
|
|
479
|
+
/oh-my-claudecode:doctor
|
|
480
|
+
```
|
|
481
|
+
|
|
482
|
+
Checks for:
|
|
483
|
+
- Missing dependencies
|
|
484
|
+
- Configuration errors
|
|
485
|
+
- Hook installation status
|
|
486
|
+
- Agent availability
|
|
487
|
+
- Skill registration
|
|
488
|
+
|
|
489
|
+
### Configure HUD Statusline
|
|
490
|
+
|
|
491
|
+
```bash
|
|
492
|
+
/oh-my-claudecode:hud setup
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
Installs or repairs the HUD statusline for real-time status updates.
|
|
496
|
+
|
|
497
|
+
### Common Issues
|
|
498
|
+
|
|
499
|
+
| Issue | Solution |
|
|
500
|
+
|-------|----------|
|
|
501
|
+
| Commands not found | Re-run `/oh-my-claudecode:omc-setup` |
|
|
502
|
+
| Hooks not executing | Check hook permissions: `chmod +x ~/.claude/hooks/**/*.sh` |
|
|
503
|
+
| Agents not delegating | Verify CLAUDE.md is loaded: check `./.claude/CLAUDE.md` or `~/.claude/CLAUDE.md` |
|
|
504
|
+
| LSP tools not working | Install language servers: `npm install -g typescript-language-server` |
|
|
505
|
+
| Token limit errors | Use `/oh-my-claudecode:ecomode` for token-efficient execution |
|
|
506
|
+
|
|
507
|
+
### Auto-Update
|
|
508
|
+
|
|
509
|
+
Oh-my-claudecode includes a silent auto-update system that checks for updates in the background.
|
|
510
|
+
|
|
511
|
+
Features:
|
|
512
|
+
- **Rate-limited**: Checks at most once every 24 hours
|
|
513
|
+
- **Concurrent-safe**: Lock file prevents simultaneous update attempts
|
|
514
|
+
- **Cross-platform**: Works on both macOS and Linux
|
|
515
|
+
|
|
516
|
+
To manually update, re-run the plugin install command or use Claude Code's built-in update mechanism.
|
|
517
|
+
|
|
518
|
+
### Uninstall
|
|
519
|
+
|
|
520
|
+
```bash
|
|
521
|
+
curl -fsSL https://raw.githubusercontent.com/Yeachan-Heo/oh-my-claudecode/main/scripts/uninstall.sh | bash
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
Or manually:
|
|
525
|
+
|
|
526
|
+
```bash
|
|
527
|
+
rm ~/.claude/agents/{architect,researcher,explore,designer,writer,vision,critic,analyst,executor,qa-tester}.md
|
|
528
|
+
rm ~/.claude/commands/{analyze,autopilot,deepsearch,plan,review,ultrawork}.md
|
|
529
|
+
```
|
|
530
|
+
|
|
531
|
+
---
|
|
532
|
+
|
|
533
|
+
## Changelog
|
|
534
|
+
|
|
535
|
+
See [CHANGELOG.md](../CHANGELOG.md) for version history and release notes.
|
|
536
|
+
|
|
537
|
+
---
|
|
538
|
+
|
|
539
|
+
## License
|
|
540
|
+
|
|
541
|
+
MIT - see [LICENSE](../LICENSE)
|
|
542
|
+
|
|
543
|
+
## Credits
|
|
544
|
+
|
|
545
|
+
Inspired by [oh-my-opencode](https://github.com/code-yeongyu/oh-my-opencode) by code-yeongyu.
|
package/docs/SYNC-SYSTEM.md
CHANGED
|
@@ -13,7 +13,7 @@ In a typical project lifecycle:
|
|
|
13
13
|
1. Developer bumps version in `package.json` to `3.5.0`
|
|
14
14
|
2. Creates a release commit
|
|
15
15
|
3. **Forgets** to update version badge in `README.md` (still shows `3.4.0`)
|
|
16
|
-
4. **Forgets** to update version header in `
|
|
16
|
+
4. **Forgets** to update version header in `docs/REFERENCE.md`
|
|
17
17
|
5. **Forgets** to update agent count in `.github/CLAUDE.md` after adding new agents
|
|
18
18
|
6. Users see inconsistent version information across documentation
|
|
19
19
|
7. CI builds look professional but contain stale metadata
|
|
@@ -51,7 +51,7 @@ The script syncs these files:
|
|
|
51
51
|
| File | What Gets Updated |
|
|
52
52
|
|------|-------------------|
|
|
53
53
|
| `README.md` | npm version/download badges |
|
|
54
|
-
| `docs/
|
|
54
|
+
| `docs/REFERENCE.md` | Version badges, version headers |
|
|
55
55
|
| `.github/CLAUDE.md` | Agent count, skill count |
|
|
56
56
|
| `docs/ARCHITECTURE.md` | Version references |
|
|
57
57
|
| `CHANGELOG.md` | Latest version header (verify only) |
|
|
@@ -86,7 +86,7 @@ Skills: 45
|
|
|
86
86
|
✓ README.md
|
|
87
87
|
- npm version badge
|
|
88
88
|
|
|
89
|
-
✓ docs/
|
|
89
|
+
✓ docs/REFERENCE.md
|
|
90
90
|
- Version badge
|
|
91
91
|
- Version header
|
|
92
92
|
|
|
@@ -111,7 +111,7 @@ Shows what **would** change without writing files:
|
|
|
111
111
|
📝 README.md
|
|
112
112
|
- npm version badge
|
|
113
113
|
|
|
114
|
-
📝 docs/
|
|
114
|
+
📝 docs/REFERENCE.md
|
|
115
115
|
- Version badge
|
|
116
116
|
|
|
117
117
|
📊 2 file(s) would be updated
|
|
@@ -131,7 +131,7 @@ Checks if files are in sync. Exits with status code:
|
|
|
131
131
|
```
|
|
132
132
|
🔍 Verifying metadata sync...
|
|
133
133
|
✓ README.md
|
|
134
|
-
✗ docs/
|
|
134
|
+
✗ docs/REFERENCE.md
|
|
135
135
|
- Version badge needs update
|
|
136
136
|
|
|
137
137
|
❌ Files are out of sync!
|
|
@@ -454,7 +454,7 @@ Document complex regex:
|
|
|
454
454
|
// Captures: version number only
|
|
455
455
|
pattern: /\[!\[Version\]\(https:\/\/img\.shields\.io\/badge\/version-([^-]+)-[^)]+\)/g,
|
|
456
456
|
replacement: (m) => `[]`,
|
|
457
|
-
description: 'Version badge in
|
|
457
|
+
description: 'Version badge in REFERENCE.md',
|
|
458
458
|
}
|
|
459
459
|
```
|
|
460
460
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "oh-my-claude-sisyphus",
|
|
3
|
-
"version": "3.5.
|
|
3
|
+
"version": "3.5.7",
|
|
4
4
|
"description": "Multi-agent orchestration system for Claude Code - Inspired by oh-my-opencode",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -48,6 +48,7 @@
|
|
|
48
48
|
"dependencies": {
|
|
49
49
|
"@anthropic-ai/claude-agent-sdk": "^0.1.0",
|
|
50
50
|
"@ast-grep/napi": "^0.31.0",
|
|
51
|
+
"@tokscale/core": "^1.0.25",
|
|
51
52
|
"chalk": "^5.3.0",
|
|
52
53
|
"commander": "^12.1.0",
|
|
53
54
|
"jsonc-parser": "^3.3.1",
|
package/scripts/sync-metadata.ts
CHANGED
|
@@ -123,7 +123,7 @@ function getFileSyncConfigs(): FileSync[] {
|
|
|
123
123
|
],
|
|
124
124
|
},
|
|
125
125
|
{
|
|
126
|
-
path: 'docs/
|
|
126
|
+
path: 'docs/REFERENCE.md',
|
|
127
127
|
replacements: [
|
|
128
128
|
{
|
|
129
129
|
pattern: /\[!\[Version\]\(https:\/\/img\.shields\.io\/badge\/version-[^-]+-[^)]+\)/g,
|
|
@@ -319,7 +319,7 @@ ${color('Description:', colors.cyan)}
|
|
|
319
319
|
|
|
320
320
|
${color('Files Synced:', colors.cyan)}
|
|
321
321
|
- README.md (npm badges)
|
|
322
|
-
- docs/
|
|
322
|
+
- docs/REFERENCE.md (version badges and headers)
|
|
323
323
|
- .github/CLAUDE.md (agent/skill counts)
|
|
324
324
|
- docs/ARCHITECTURE.md (version references)
|
|
325
325
|
- CHANGELOG.md (version header verification)
|