ironweave 1.0.0
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/.claude-plugin/plugin.json +16 -0
- package/.clinerules +7 -0
- package/.codex/INSTALL.md +45 -0
- package/.cursor-plugin/plugin.json +19 -0
- package/.cursorrules +7 -0
- package/.github/copilot-instructions.md +7 -0
- package/.opencode/INSTALL.md +42 -0
- package/.windsurfrules +7 -0
- package/AGENTS.md +1 -0
- package/CLAUDE.md +22 -0
- package/CONTRIBUTING.md +81 -0
- package/GEMINI.md +1 -0
- package/LICENSE +21 -0
- package/README.md +250 -0
- package/README_CN.md +248 -0
- package/package.json +48 -0
- package/skills/api-contract-design/SKILL.md +227 -0
- package/skills/api-contract-design/references/api-design-rules.md +106 -0
- package/skills/brainstorm/SKILL.md +271 -0
- package/skills/brainstorm/agents/architect.md +34 -0
- package/skills/brainstorm/agents/challenger.md +34 -0
- package/skills/brainstorm/agents/domain-expert.md +34 -0
- package/skills/brainstorm/agents/pragmatist.md +34 -0
- package/skills/brainstorm/agents/product-manager.md +34 -0
- package/skills/brainstorm/agents/ux-designer.md +34 -0
- package/skills/brainstorm/references/synthesis-rules.md +51 -0
- package/skills/code-scaffold/SKILL.md +313 -0
- package/skills/code-scaffold/references/scaffold-rules.md +131 -0
- package/skills/docs-output/SKILL.md +149 -0
- package/skills/docs-output/references/naming-rules.md +52 -0
- package/skills/docs-output/scripts/docs_manager.py +353 -0
- package/skills/engineering-principles/SKILL.md +133 -0
- package/skills/engineering-principles/references/anti-patterns.md +144 -0
- package/skills/engineering-principles/references/ddd-patterns.md +66 -0
- package/skills/engineering-principles/references/design-patterns.md +34 -0
- package/skills/engineering-principles/references/patterns-architecture.md +301 -0
- package/skills/engineering-principles/references/patterns-backend.md +77 -0
- package/skills/engineering-principles/references/patterns-classic.md +200 -0
- package/skills/engineering-principles/references/patterns-crosscut.md +67 -0
- package/skills/engineering-principles/references/patterns-frontend.md +27 -0
- package/skills/engineering-principles/references/patterns-module.md +95 -0
- package/skills/engineering-principles/references/patterns-small-scale.md +79 -0
- package/skills/engineering-principles/references/quality-checklist.md +76 -0
- package/skills/engineering-principles/references/solid-principles.md +46 -0
- package/skills/engineering-principles/references/tdd-workflow.md +60 -0
- package/skills/engineering-principles/scripts/principles_matcher.py +433 -0
- package/skills/error-handling-strategy/SKILL.md +347 -0
- package/skills/error-handling-strategy/references/error-handling-rules.md +91 -0
- package/skills/implementation-complexity-analysis/SKILL.md +193 -0
- package/skills/implementation-complexity-analysis/references/complexity-rules.md +126 -0
- package/skills/integration-test-design/SKILL.md +296 -0
- package/skills/integration-test-design/references/test-strategy-rules.md +90 -0
- package/skills/observability-design/SKILL.md +327 -0
- package/skills/observability-design/references/observability-rules.md +129 -0
- package/skills/orchestrator/SKILL.md +260 -0
- package/skills/orchestrator/references/deliver.md +112 -0
- package/skills/orchestrator/references/execute.md +313 -0
- package/skills/orchestrator/references/gates.md +252 -0
- package/skills/orchestrator/references/parallel.md +70 -0
- package/skills/orchestrator/references/route-a.md +135 -0
- package/skills/orchestrator/references/route-b.md +91 -0
- package/skills/orchestrator/references/route-c.md +65 -0
- package/skills/orchestrator/references/route-d.md +75 -0
- package/skills/orchestrator/references/scope-sizer.md +219 -0
- package/skills/performance-arch-design/SKILL.md +208 -0
- package/skills/performance-arch-design/references/performance-rules.md +95 -0
- package/skills/project-context/SKILL.md +104 -0
- package/skills/project-context/references/schema.md +97 -0
- package/skills/project-context/scripts/context_db.py +358 -0
- package/skills/requirement-qa/SKILL.md +287 -0
- package/skills/requirement-qa/references/completion-signals.md +42 -0
- package/skills/requirement-qa/references/option-rules.md +57 -0
- package/skills/requirement-qa/scripts/qa_session.py +223 -0
- package/skills/skill-creator/LICENSE.txt +202 -0
- package/skills/skill-creator/SKILL.md +485 -0
- package/skills/skill-creator/agents/analyzer.md +274 -0
- package/skills/skill-creator/agents/comparator.md +202 -0
- package/skills/skill-creator/agents/grader.md +223 -0
- package/skills/skill-creator/assets/eval_review.html +146 -0
- package/skills/skill-creator/eval-viewer/generate_review.py +471 -0
- package/skills/skill-creator/eval-viewer/viewer.html +1325 -0
- package/skills/skill-creator/references/schemas.md +430 -0
- package/skills/skill-creator/scripts/__init__.py +0 -0
- package/skills/skill-creator/scripts/aggregate_benchmark.py +401 -0
- package/skills/skill-creator/scripts/generate_report.py +326 -0
- package/skills/skill-creator/scripts/improve_description.py +247 -0
- package/skills/skill-creator/scripts/package_skill.py +136 -0
- package/skills/skill-creator/scripts/quick_validate.py +103 -0
- package/skills/skill-creator/scripts/run_eval.py +310 -0
- package/skills/skill-creator/scripts/run_loop.py +328 -0
- package/skills/skill-creator/scripts/utils.py +47 -0
- package/skills/spec-writing/SKILL.md +96 -0
- package/skills/spec-writing/references/mermaid-guide.md +66 -0
- package/skills/spec-writing/references/test-matrix.md +73 -0
- package/skills/task-difficulty/SKILL.md +162 -0
- package/skills/task-difficulty/references/scoring-guide.md +123 -0
- package/skills/task-difficulty/scripts/difficulty_scorer.py +328 -0
- package/skills/tech-stack/SKILL.md +67 -0
- package/skills/tech-stack/references/tech-reference-tables.md +130 -0
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "ironweave",
|
|
3
|
+
"description": "Agentic skills framework for software development: orchestration, requirements, architecture, TDD, and quality gates",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"homepage": "https://github.com/YuluoY/ironware",
|
|
6
|
+
"repository": "https://github.com/YuluoY/ironware",
|
|
7
|
+
"license": "MIT",
|
|
8
|
+
"keywords": [
|
|
9
|
+
"skills",
|
|
10
|
+
"orchestrator",
|
|
11
|
+
"tdd",
|
|
12
|
+
"architecture",
|
|
13
|
+
"quality-gates",
|
|
14
|
+
"workflows"
|
|
15
|
+
]
|
|
16
|
+
}
|
package/.clinerules
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Ironweave
|
|
2
|
+
|
|
3
|
+
You have access to the Ironweave skills library — a complete software development workflow with built-in quality gates.
|
|
4
|
+
|
|
5
|
+
The **orchestrator** skill (`skills/orchestrator/SKILL.md`) is the main entry point. For any development task, start by reading it. The orchestrator automatically senses context, scores difficulty, selects the right route, and runs Plan → Execute → Validate → Deliver with quality gates.
|
|
6
|
+
|
|
7
|
+
All skills are in `skills/`, each with a `SKILL.md` containing instructions.
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Installing Ironweave for Codex
|
|
2
|
+
|
|
3
|
+
## Installation
|
|
4
|
+
|
|
5
|
+
1. **Clone the repository:**
|
|
6
|
+
```bash
|
|
7
|
+
git clone https://github.com/YuluoY/ironware.git ~/.codex/ironweave
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
2. **Create the skills symlink:**
|
|
11
|
+
```bash
|
|
12
|
+
mkdir -p ~/.agents/skills
|
|
13
|
+
ln -s ~/.codex/ironweave/skills ~/.agents/skills/ironweave
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
**Windows (PowerShell):**
|
|
17
|
+
```powershell
|
|
18
|
+
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.agents\skills"
|
|
19
|
+
cmd /c mklink /J "$env:USERPROFILE\.agents\skills\ironweave" "$env:USERPROFILE\.codex\ironweave\skills"
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
3. **Restart Codex** to discover the skills.
|
|
23
|
+
|
|
24
|
+
## Verify
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
ls -la ~/.agents/skills/ironweave
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
You should see a symlink pointing to the Ironweave skills directory.
|
|
31
|
+
|
|
32
|
+
## Updating
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
cd ~/.codex/ironweave && git pull
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
Skills update instantly through the symlink.
|
|
39
|
+
|
|
40
|
+
## Uninstalling
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
rm ~/.agents/skills/ironweave
|
|
44
|
+
rm -rf ~/.codex/ironweave
|
|
45
|
+
```
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "ironweave",
|
|
3
|
+
"displayName": "Ironweave",
|
|
4
|
+
"description": "Agentic skills framework for software development: orchestration, requirements, architecture, TDD, and quality gates",
|
|
5
|
+
"version": "1.0.0",
|
|
6
|
+
"homepage": "https://github.com/YuluoY/ironware",
|
|
7
|
+
"repository": "https://github.com/YuluoY/ironware",
|
|
8
|
+
"license": "MIT",
|
|
9
|
+
"keywords": [
|
|
10
|
+
"skills",
|
|
11
|
+
"orchestrator",
|
|
12
|
+
"tdd",
|
|
13
|
+
"architecture",
|
|
14
|
+
"quality-gates",
|
|
15
|
+
"workflows"
|
|
16
|
+
],
|
|
17
|
+
"skills": "./skills/",
|
|
18
|
+
"agents": "./agents/"
|
|
19
|
+
}
|
package/.cursorrules
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Ironweave
|
|
2
|
+
|
|
3
|
+
You have access to the Ironweave skills library — a complete software development workflow with built-in quality gates.
|
|
4
|
+
|
|
5
|
+
The **orchestrator** skill (`skills/orchestrator/SKILL.md`) is the main entry point. For any development task, start by reading it. The orchestrator automatically senses context, scores difficulty, selects the right route, and runs Plan → Execute → Validate → Deliver with quality gates.
|
|
6
|
+
|
|
7
|
+
All skills are in `skills/`, each with a `SKILL.md` containing instructions.
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Ironweave
|
|
2
|
+
|
|
3
|
+
You have access to the Ironweave skills library — a complete software development workflow with built-in quality gates.
|
|
4
|
+
|
|
5
|
+
The **orchestrator** skill (`skills/orchestrator/SKILL.md`) is the main entry point. For any development task, start by reading it. The orchestrator automatically senses context, scores difficulty, selects the right route, and runs Plan → Execute → Validate → Deliver with quality gates.
|
|
6
|
+
|
|
7
|
+
All skills are in `skills/`, each with a `SKILL.md` containing instructions.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Installing Ironweave for OpenCode
|
|
2
|
+
|
|
3
|
+
## Prerequisites
|
|
4
|
+
|
|
5
|
+
- [OpenCode.ai](https://opencode.ai) installed
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
Add ironweave to the `plugin` array in your `opencode.json` (global or project-level):
|
|
10
|
+
|
|
11
|
+
```json
|
|
12
|
+
{
|
|
13
|
+
"plugin": ["ironweave@git+https://github.com/YuluoY/ironware.git"]
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Restart OpenCode. The plugin auto-installs and registers all skills.
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
Use OpenCode's native `skill` tool:
|
|
22
|
+
|
|
23
|
+
```
|
|
24
|
+
use skill tool to list skills
|
|
25
|
+
use skill tool to load ironweave/orchestrator
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Updating
|
|
29
|
+
|
|
30
|
+
Ironweave updates automatically when you restart OpenCode.
|
|
31
|
+
|
|
32
|
+
To pin a specific version:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"plugin": ["ironweave@git+https://github.com/YuluoY/ironware.git#v1.0.0"]
|
|
37
|
+
}
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Uninstalling
|
|
41
|
+
|
|
42
|
+
Remove the plugin entry from your `opencode.json` and restart OpenCode.
|
package/.windsurfrules
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
# Ironweave
|
|
2
|
+
|
|
3
|
+
You have access to the Ironweave skills library — a complete software development workflow with built-in quality gates.
|
|
4
|
+
|
|
5
|
+
The **orchestrator** skill (`skills/orchestrator/SKILL.md`) is the main entry point. For any development task, start by reading it. The orchestrator automatically senses context, scores difficulty, selects the right route, and runs Plan → Execute → Validate → Deliver with quality gates.
|
|
6
|
+
|
|
7
|
+
All skills are in `skills/`, each with a `SKILL.md` containing instructions.
|
package/AGENTS.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
CLAUDE.md
|
package/CLAUDE.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Ironweave
|
|
2
|
+
|
|
3
|
+
You have access to the Ironweave skills library — a complete software development workflow with built-in quality gates.
|
|
4
|
+
|
|
5
|
+
## How to use
|
|
6
|
+
|
|
7
|
+
The **orchestrator** skill (`skills/orchestrator/SKILL.md`) is the main entry point. It automatically:
|
|
8
|
+
- Senses project context and scores task difficulty
|
|
9
|
+
- Selects the right route (new project / new feature / bug fix / refactoring)
|
|
10
|
+
- Runs Plan → Execute → Validate → Deliver with quality gates per slice
|
|
11
|
+
|
|
12
|
+
For any development task, start by reading the orchestrator skill. It will guide which other skills to invoke.
|
|
13
|
+
|
|
14
|
+
## Skills available
|
|
15
|
+
|
|
16
|
+
All skills are in `skills/`. Each has a `SKILL.md` with YAML frontmatter (`name`, `description`).
|
|
17
|
+
|
|
18
|
+
Key skills: `orchestrator`, `requirement-qa`, `brainstorm`, `spec-writing`, `tech-stack`, `engineering-principles`, `api-contract-design`, `code-scaffold`, `error-handling-strategy`, `performance-arch-design`, `observability-design`, `integration-test-design`, `implementation-complexity-analysis`, `task-difficulty`, `project-context`, `docs-output`, `skill-creator`.
|
|
19
|
+
|
|
20
|
+
## Contributing
|
|
21
|
+
|
|
22
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md).
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Contributing to Ironweave
|
|
2
|
+
|
|
3
|
+
Thank you for your interest in contributing! Ironweave welcomes contributions from everyone.
|
|
4
|
+
|
|
5
|
+
## Ways to Contribute
|
|
6
|
+
|
|
7
|
+
- **Report bugs** — Open an issue describing the problem
|
|
8
|
+
- **Suggest skills** — Propose new skills or improvements to existing ones
|
|
9
|
+
- **Submit PRs** — Fix bugs, improve documentation, or add features
|
|
10
|
+
- **Translate** — Help improve Chinese/English documentation
|
|
11
|
+
|
|
12
|
+
## Development Setup
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
git clone https://github.com/YuluoY/ironware.git
|
|
16
|
+
cd ironweave
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
No build step required — skills are plain Markdown files.
|
|
20
|
+
|
|
21
|
+
## Skill Structure
|
|
22
|
+
|
|
23
|
+
Each skill is a directory under `skills/` containing at minimum a `SKILL.md` file:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
skills/my-skill/
|
|
27
|
+
├── SKILL.md # Required: main skill file with YAML frontmatter
|
|
28
|
+
├── references/ # Optional: supporting documents
|
|
29
|
+
│ └── rules.md
|
|
30
|
+
├── agents/ # Optional: SubAgent definitions
|
|
31
|
+
│ └── expert.md
|
|
32
|
+
└── scripts/ # Optional: helper scripts
|
|
33
|
+
└── helper.py
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### SKILL.md Frontmatter (Required)
|
|
37
|
+
|
|
38
|
+
```yaml
|
|
39
|
+
---
|
|
40
|
+
name: my-skill
|
|
41
|
+
description: >-
|
|
42
|
+
One-paragraph description of what this skill does and when to use it.
|
|
43
|
+
---
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Both `name` and `description` are required for [skills.sh](https://skills.sh) compatibility.
|
|
47
|
+
|
|
48
|
+
## Guidelines
|
|
49
|
+
|
|
50
|
+
1. **One skill, one concern** — Each skill should do one thing well
|
|
51
|
+
2. **Include trigger phrases** — The `description` field should list scenarios that activate the skill
|
|
52
|
+
3. **Reference, don't duplicate** — Use `references/` for shared rules; don't copy content across skills
|
|
53
|
+
4. **Test your changes** — Verify skills work with at least one agent before submitting
|
|
54
|
+
5. **Bilingual** — New skills should include both English and Chinese content where practical
|
|
55
|
+
|
|
56
|
+
## Orchestrator Changes
|
|
57
|
+
|
|
58
|
+
Changes to the orchestrator skill (`skills/orchestrator/`) require extra care:
|
|
59
|
+
|
|
60
|
+
- Ensure all 4 routes (A/B/C/D) remain consistent
|
|
61
|
+
- Verify quality gates in `references/gates.md` still cover all paths
|
|
62
|
+
- Check that reflow arrows point to correct targets
|
|
63
|
+
- Run through at least one scenario per route mentally
|
|
64
|
+
|
|
65
|
+
## Commit Messages
|
|
66
|
+
|
|
67
|
+
Use conventional commits:
|
|
68
|
+
|
|
69
|
+
```
|
|
70
|
+
feat(brainstorm): add devil's advocate role
|
|
71
|
+
fix(orchestrator): correct reflow target for need-level failures
|
|
72
|
+
docs(readme): update compatibility table
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Code of Conduct
|
|
76
|
+
|
|
77
|
+
Be respectful, constructive, and inclusive. We follow the [Contributor Covenant](https://www.contributor-covenant.org/).
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
Questions? Open an issue or start a discussion.
|
package/GEMINI.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
@./skills/orchestrator/SKILL.md
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Ironweave Contributors
|
|
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,250 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<h1 align="center">Ironweave</h1>
|
|
3
|
+
<p align="center">
|
|
4
|
+
An agentic skills framework & software development methodology for your AI coding agents.
|
|
5
|
+
</p>
|
|
6
|
+
<p align="center">
|
|
7
|
+
<a href="./README_CN.md">中文文档</a> · <a href="https://skills.sh">skills.sh</a> · <a href="#installation">Install</a> · <a href="./LICENSE">MIT License</a>
|
|
8
|
+
</p>
|
|
9
|
+
</p>
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
Ironweave is a complete software development workflow for your coding agents, built on top of a set of composable **skills**. It doesn't just write code — it steps back, understands what you're building, plans the work, breaks it into slices, and executes each slice with built-in quality gates. And because the skills trigger automatically, you don't need to do anything special. Your coding agent just has Ironweave.
|
|
14
|
+
|
|
15
|
+
## How it works
|
|
16
|
+
|
|
17
|
+
It starts from the moment you give your agent a task. The **orchestrator** skill activates and:
|
|
18
|
+
|
|
19
|
+
1. **Senses context** — Detects project type (new project, new feature, bug fix, or refactoring) via `project-context`
|
|
20
|
+
2. **Scores difficulty** — Rates the task 1-10 via `task-difficulty`, selecting a variant (lite / standard / plus)
|
|
21
|
+
3. **Clarifies requirements** — For ambiguous or complex tasks, uses `requirement-qa` and `brainstorm` to nail down scope before coding
|
|
22
|
+
4. **Slices scope** — Breaks large tasks into ordered slices (by module dependency), each independently deliverable
|
|
23
|
+
5. **Routes** — Picks one of four routes (A: new project, B: new feature, C: bug fix, D: refactoring) with route-specific skill chains
|
|
24
|
+
6. **Executes per slice** — Each slice goes through Plan → Execute → Validate → Deliver with quality gates at each transition
|
|
25
|
+
|
|
26
|
+
If validation fails, work **reflows** to the right level — code-level issues go back to Execute, design-level back to Plan, requirement-level back to scope. No blind retries.
|
|
27
|
+
|
|
28
|
+
## The Workflow
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
User Request
|
|
32
|
+
│
|
|
33
|
+
▼
|
|
34
|
+
Context Sensing → Difficulty Scoring → Clarify (if needed) → Scope Slicing
|
|
35
|
+
│
|
|
36
|
+
▼
|
|
37
|
+
┌──────────────────────────────────┐
|
|
38
|
+
│ Per-Slice Loop │
|
|
39
|
+
│ │
|
|
40
|
+
│ Route Selection (A/B/C/D) │
|
|
41
|
+
│ │ │
|
|
42
|
+
│ ▼ │
|
|
43
|
+
│ Plan ──── Gate ──── Execute │
|
|
44
|
+
│ │ │
|
|
45
|
+
│ Gate │
|
|
46
|
+
│ │ │
|
|
47
|
+
│ Validate │
|
|
48
|
+
│ │ │
|
|
49
|
+
│ Deliver │
|
|
50
|
+
└──────────────────────────────────┘
|
|
51
|
+
│
|
|
52
|
+
▼
|
|
53
|
+
Done (or next slice)
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
### Three Variants
|
|
57
|
+
|
|
58
|
+
| Difficulty | Variant | What changes |
|
|
59
|
+
|-----------|---------|-------------|
|
|
60
|
+
| L1-L2 (easy) | **lite** | Skip optional skills, quick self-review, no mandatory TDD |
|
|
61
|
+
| L3 (medium) | **standard** | Full skill chain, mandatory TDD, standard review |
|
|
62
|
+
| L4-L5 (hard) | **plus** | SubAgent isolation per task, strict TDD, two-stage review, parallel strategy |
|
|
63
|
+
|
|
64
|
+
## What's Inside
|
|
65
|
+
|
|
66
|
+
### Skills Library
|
|
67
|
+
|
|
68
|
+
**Orchestration**
|
|
69
|
+
|
|
70
|
+
- `orchestrator` — Full-lifecycle flow orchestrator (routes, quality gates, reflow, slice iteration)
|
|
71
|
+
|
|
72
|
+
**Requirements & Design**
|
|
73
|
+
|
|
74
|
+
- `requirement-qa` — Multi-round Q&A to elicit and refine requirements
|
|
75
|
+
- `brainstorm` — Multi-perspective brainstorming with expert SubAgents
|
|
76
|
+
- `spec-writing` — Structured feature specification documents
|
|
77
|
+
- `tech-stack` — Full-stack technology selection & decision docs
|
|
78
|
+
|
|
79
|
+
**Architecture & Engineering**
|
|
80
|
+
|
|
81
|
+
- `engineering-principles` — Context-aware principles matcher (SOLID, DDD, TDD, design patterns)
|
|
82
|
+
- `api-contract-design` — RESTful/GraphQL API contracts, DTOs, OpenAPI specs
|
|
83
|
+
- `error-handling-strategy` — Exception hierarchy, error codes, retry, circuit-breaker, fallback
|
|
84
|
+
- `performance-arch-design` — Cache layering, async processing, indexing, rate limiting
|
|
85
|
+
- `observability-design` — Distributed tracing, structured logging, metrics, alerting
|
|
86
|
+
|
|
87
|
+
**Implementation**
|
|
88
|
+
|
|
89
|
+
- `code-scaffold` — Project scaffolding from domain model + design docs
|
|
90
|
+
- `implementation-complexity-analysis` — Technical risk identification, complexity decomposition
|
|
91
|
+
- `integration-test-design` — TestContainers, contract testing, mock strategy
|
|
92
|
+
|
|
93
|
+
**Meta**
|
|
94
|
+
|
|
95
|
+
- `task-difficulty` — Multi-dimensional difficulty scoring (1-10)
|
|
96
|
+
- `project-context` — Project structure awareness & cross-session persistence
|
|
97
|
+
- `docs-output` — Document output management (modular docs/ organization)
|
|
98
|
+
- `skill-creator` — Create, modify, and evaluate agent skills
|
|
99
|
+
|
|
100
|
+
## Installation
|
|
101
|
+
|
|
102
|
+
### Via skills.sh (Recommended)
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
# Install all skills
|
|
106
|
+
npx skills add YuluoY/ironware
|
|
107
|
+
|
|
108
|
+
# Install specific skills
|
|
109
|
+
npx skills add YuluoY/ironware --skill orchestrator --skill brainstorm
|
|
110
|
+
|
|
111
|
+
# List available skills
|
|
112
|
+
npx skills add YuluoY/ironware --list
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Supports **40+ agents**: Claude Code, GitHub Copilot, Cursor, Codex, Windsurf, Cline, OpenCode, Gemini CLI, Trae, CodeBuddy, and more.
|
|
116
|
+
|
|
117
|
+
### Per-Agent Manual Installation
|
|
118
|
+
|
|
119
|
+
<details>
|
|
120
|
+
<summary><b>Claude Code</b></summary>
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
git clone https://github.com/YuluoY/ironware.git ~/.claude/ironweave
|
|
124
|
+
mkdir -p ~/.claude/skills
|
|
125
|
+
ln -s ~/.claude/ironweave/skills ~/.claude/skills/ironweave
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Or use the Claude plugin system — Ironweave ships with `.claude-plugin/plugin.json`.
|
|
129
|
+
|
|
130
|
+
</details>
|
|
131
|
+
|
|
132
|
+
<details>
|
|
133
|
+
<summary><b>VS Code GitHub Copilot</b></summary>
|
|
134
|
+
|
|
135
|
+
Copy the `skills/` directory into your project, then add to `.github/copilot-instructions.md`:
|
|
136
|
+
|
|
137
|
+
```markdown
|
|
138
|
+
The orchestrator skill (skills/orchestrator/SKILL.md) is the main entry point.
|
|
139
|
+
For any development task, start by reading it.
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
Or clone Ironweave directly — it ships with `.github/copilot-instructions.md` pre-configured.
|
|
143
|
+
|
|
144
|
+
</details>
|
|
145
|
+
|
|
146
|
+
<details>
|
|
147
|
+
<summary><b>Cursor</b></summary>
|
|
148
|
+
|
|
149
|
+
```bash
|
|
150
|
+
git clone https://github.com/YuluoY/ironware.git
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Ironweave ships with `.cursorrules` and `.cursor-plugin/plugin.json` for auto-discovery.
|
|
154
|
+
|
|
155
|
+
</details>
|
|
156
|
+
|
|
157
|
+
<details>
|
|
158
|
+
<summary><b>Codex (OpenAI)</b></summary>
|
|
159
|
+
|
|
160
|
+
```bash
|
|
161
|
+
git clone https://github.com/YuluoY/ironware.git ~/.codex/ironweave
|
|
162
|
+
mkdir -p ~/.agents/skills
|
|
163
|
+
ln -s ~/.codex/ironweave/skills ~/.agents/skills/ironweave
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
See [.codex/INSTALL.md](./.codex/INSTALL.md) for details.
|
|
167
|
+
|
|
168
|
+
</details>
|
|
169
|
+
|
|
170
|
+
<details>
|
|
171
|
+
<summary><b>OpenCode</b></summary>
|
|
172
|
+
|
|
173
|
+
Add to your `opencode.json`:
|
|
174
|
+
|
|
175
|
+
```json
|
|
176
|
+
{
|
|
177
|
+
"plugin": ["ironweave@git+https://github.com/YuluoY/ironware.git"]
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
181
|
+
See [.opencode/INSTALL.md](./.opencode/INSTALL.md) for details.
|
|
182
|
+
|
|
183
|
+
</details>
|
|
184
|
+
|
|
185
|
+
<details>
|
|
186
|
+
<summary><b>Windsurf / Cline / Gemini CLI</b></summary>
|
|
187
|
+
|
|
188
|
+
Ironweave ships with `.windsurfrules`, `.clinerules`, and `GEMINI.md` respectively. Clone the repo and the agent auto-discovers the rules.
|
|
189
|
+
|
|
190
|
+
```bash
|
|
191
|
+
git clone https://github.com/YuluoY/ironware.git
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
</details>
|
|
195
|
+
|
|
196
|
+
<details>
|
|
197
|
+
<summary><b>Trae / CodeBuddy / Other Agents</b></summary>
|
|
198
|
+
|
|
199
|
+
Copy the `skills/` directory into your project. Then add the following to your agent's custom instructions:
|
|
200
|
+
|
|
201
|
+
> The orchestrator skill (`skills/orchestrator/SKILL.md`) is the main entry point. For any development task, start by reading it. All skills are in `skills/`, each with a `SKILL.md` containing instructions.
|
|
202
|
+
|
|
203
|
+
</details>
|
|
204
|
+
|
|
205
|
+
## Project Structure
|
|
206
|
+
|
|
207
|
+
```
|
|
208
|
+
ironweave/
|
|
209
|
+
├── skills/
|
|
210
|
+
│ ├── orchestrator/ # Flow orchestrator
|
|
211
|
+
│ │ ├── SKILL.md # Orchestrator logic
|
|
212
|
+
│ │ └── references/ # Methodology docs
|
|
213
|
+
│ ├── brainstorm/
|
|
214
|
+
│ ├── spec-writing/
|
|
215
|
+
│ ├── code-scaffold/
|
|
216
|
+
│ ├── ... # 16 more skills
|
|
217
|
+
│ └── skill-creator/
|
|
218
|
+
├── CLAUDE.md # Claude Code instructions
|
|
219
|
+
├── AGENTS.md # Codex instructions
|
|
220
|
+
├── GEMINI.md # Gemini CLI instructions
|
|
221
|
+
├── .github/copilot-instructions.md # VS Code Copilot
|
|
222
|
+
├── .cursorrules # Cursor rules
|
|
223
|
+
├── .windsurfrules # Windsurf rules
|
|
224
|
+
├── .clinerules # Cline rules
|
|
225
|
+
├── .claude-plugin/plugin.json # Claude plugin manifest
|
|
226
|
+
├── .cursor-plugin/plugin.json # Cursor plugin manifest
|
|
227
|
+
├── .codex/INSTALL.md # Codex install guide
|
|
228
|
+
├── .opencode/INSTALL.md # OpenCode install guide
|
|
229
|
+
├── README.md
|
|
230
|
+
├── README_CN.md
|
|
231
|
+
├── CONTRIBUTING.md
|
|
232
|
+
├── LICENSE
|
|
233
|
+
└── package.json
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
## Philosophy
|
|
237
|
+
|
|
238
|
+
- **Adaptive routing** over linear workflows — different task types need different flows
|
|
239
|
+
- **Quality gates with reflow** over pass/fail — failures route back to the right phase
|
|
240
|
+
- **Scope slicing** before execution — large tasks split into ordered, independently deliverable slices
|
|
241
|
+
- **Overhead scales with complexity** — simple tasks stay fast (lite), hard tasks get full rigor (plus)
|
|
242
|
+
- **Skills as methodology** — each skill encodes decision trees, not just templates
|
|
243
|
+
|
|
244
|
+
## Contributing
|
|
245
|
+
|
|
246
|
+
See [CONTRIBUTING.md](./CONTRIBUTING.md). Skills live directly in this repository. Follow `skills/skill-creator` for creating and testing new skills.
|
|
247
|
+
|
|
248
|
+
## License
|
|
249
|
+
|
|
250
|
+
[MIT](./LICENSE) © Ironweave Contributors
|