@onion-ai/cli 1.0.0-beta.1
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 -0
- package/README.md +529 -0
- package/bin/onion.js +6 -0
- package/framework/CLAUDE.md +45 -0
- package/framework/VERSION +1 -0
- package/framework/agents/compliance/iso-22301-specialist.md +985 -0
- package/framework/agents/compliance/iso-27001-specialist.md +713 -0
- package/framework/agents/compliance/pmbok-specialist.md +739 -0
- package/framework/agents/compliance/security-information-master.md +907 -0
- package/framework/agents/compliance/soc2-specialist.md +889 -0
- package/framework/agents/deployment/docker-specialist.md +1192 -0
- package/framework/agents/development/c4-architecture-specialist.md +745 -0
- package/framework/agents/development/c4-documentation-specialist.md +695 -0
- package/framework/agents/development/clickup-specialist.md +396 -0
- package/framework/agents/development/cursor-specialist.md +277 -0
- package/framework/agents/development/docs-reverse-engineer.md +417 -0
- package/framework/agents/development/gamma-api-specialist.md +1168 -0
- package/framework/agents/development/gitflow-specialist.md +1206 -0
- package/framework/agents/development/linux-security-specialist.md +675 -0
- package/framework/agents/development/mermaid-specialist.md +515 -0
- package/framework/agents/development/nodejs-specialist.md +672 -0
- package/framework/agents/development/nx-migration-specialist.md +866 -0
- package/framework/agents/development/nx-monorepo-specialist.md +618 -0
- package/framework/agents/development/postgres-specialist.md +1123 -0
- package/framework/agents/development/react-developer.md +131 -0
- package/framework/agents/development/runflow-specialist.md +277 -0
- package/framework/agents/development/system-documentation-orchestrator.md +1387 -0
- package/framework/agents/development/task-specialist.md +677 -0
- package/framework/agents/git/branch-code-reviewer.md +225 -0
- package/framework/agents/git/branch-documentation-writer.md +161 -0
- package/framework/agents/git/branch-metaspec-checker.md +67 -0
- package/framework/agents/git/branch-test-planner.md +176 -0
- package/framework/agents/meta/agent-creator-specialist.md +1266 -0
- package/framework/agents/meta/command-creator-specialist.md +1676 -0
- package/framework/agents/meta/metaspec-gate-keeper.md +240 -0
- package/framework/agents/meta/onion.md +824 -0
- package/framework/agents/product/branding-positioning-specialist.md +1029 -0
- package/framework/agents/product/extract-meeting-specialist.md +394 -0
- package/framework/agents/product/meeting-consolidator.md +482 -0
- package/framework/agents/product/pain-price-specialist.md +508 -0
- package/framework/agents/product/presentation-orchestrator.md +1190 -0
- package/framework/agents/product/product-agent.md +201 -0
- package/framework/agents/product/story-points-framework-specialist.md +538 -0
- package/framework/agents/product/storytelling-business-specialist.md +890 -0
- package/framework/agents/research/research-agent.md +292 -0
- package/framework/agents/review/code-reviewer.md +154 -0
- package/framework/agents/review/corporate-compliance-specialist.md +370 -0
- package/framework/agents/testing/test-agent.md +424 -0
- package/framework/agents/testing/test-engineer.md +294 -0
- package/framework/agents/testing/test-planner.md +117 -0
- package/framework/commands/common/prompts/README.md +208 -0
- package/framework/commands/common/prompts/clickup-patterns.md +144 -0
- package/framework/commands/common/prompts/code-review-checklist.md +168 -0
- package/framework/commands/common/prompts/git-workflow-patterns.md +235 -0
- package/framework/commands/common/prompts/output-formats.md +240 -0
- package/framework/commands/common/prompts/technical.md +194 -0
- package/framework/commands/common/templates/abstraction-template.md +399 -0
- package/framework/commands/common/templates/agent-template.md +353 -0
- package/framework/commands/common/templates/business_context_template.md +748 -0
- package/framework/commands/common/templates/command-template.md +273 -0
- package/framework/commands/common/templates/technical_context_template.md +526 -0
- package/framework/commands/design/screen-spec.md +505 -0
- package/framework/commands/development/runflow-dev.md +465 -0
- package/framework/commands/docs/build-business-docs.md +299 -0
- package/framework/commands/docs/build-compliance-docs.md +143 -0
- package/framework/commands/docs/build-index.md +119 -0
- package/framework/commands/docs/build-tech-docs.md +221 -0
- package/framework/commands/docs/docs-health.md +141 -0
- package/framework/commands/docs/help.md +278 -0
- package/framework/commands/docs/refine-vision.md +25 -0
- package/framework/commands/docs/reverse-consolidate.md +158 -0
- package/framework/commands/docs/sync-sessions.md +354 -0
- package/framework/commands/docs/validate-docs.md +157 -0
- package/framework/commands/engineer/bump.md +29 -0
- package/framework/commands/engineer/docs.md +11 -0
- package/framework/commands/engineer/hotfix.md +183 -0
- package/framework/commands/engineer/plan.md +85 -0
- package/framework/commands/engineer/pr-update.md +219 -0
- package/framework/commands/engineer/pr.md +117 -0
- package/framework/commands/engineer/pre-pr.md +81 -0
- package/framework/commands/engineer/start.md +254 -0
- package/framework/commands/engineer/validate-phase-sync.md +134 -0
- package/framework/commands/engineer/warm-up.md +20 -0
- package/framework/commands/engineer/work.md +155 -0
- package/framework/commands/f/company-context-extractor.md +93 -0
- package/framework/commands/f/process-meetings.md +103 -0
- package/framework/commands/git/README.md +682 -0
- package/framework/commands/git/code-review.md +213 -0
- package/framework/commands/git/fast-commit.md +43 -0
- package/framework/commands/git/feature/finish.md +88 -0
- package/framework/commands/git/feature/publish.md +89 -0
- package/framework/commands/git/feature/start.md +172 -0
- package/framework/commands/git/help.md +100 -0
- package/framework/commands/git/hotfix/finish.md +96 -0
- package/framework/commands/git/hotfix/start.md +92 -0
- package/framework/commands/git/init.md +111 -0
- package/framework/commands/git/release/finish.md +96 -0
- package/framework/commands/git/release/start.md +93 -0
- package/framework/commands/git/sync.md +199 -0
- package/framework/commands/meta/all-tools.md +58 -0
- package/framework/commands/meta/analyze-complex-problem.md +186 -0
- package/framework/commands/meta/create-abstraction.md +882 -0
- package/framework/commands/meta/create-agent-express.md +98 -0
- package/framework/commands/meta/create-agent.md +210 -0
- package/framework/commands/meta/create-command.md +203 -0
- package/framework/commands/meta/create-knowledge-base.md +143 -0
- package/framework/commands/meta/create-task-structure.md +150 -0
- package/framework/commands/meta/setup-integration.md +274 -0
- package/framework/commands/onion.md +169 -0
- package/framework/commands/product/README.md +249 -0
- package/framework/commands/product/analyze-pain-price.md +694 -0
- package/framework/commands/product/branding.md +458 -0
- package/framework/commands/product/check.md +46 -0
- package/framework/commands/product/checklist-sync.md +239 -0
- package/framework/commands/product/collect.md +95 -0
- package/framework/commands/product/consolidate-meetings.md +291 -0
- package/framework/commands/product/estimate.md +511 -0
- package/framework/commands/product/extract-meeting.md +226 -0
- package/framework/commands/product/feature.md +416 -0
- package/framework/commands/product/light-arch.md +82 -0
- package/framework/commands/product/presentation.md +174 -0
- package/framework/commands/product/refine.md +161 -0
- package/framework/commands/product/spec.md +79 -0
- package/framework/commands/product/task-check.md +378 -0
- package/framework/commands/product/task.md +603 -0
- package/framework/commands/product/validate-task.md +325 -0
- package/framework/commands/product/warm-up.md +24 -0
- package/framework/commands/quick/analisys.md +17 -0
- package/framework/commands/test/e2e.md +377 -0
- package/framework/commands/test/integration.md +508 -0
- package/framework/commands/test/unit.md +381 -0
- package/framework/commands/validate/collab/pair-testing.md +657 -0
- package/framework/commands/validate/collab/three-amigos.md +534 -0
- package/framework/commands/validate/qa-points/estimate.md +660 -0
- package/framework/commands/validate/test-strategy/analyze.md +1201 -0
- package/framework/commands/validate/test-strategy/create.md +411 -0
- package/framework/commands/validate/workflow.md +370 -0
- package/framework/commands/warm-up.md +20 -0
- package/framework/docs/architecture/acoplamento-clickup-problema-analise.md +468 -0
- package/framework/docs/architecture/desacoplamento-roadmap.md +364 -0
- package/framework/docs/architecture/validacao-fase-1.md +235 -0
- package/framework/docs/c4/c4-detection-rules.md +395 -0
- package/framework/docs/c4/c4-documentation-templates.md +579 -0
- package/framework/docs/c4/c4-mermaid-patterns.md +331 -0
- package/framework/docs/c4/c4-templates.md +256 -0
- package/framework/docs/clickup/clickup-acceptance-criteria-strategy.md +329 -0
- package/framework/docs/clickup/clickup-auto-update-strategy.md +340 -0
- package/framework/docs/clickup/clickup-comment-formatter.md +239 -0
- package/framework/docs/clickup/clickup-description-fix.md +384 -0
- package/framework/docs/clickup/clickup-dual-comment-strategy.md +528 -0
- package/framework/docs/clickup/clickup-formatting.md +302 -0
- package/framework/docs/clickup/separador-tamanho-otimizado.md +258 -0
- package/framework/docs/engineer/pre-pr-acceptance-validation.md +256 -0
- package/framework/docs/onion/ESPERANTO.md +293 -0
- package/framework/docs/onion/agents-reference.md +832 -0
- package/framework/docs/onion/clickup-integration.md +780 -0
- package/framework/docs/onion/commands-guide.md +924 -0
- package/framework/docs/onion/engineering-flows.md +900 -0
- package/framework/docs/onion/getting-started.md +803 -0
- package/framework/docs/onion/maintenance-checklist.md +421 -0
- package/framework/docs/onion/naming-conventions.md +286 -0
- package/framework/docs/onion/practical-examples.md +854 -0
- package/framework/docs/product/story-points-integration.md +269 -0
- package/framework/docs/product/story-points-validation.md +237 -0
- package/framework/docs/reviews/task-manager-docs-review-2025-11-24.md +184 -0
- package/framework/docs/strategies/clickup-comment-patterns.md +766 -0
- package/framework/docs/strategies/clickup-integration-tests.md +602 -0
- package/framework/docs/strategies/clickup-mcp-wrappers-tests.md +888 -0
- package/framework/docs/strategies/clickup-regression-tests.md +587 -0
- package/framework/docs/strategies/visual-patterns.md +315 -0
- package/framework/docs/templates/README.md +649 -0
- package/framework/docs/templates/adr-template.md +226 -0
- package/framework/docs/templates/analysis-template.md +280 -0
- package/framework/docs/templates/execution-plan-template.md +430 -0
- package/framework/docs/templates/guide-template.md +367 -0
- package/framework/docs/templates/phase-execution-prompt-template.md +504 -0
- package/framework/docs/templates/reference-template.md +522 -0
- package/framework/docs/templates/solution-template.md +390 -0
- package/framework/docs/tools/README.md +356 -0
- package/framework/docs/tools/agents.md +365 -0
- package/framework/docs/tools/commands.md +669 -0
- package/framework/docs/tools/cursor.md +539 -0
- package/framework/docs/tools/mcps.md +937 -0
- package/framework/docs/tools/rules.md +461 -0
- package/framework/rules/language-and-documentation.mdc +371 -0
- package/framework/rules/nestjs-controllers.md +83 -0
- package/framework/rules/nestjs-dtos.md +255 -0
- package/framework/rules/nestjs-modules.md +141 -0
- package/framework/rules/nestjs-services.md +230 -0
- package/framework/rules/nx-rules.mdc +41 -0
- package/framework/rules/onion-patterns.mdc +197 -0
- package/framework/skills/codebase-visualizer/SKILL.md +26 -0
- package/framework/skills/codebase-visualizer/scripts/visualize.py +131 -0
- package/framework/skills/collect/SKILL.md +84 -0
- package/framework/skills/create-rule/SKILL.md +152 -0
- package/framework/skills/db-schema-visualizer/SKILL.md +49 -0
- package/framework/skills/db-schema-visualizer/scripts/visualize.py +1191 -0
- package/framework/skills/sync-meetings/SKILL.md +239 -0
- package/framework/utils/clickup-mcp-wrappers.md +744 -0
- package/framework/utils/date-time-standards.md +200 -0
- package/framework/utils/task-manager/README.md +94 -0
- package/framework/utils/task-manager/adapters/asana.md +377 -0
- package/framework/utils/task-manager/adapters/clickup.md +467 -0
- package/framework/utils/task-manager/adapters/linear.md +421 -0
- package/framework/utils/task-manager/detector.md +299 -0
- package/framework/utils/task-manager/factory.md +363 -0
- package/framework/utils/task-manager/interface.md +248 -0
- package/framework/utils/task-manager/types.md +409 -0
- package/package.json +41 -0
- package/src/cli.js +73 -0
- package/src/commands/doctor.js +191 -0
- package/src/commands/init.js +287 -0
- package/src/commands/install.js +261 -0
- package/src/commands/list.js +152 -0
- package/src/commands/uninstall.js +90 -0
- package/src/commands/update.js +26 -0
- package/src/utils/fs.js +89 -0
- package/src/utils/log.js +35 -0
- package/src/utils/paths.js +32 -0
- package/src/utils/prompt.js +76 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Onion AI
|
|
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.md
ADDED
|
@@ -0,0 +1,529 @@
|
|
|
1
|
+
# Onion Framework
|
|
2
|
+
|
|
3
|
+
AI-powered development workflow system for [Claude Code](https://docs.anthropic.com/en/docs/claude-code).
|
|
4
|
+
|
|
5
|
+
Onion provides **88 commands**, **45 specialized agents**, and **8 skills** that guide you through the entire software development lifecycle — from collecting requirements to shipping features.
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
# Install the framework globally
|
|
11
|
+
npx @onion-ai/cli install
|
|
12
|
+
|
|
13
|
+
# Configure your project
|
|
14
|
+
npx @onion-ai/cli init
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
The `install` step adds 88 commands, 45 agents, and 8 skills to Claude Code. The `init` step creates a `.onion/` directory in your project with task manager settings, API keys, and team preferences.
|
|
18
|
+
|
|
19
|
+
## What It Does
|
|
20
|
+
|
|
21
|
+
Onion structures your development workflow into clear phases:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
Collect → Refine → Spec → Plan → Build → Test → PR → Ship
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Each phase has dedicated commands and agents that handle the heavy lifting:
|
|
28
|
+
|
|
29
|
+
| Phase | Commands | What happens |
|
|
30
|
+
|-------|----------|-------------|
|
|
31
|
+
| **Requirements** | `/onion:product:collect` → `/onion:product:refine` → `/onion:product:spec` | Gather ideas, clarify requirements, write specifications |
|
|
32
|
+
| **Planning** | `/onion:product:task` → `/onion:engineer:plan` | Create structured tasks, plan implementation |
|
|
33
|
+
| **Development** | `/onion:engineer:start` → `/onion:engineer:work` | Start features, continue work with session context |
|
|
34
|
+
| **Quality** | `/onion:engineer:pre-pr` → `/onion:test:unit` | Pre-PR validation, run tests |
|
|
35
|
+
| **Delivery** | `/onion:engineer:pr` → `/onion:git:feature:finish` | Create PRs, merge features |
|
|
36
|
+
| **Documentation** | `/onion:docs:build-tech-docs` → `/onion:docs:build-business-docs` | Generate technical and business documentation |
|
|
37
|
+
|
|
38
|
+
## Installation
|
|
39
|
+
|
|
40
|
+
### Prerequisites
|
|
41
|
+
|
|
42
|
+
- [Claude Code](https://docs.anthropic.com/en/docs/claude-code) installed and configured
|
|
43
|
+
- [Node.js](https://nodejs.org/) >= 18
|
|
44
|
+
- [Git](https://git-scm.com/)
|
|
45
|
+
|
|
46
|
+
### Install
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
npx @onion-ai/cli install
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Verify
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
npx @onion-ai/cli doctor
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
Output:
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
Onion Framework Health Check
|
|
62
|
+
|
|
63
|
+
→ Checking prerequisites...
|
|
64
|
+
✓ Claude Code config directory exists
|
|
65
|
+
✓ Claude Code CLI available
|
|
66
|
+
✓ Git available
|
|
67
|
+
✓ Node.js v22.16.0 (>= 18 required)
|
|
68
|
+
|
|
69
|
+
→ Checking installation...
|
|
70
|
+
✓ Framework home exists (~/.claude/onion/)
|
|
71
|
+
✓ Version 1.0.0-beta.1 installed on 2026-02-28
|
|
72
|
+
✓ 88 commands installed → /onion:*
|
|
73
|
+
✓ 45 agents installed
|
|
74
|
+
✓ 8 skills installed (onion-* prefix)
|
|
75
|
+
✓ CLAUDE.md integration active
|
|
76
|
+
✓ 46 documentation files available
|
|
77
|
+
|
|
78
|
+
All checks passed!
|
|
79
|
+
✓ Onion Framework is healthy and ready to use
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Update
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
npx @onion-ai/cli update
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Uninstall
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
npx @onion-ai/cli uninstall
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Clean removal — restores your `~/.claude/CLAUDE.md` and removes all framework files.
|
|
95
|
+
|
|
96
|
+
## Project Configuration
|
|
97
|
+
|
|
98
|
+
After installing the framework globally, configure each project with:
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
npx @onion-ai/cli init
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
This creates a `.onion/` directory in your project root:
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
<your-project>/
|
|
108
|
+
└── .onion/
|
|
109
|
+
├── config.yaml ← Team settings (commit this)
|
|
110
|
+
├── .env ← API keys and secrets (gitignored)
|
|
111
|
+
└── .env.example ← Template for team onboarding (commit this)
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Interactive Setup
|
|
115
|
+
|
|
116
|
+
The `init` command walks you through configuration:
|
|
117
|
+
|
|
118
|
+
```
|
|
119
|
+
? Which task manager does this project use?
|
|
120
|
+
1) ClickUp — via MCP integration
|
|
121
|
+
2) Jira — via API
|
|
122
|
+
3) Linear — via API
|
|
123
|
+
4) Asana — via MCP integration
|
|
124
|
+
5) None — offline mode
|
|
125
|
+
|
|
126
|
+
? Documentation and comments language?
|
|
127
|
+
1) English
|
|
128
|
+
2) Portuguese (Brazil)
|
|
129
|
+
3) Spanish
|
|
130
|
+
|
|
131
|
+
? Git workflow for this project?
|
|
132
|
+
1) GitFlow — feature/release/hotfix branches
|
|
133
|
+
2) GitHub Flow — feature branches from main
|
|
134
|
+
3) Trunk-based — short-lived branches
|
|
135
|
+
|
|
136
|
+
? Enable Gamma.app integration (presentations)? (y/N)
|
|
137
|
+
? Enable automated code review? (Y/n)
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### config.yaml
|
|
141
|
+
|
|
142
|
+
Committable settings shared across the team:
|
|
143
|
+
|
|
144
|
+
```yaml
|
|
145
|
+
version: "1.0"
|
|
146
|
+
|
|
147
|
+
task_manager:
|
|
148
|
+
provider: clickup
|
|
149
|
+
workspace_id: "12345"
|
|
150
|
+
default_list: "67890"
|
|
151
|
+
|
|
152
|
+
language:
|
|
153
|
+
code: en
|
|
154
|
+
docs: pt-BR
|
|
155
|
+
commits: pt-BR
|
|
156
|
+
|
|
157
|
+
git:
|
|
158
|
+
flow: gitflow
|
|
159
|
+
main_branch: main
|
|
160
|
+
develop_branch: develop
|
|
161
|
+
|
|
162
|
+
integrations:
|
|
163
|
+
gamma:
|
|
164
|
+
enabled: false
|
|
165
|
+
code_review:
|
|
166
|
+
enabled: true
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### .env
|
|
170
|
+
|
|
171
|
+
Secrets that stay local (auto-added to `.gitignore`):
|
|
172
|
+
|
|
173
|
+
```bash
|
|
174
|
+
CLICKUP_API_TOKEN=pk_your_token_here
|
|
175
|
+
# or JIRA_API_TOKEN=, LINEAR_API_KEY=, ASANA_API_TOKEN=
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Team Onboarding
|
|
179
|
+
|
|
180
|
+
New team members clone the repo and run:
|
|
181
|
+
|
|
182
|
+
```bash
|
|
183
|
+
cp .onion/.env.example .onion/.env
|
|
184
|
+
# Fill in API keys
|
|
185
|
+
npx @onion-ai/cli doctor
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
## Commands
|
|
189
|
+
|
|
190
|
+
All commands are prefixed with `onion:` so they don't conflict with your own commands or other tools.
|
|
191
|
+
|
|
192
|
+
### Entry Points
|
|
193
|
+
|
|
194
|
+
| Command | Description |
|
|
195
|
+
|---------|-------------|
|
|
196
|
+
| `/onion` | Intelligent entry point — ask anything about the framework |
|
|
197
|
+
| `/onion:warm-up` | Load project context and prepare for work |
|
|
198
|
+
|
|
199
|
+
### Product
|
|
200
|
+
|
|
201
|
+
| Command | Description |
|
|
202
|
+
|---------|-------------|
|
|
203
|
+
| `/onion:product:collect` | Collect feature ideas or bug reports |
|
|
204
|
+
| `/onion:product:refine` | Refine requirements through clarification questions |
|
|
205
|
+
| `/onion:product:spec` | Create product specification from requirements |
|
|
206
|
+
| `/onion:product:task` | Create structured tasks with subtasks and action items |
|
|
207
|
+
| `/onion:product:feature` | Create feature tasks for planning and backlog |
|
|
208
|
+
| `/onion:product:estimate` | Story point estimation |
|
|
209
|
+
| `/onion:product:check` | Verify requirements against project meta-specs |
|
|
210
|
+
| `/onion:product:validate-task` | Validate existing tasks |
|
|
211
|
+
| `/onion:product:light-arch` | Lightweight architecture design for features |
|
|
212
|
+
| `/onion:product:branding` | Branding and positioning analysis |
|
|
213
|
+
| `/onion:product:analyze-pain-price` | Customer pain and pricing analysis |
|
|
214
|
+
| `/onion:product:presentation` | Generate presentations via Gamma.app |
|
|
215
|
+
| `/onion:product:extract-meeting` | Extract structured knowledge from meeting transcripts |
|
|
216
|
+
| `/onion:product:consolidate-meetings` | Consolidate multiple meetings into strategic insights |
|
|
217
|
+
|
|
218
|
+
### Engineering
|
|
219
|
+
|
|
220
|
+
| Command | Description |
|
|
221
|
+
|---------|-------------|
|
|
222
|
+
| `/onion:engineer:start` | Start feature development — creates session, analyzes tasks |
|
|
223
|
+
| `/onion:engineer:plan` | Plan feature implementation with structured approach |
|
|
224
|
+
| `/onion:engineer:work` | Continue work on active feature with session context |
|
|
225
|
+
| `/onion:engineer:pre-pr` | Pre-PR validation — checks patterns and quality |
|
|
226
|
+
| `/onion:engineer:pr` | Create Pull Request with GitFlow integration |
|
|
227
|
+
| `/onion:engineer:pr-update` | Update existing PR with additional changes |
|
|
228
|
+
| `/onion:engineer:hotfix` | Emergency workflow: task + hotfix branch + development |
|
|
229
|
+
| `/onion:engineer:docs` | Invoke documentation agent for current branch |
|
|
230
|
+
| `/onion:engineer:bump` | Semantic version bump (major, minor, patch) |
|
|
231
|
+
| `/onion:engineer:warm-up` | Load project context for engineering work |
|
|
232
|
+
|
|
233
|
+
### Git
|
|
234
|
+
|
|
235
|
+
| Command | Description |
|
|
236
|
+
|---------|-------------|
|
|
237
|
+
| `/onion:git:feature:start` | Start GitFlow feature branch |
|
|
238
|
+
| `/onion:git:feature:finish` | Finish feature with merge to develop |
|
|
239
|
+
| `/onion:git:feature:publish` | Publish feature branch to remote |
|
|
240
|
+
| `/onion:git:hotfix:start` | Start hotfix branch for production fixes |
|
|
241
|
+
| `/onion:git:hotfix:finish` | Finish hotfix with merge to main and develop |
|
|
242
|
+
| `/onion:git:release:start` | Start release branch with versioning |
|
|
243
|
+
| `/onion:git:release:finish` | Finish release with merge, tag, and publish |
|
|
244
|
+
| `/onion:git:fast-commit` | Quick commit for typical workflow changes |
|
|
245
|
+
| `/onion:git:sync` | Sync with remote using GitFlow conventions |
|
|
246
|
+
| `/onion:git:code-review` | Setup and manage automated code review |
|
|
247
|
+
| `/onion:git:init` | Initialize repository with GitFlow conventions |
|
|
248
|
+
|
|
249
|
+
### Documentation
|
|
250
|
+
|
|
251
|
+
| Command | Description |
|
|
252
|
+
|---------|-------------|
|
|
253
|
+
| `/onion:docs:build-tech-docs` | Generate comprehensive technical documentation |
|
|
254
|
+
| `/onion:docs:build-business-docs` | Generate business context and strategy docs |
|
|
255
|
+
| `/onion:docs:build-compliance-docs` | Generate compliance documentation (ISO 27001, SOC2, etc.) |
|
|
256
|
+
| `/onion:docs:reverse-consolidate` | Reverse-engineer project documentation |
|
|
257
|
+
| `/onion:docs:validate-docs` | Validate documentation completeness |
|
|
258
|
+
| `/onion:docs:docs-health` | Documentation health check |
|
|
259
|
+
| `/onion:docs:build-index` | Manage and update documentation indexes |
|
|
260
|
+
| `/onion:docs:refine-vision` | Refine product/project vision and strategy |
|
|
261
|
+
|
|
262
|
+
### Testing
|
|
263
|
+
|
|
264
|
+
| Command | Description |
|
|
265
|
+
|---------|-------------|
|
|
266
|
+
| `/onion:test:unit` | Unit test generation and execution |
|
|
267
|
+
| `/onion:test:integration` | Integration test workflows |
|
|
268
|
+
| `/onion:test:e2e` | End-to-end test workflows |
|
|
269
|
+
|
|
270
|
+
### Validation
|
|
271
|
+
|
|
272
|
+
| Command | Description |
|
|
273
|
+
|---------|-------------|
|
|
274
|
+
| `/onion:validate:workflow` | Validate workflow completeness |
|
|
275
|
+
| `/onion:validate:test-strategy:create` | Create test strategy |
|
|
276
|
+
| `/onion:validate:test-strategy:analyze` | Analyze existing test strategy |
|
|
277
|
+
| `/onion:validate:qa-points:estimate` | QA story points estimation |
|
|
278
|
+
| `/onion:validate:collab:three-amigos` | Three Amigos collaboration session |
|
|
279
|
+
| `/onion:validate:collab:pair-testing` | Pair testing session |
|
|
280
|
+
|
|
281
|
+
### Meta
|
|
282
|
+
|
|
283
|
+
| Command | Description |
|
|
284
|
+
|---------|-------------|
|
|
285
|
+
| `/onion:meta:create-agent` | Create new AI agents for the framework |
|
|
286
|
+
| `/onion:meta:create-command` | Create new commands |
|
|
287
|
+
| `/onion:meta:create-knowledge-base` | Create structured knowledge bases via research |
|
|
288
|
+
| `/onion:meta:create-abstraction` | Create abstraction layers |
|
|
289
|
+
| `/onion:meta:analyze-complex-problem` | Structured analysis of complex problems |
|
|
290
|
+
| `/onion:meta:setup-integration` | Configure task manager and API integrations |
|
|
291
|
+
|
|
292
|
+
## Agents
|
|
293
|
+
|
|
294
|
+
Onion includes 45 specialized agents organized by domain:
|
|
295
|
+
|
|
296
|
+
| Category | Agents | Examples |
|
|
297
|
+
|----------|--------|---------|
|
|
298
|
+
| **Development** (17) | Full-stack specialists | React, Node.js, Nx monorepo, Docker, Mermaid diagrams |
|
|
299
|
+
| **Product** (8) | Product workflow | Product management, storytelling, branding, meeting extraction |
|
|
300
|
+
| **Compliance** (5) | Standards and audit | ISO 27001, SOC2, PMBOK, corporate compliance |
|
|
301
|
+
| **Meta** (4) | Framework management | Agent creator, command creator, gate keeper, onion orchestrator |
|
|
302
|
+
| **Git** (4) | Branch operations | Code review, documentation, test planning, metaspec checking |
|
|
303
|
+
| **Testing** (3) | Quality assurance | Test agent, test engineer, test planner |
|
|
304
|
+
| **Review** (2) | Code quality | Code reviewer, compliance reviewer |
|
|
305
|
+
| **Deployment** (1) | Infrastructure | Docker specialist |
|
|
306
|
+
| **Research** (1) | Investigation | Multi-source research and analysis |
|
|
307
|
+
|
|
308
|
+
Use `@onion` to access the master orchestrator that knows all agents and can route your request to the right specialist.
|
|
309
|
+
|
|
310
|
+
## Skills
|
|
311
|
+
|
|
312
|
+
| Skill | Description |
|
|
313
|
+
|-------|-------------|
|
|
314
|
+
| `onion-codebase-visualizer` | Interactive collapsible tree visualization of your codebase |
|
|
315
|
+
| `onion-db-schema-visualizer` | ERD generation from Prisma, TypeORM, or raw SQL |
|
|
316
|
+
| `onion-collect` | Structured feature idea and bug collection |
|
|
317
|
+
| `onion-create-prd` | Product Requirements Document creation |
|
|
318
|
+
| `onion-refine-prd` | PRD refinement and improvement |
|
|
319
|
+
| `onion-create-rule` | Claude Code rule creation with best practices |
|
|
320
|
+
| `onion-sync-meetings` | Meeting transcript synchronization |
|
|
321
|
+
|
|
322
|
+
## Task Manager Integration
|
|
323
|
+
|
|
324
|
+
Onion supports multiple task management providers through an abstraction layer:
|
|
325
|
+
|
|
326
|
+
| Provider | Status | Detection |
|
|
327
|
+
|----------|--------|-----------|
|
|
328
|
+
| **ClickUp** | Supported (via MCP) | 9-char alphanumeric task IDs |
|
|
329
|
+
| **Asana** | Supported (via MCP) | 15+ digit numeric IDs |
|
|
330
|
+
| **Linear** | Supported (via API) | Custom prefix IDs (e.g., ABC-123) |
|
|
331
|
+
| **None** | Offline mode | Local-only task tracking |
|
|
332
|
+
|
|
333
|
+
Configure your provider with `onion init` or by editing `.onion/config.yaml`.
|
|
334
|
+
|
|
335
|
+
## Workflows
|
|
336
|
+
|
|
337
|
+
### Feature Development (most common)
|
|
338
|
+
|
|
339
|
+
```
|
|
340
|
+
/onion:product:task # Create the task
|
|
341
|
+
/onion:engineer:start # Start development session
|
|
342
|
+
/onion:engineer:work # Continue working (resume context)
|
|
343
|
+
/onion:engineer:pre-pr # Validate before PR
|
|
344
|
+
/onion:engineer:pr # Create the Pull Request
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
### Hotfix (urgent production fix)
|
|
348
|
+
|
|
349
|
+
```
|
|
350
|
+
/onion:engineer:hotfix # Creates task + hotfix branch + starts dev
|
|
351
|
+
/onion:engineer:work # Fix the issue
|
|
352
|
+
/onion:engineer:pr # Create PR
|
|
353
|
+
/onion:git:hotfix:finish # Merge to main and develop
|
|
354
|
+
```
|
|
355
|
+
|
|
356
|
+
### New Project Setup
|
|
357
|
+
|
|
358
|
+
```
|
|
359
|
+
onion init # Configure project (.onion/)
|
|
360
|
+
/onion:warm-up # Load project context
|
|
361
|
+
/onion:product:collect # Collect initial requirements
|
|
362
|
+
/onion:product:check # Verify requirements
|
|
363
|
+
/onion:product:refine # Refine through questions
|
|
364
|
+
/onion:docs:build-business-docs # Generate business docs
|
|
365
|
+
/onion:docs:build-tech-docs # Generate tech docs
|
|
366
|
+
/onion:product:spec # Write specifications
|
|
367
|
+
/onion:product:light-arch # Design architecture
|
|
368
|
+
/onion:product:task # Create tasks
|
|
369
|
+
/onion:engineer:start # Begin development
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### Documentation
|
|
373
|
+
|
|
374
|
+
```
|
|
375
|
+
/onion:docs:build-tech-docs # Technical documentation
|
|
376
|
+
/onion:docs:build-business-docs # Business documentation
|
|
377
|
+
/onion:docs:build-compliance-docs # Compliance docs
|
|
378
|
+
/onion:docs:build-index # Update indexes
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
## How It Works
|
|
382
|
+
|
|
383
|
+
### Installation Layout
|
|
384
|
+
|
|
385
|
+
When you run `onion install`, the framework installs into your Claude Code global config:
|
|
386
|
+
|
|
387
|
+
```
|
|
388
|
+
~/.claude/
|
|
389
|
+
├── commands/
|
|
390
|
+
│ └── onion/ ← 88 commands (accessible as /onion:*)
|
|
391
|
+
│ ├── product/
|
|
392
|
+
│ ├── engineer/
|
|
393
|
+
│ ├── git/
|
|
394
|
+
│ ├── docs/
|
|
395
|
+
│ ├── test/
|
|
396
|
+
│ └── ...
|
|
397
|
+
├── agents/
|
|
398
|
+
│ └── onion/ ← 45 specialized agents
|
|
399
|
+
│ ├── development/
|
|
400
|
+
│ ├── product/
|
|
401
|
+
│ ├── compliance/
|
|
402
|
+
│ └── ...
|
|
403
|
+
├── skills/
|
|
404
|
+
│ ├── onion-codebase-visualizer/
|
|
405
|
+
│ ├── onion-collect/
|
|
406
|
+
│ └── ... ← 8 skills (onion- prefix)
|
|
407
|
+
├── onion/ ← Framework home
|
|
408
|
+
│ ├── CLAUDE.md ← Framework entry point
|
|
409
|
+
│ ├── docs/ ← Reference documentation
|
|
410
|
+
│ ├── utils/ ← Task manager abstraction, utilities
|
|
411
|
+
│ ├── rules/ ← Default rules and patterns
|
|
412
|
+
│ └── manifest.json ← Installation metadata
|
|
413
|
+
└── CLAUDE.md ← Patched to load framework
|
|
414
|
+
```
|
|
415
|
+
|
|
416
|
+
### Namespacing
|
|
417
|
+
|
|
418
|
+
- **Commands** use the `onion:` prefix: `/onion:product:task`, `/onion:engineer:start`
|
|
419
|
+
- **Skills** use the `onion-` prefix: `onion-codebase-visualizer`, `onion-collect`
|
|
420
|
+
- **Agents** live under `onion/` namespace
|
|
421
|
+
|
|
422
|
+
This prevents conflicts with your own commands, skills, or other frameworks.
|
|
423
|
+
|
|
424
|
+
### Non-Destructive
|
|
425
|
+
|
|
426
|
+
- Install patches `~/.claude/CLAUDE.md` with a clearly marked block
|
|
427
|
+
- Uninstall removes only Onion files and restores CLAUDE.md
|
|
428
|
+
- Your existing Claude Code configuration is never overwritten
|
|
429
|
+
|
|
430
|
+
## CLI Reference
|
|
431
|
+
|
|
432
|
+
```
|
|
433
|
+
Usage: onion [options] [command]
|
|
434
|
+
|
|
435
|
+
Options:
|
|
436
|
+
-V, --version output the version number
|
|
437
|
+
-h, --help display help for command
|
|
438
|
+
|
|
439
|
+
Commands:
|
|
440
|
+
install [options] Install the Onion Framework into ~/.claude/
|
|
441
|
+
uninstall [options] Remove the Onion Framework from ~/.claude/
|
|
442
|
+
init [options] Initialize project configuration (.onion/)
|
|
443
|
+
doctor Check installation health and prerequisites
|
|
444
|
+
update Update the Onion Framework to the latest version
|
|
445
|
+
list [options] List installed framework components
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
### `onion install`
|
|
449
|
+
|
|
450
|
+
```
|
|
451
|
+
Options:
|
|
452
|
+
--force Overwrite existing installation
|
|
453
|
+
--dry-run Show what would be installed without making changes
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
### `onion init`
|
|
457
|
+
|
|
458
|
+
```
|
|
459
|
+
Options:
|
|
460
|
+
--force Overwrite existing .onion/ configuration
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
Interactive setup that creates `.onion/config.yaml` (team settings) and `.onion/.env` (secrets). Automatically patches `.gitignore` to exclude `.onion/.env`.
|
|
464
|
+
|
|
465
|
+
### `onion uninstall`
|
|
466
|
+
|
|
467
|
+
```
|
|
468
|
+
Options:
|
|
469
|
+
--keep-config Keep user customizations in ~/.claude/onion/config/
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
### `onion list`
|
|
473
|
+
|
|
474
|
+
```
|
|
475
|
+
Options:
|
|
476
|
+
--commands List only commands
|
|
477
|
+
--agents List only agents
|
|
478
|
+
--skills List only skills
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
## Development
|
|
482
|
+
|
|
483
|
+
### Project Structure
|
|
484
|
+
|
|
485
|
+
```
|
|
486
|
+
├── bin/onion.js # CLI entry point
|
|
487
|
+
├── src/
|
|
488
|
+
│ ├── cli.js # Command router (Commander.js)
|
|
489
|
+
│ ├── commands/ # CLI command implementations
|
|
490
|
+
│ └── utils/ # Shared utilities
|
|
491
|
+
├── framework/ # Publishable framework files (auto-generated)
|
|
492
|
+
├── scripts/
|
|
493
|
+
│ └── sync-framework.js # Syncs .claude/ → framework/
|
|
494
|
+
├── .claude/ # Development source (working copy)
|
|
495
|
+
└── package.json
|
|
496
|
+
```
|
|
497
|
+
|
|
498
|
+
### Building
|
|
499
|
+
|
|
500
|
+
The `framework/` directory is auto-generated from `.claude/`:
|
|
501
|
+
|
|
502
|
+
```bash
|
|
503
|
+
npm run sync
|
|
504
|
+
```
|
|
505
|
+
|
|
506
|
+
This runs automatically before `npm publish`.
|
|
507
|
+
|
|
508
|
+
### Adding New Commands
|
|
509
|
+
|
|
510
|
+
1. Create the command in `.claude/commands/<category>/<name>.md`
|
|
511
|
+
2. Run `npm run sync` to update `framework/`
|
|
512
|
+
3. Run `onion install --force` to test locally
|
|
513
|
+
|
|
514
|
+
### Adding New Agents
|
|
515
|
+
|
|
516
|
+
1. Create the agent in `.claude/agents/<category>/<name>.md`
|
|
517
|
+
2. Run `npm run sync` to update `framework/`
|
|
518
|
+
3. Run `onion install --force` to test locally
|
|
519
|
+
|
|
520
|
+
## Requirements
|
|
521
|
+
|
|
522
|
+
- **Node.js** >= 18 (required)
|
|
523
|
+
- **Git** (required for GitFlow commands)
|
|
524
|
+
- **Claude Code** (required — this is a Claude Code framework)
|
|
525
|
+
- **Python 3** (optional — only needed for specific commands)
|
|
526
|
+
|
|
527
|
+
## License
|
|
528
|
+
|
|
529
|
+
MIT
|
package/bin/onion.js
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Onion Framework
|
|
2
|
+
|
|
3
|
+
You have the Onion Framework installed. This is an AI-powered development workflow system
|
|
4
|
+
that provides structured commands, specialized agents, and skills for software development.
|
|
5
|
+
|
|
6
|
+
## Quick Reference
|
|
7
|
+
|
|
8
|
+
### Entry Points
|
|
9
|
+
- `/onion` — Intelligent system entry point. Ask anything.
|
|
10
|
+
- `/onion:warm-up` — Load project context
|
|
11
|
+
|
|
12
|
+
### Product Workflow
|
|
13
|
+
- `/onion:product:collect` — Collect feature ideas or bugs
|
|
14
|
+
- `/onion:product:refine` — Refine requirements
|
|
15
|
+
- `/onion:product:spec` — Create product specification
|
|
16
|
+
- `/onion:product:task` — Create structured tasks
|
|
17
|
+
- `/onion:product:estimate` — Story point estimation
|
|
18
|
+
|
|
19
|
+
### Engineering Workflow
|
|
20
|
+
- `/onion:engineer:start` — Start feature development
|
|
21
|
+
- `/onion:engineer:plan` — Plan feature implementation
|
|
22
|
+
- `/onion:engineer:work` — Continue active feature
|
|
23
|
+
- `/onion:engineer:pre-pr` — Pre-PR validation
|
|
24
|
+
- `/onion:engineer:pr` — Create Pull Request
|
|
25
|
+
|
|
26
|
+
### Git Workflow
|
|
27
|
+
- `/onion:git:feature:start` — Start feature branch
|
|
28
|
+
- `/onion:git:feature:finish` — Finish feature
|
|
29
|
+
- `/onion:git:fast-commit` — Quick commit
|
|
30
|
+
- `/onion:git:sync` — Sync with remote
|
|
31
|
+
|
|
32
|
+
### Documentation
|
|
33
|
+
- `/onion:docs:build-tech-docs` — Generate technical docs
|
|
34
|
+
- `/onion:docs:build-business-docs` — Generate business docs
|
|
35
|
+
|
|
36
|
+
### Testing
|
|
37
|
+
- `/onion:test:unit` — Run unit tests
|
|
38
|
+
- `/onion:test:integration` — Run integration tests
|
|
39
|
+
- `/onion:test:e2e` — Run E2E tests
|
|
40
|
+
|
|
41
|
+
## Agents
|
|
42
|
+
Use `@onion` to access the master orchestrator agent that knows all framework capabilities.
|
|
43
|
+
|
|
44
|
+
## Documentation
|
|
45
|
+
Full documentation is available at ~/.claude/onion/docs/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
1.0.0-beta.1
|