@givolt/i3-composer-agent 1.0.1 → 2.1.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/.agents/plugins/marketplace.json +1 -1
- package/.claude/commands/{build.md → i3-build.md} +10 -10
- package/.claude/commands/{code-simplify.md → i3-code-simplify.md} +2 -2
- package/.claude/commands/{constraints.md → i3-constraints.md} +4 -4
- package/.claude/commands/{plan.md → i3-plan.md} +1 -1
- package/.claude/commands/{review.md → i3-review.md} +3 -3
- package/.claude/commands/{ship.md → i3-ship.md} +4 -4
- package/.claude/commands/{spec.md → i3-spec.md} +1 -1
- package/.claude/commands/{test.md → i3-test.md} +2 -2
- package/.claude/commands/{webperf.md → i3-webperf.md} +1 -1
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +1 -1
- package/.gemini/commands/{build.toml → i3-build.toml} +10 -10
- package/.gemini/commands/{code-simplify.toml → i3-code-simplify.toml} +2 -2
- package/.gemini/commands/{constraints.toml → i3-constraints.toml} +4 -4
- package/.gemini/commands/{planning.toml → i3-planning.toml} +1 -1
- package/{commands/review.toml → .gemini/commands/i3-review.toml} +3 -3
- package/.gemini/commands/{ship.toml → i3-ship.toml} +4 -4
- package/.gemini/commands/{spec.toml → i3-spec.toml} +1 -1
- package/{commands/test.toml → .gemini/commands/i3-test.toml} +2 -2
- package/.gemini/commands/{webperf.toml → i3-webperf.toml} +1 -1
- package/README.md +72 -69
- package/agents/code-reviewer.md +2 -2
- package/agents/security-auditor.md +1 -1
- package/agents/test-engineer.md +1 -1
- package/agents/web-performance-auditor.md +3 -3
- package/bin/agent-targets.json +11 -0
- package/bin/asset-fingerprint.cjs +38 -0
- package/bin/cleanup-backups.cjs +16 -0
- package/bin/i3-composer-agent.cjs +29 -14
- package/bin/install.cjs +81 -19
- package/bin/native-content.cjs +29 -0
- package/bin/wizard.cjs +2 -1
- package/commands/{build.toml → i3-build.toml} +10 -10
- package/commands/{code-simplify.toml → i3-code-simplify.toml} +2 -2
- package/commands/{constraints.toml → i3-constraints.toml} +4 -4
- package/commands/{planning.toml → i3-planning.toml} +1 -1
- package/{.gemini/commands/review.toml → commands/i3-review.toml} +3 -3
- package/commands/{ship.toml → i3-ship.toml} +4 -4
- package/commands/{spec.toml → i3-spec.toml} +1 -1
- package/{.gemini/commands/test.toml → commands/i3-test.toml} +2 -2
- package/commands/{webperf.toml → i3-webperf.toml} +1 -1
- package/docs/adoption-guide.md +35 -35
- package/docs/agents.md +12 -12
- package/docs/antigravity-setup.md +14 -14
- package/docs/codebuddy-setup.md +27 -18
- package/docs/codex-setup.md +6 -6
- package/docs/commandcode-setup.md +5 -5
- package/docs/copilot-cli-setup.md +5 -5
- package/docs/copilot-setup.md +22 -22
- package/docs/cursor-setup.md +22 -22
- package/docs/gemini-cli-setup.md +26 -26
- package/docs/getting-started.md +36 -38
- package/docs/opencode-setup.md +31 -31
- package/docs/windsurf-setup.md +7 -7
- package/docs/workbuddy-setup.md +92 -0
- package/hooks/SDD-CACHE.md +3 -3
- package/hooks/SIMPLIFY-IGNORE.md +2 -2
- package/hooks/session-start-test.sh +1 -1
- package/hooks/session-start.sh +3 -3
- package/package.json +36 -20
- package/plugin.json +1 -1
- package/references/accessibility-checklist.md +1 -1
- package/references/definition-of-done.md +7 -7
- package/references/observability-checklist.md +3 -3
- package/references/orchestration-patterns.md +17 -17
- package/references/performance-checklist.md +2 -2
- package/references/security-checklist.md +1 -1
- package/references/testing-patterns.md +1 -1
- package/skills/{api-and-interface-design → i3-api-and-interface-design}/SKILL.md +2 -2
- package/skills/{browser-testing-with-devtools → i3-browser-testing-with-devtools}/SKILL.md +1 -1
- package/skills/{ci-cd-and-automation → i3-ci-cd-and-automation}/SKILL.md +2 -2
- package/skills/{code-review-and-quality → i3-code-review-and-quality}/SKILL.md +5 -5
- package/skills/{code-simplification → i3-code-simplification}/SKILL.md +1 -1
- package/skills/{constraint-driven-development → i3-constraint-driven-development}/SKILL.md +15 -15
- package/skills/{context-engineering → i3-context-engineering}/SKILL.md +1 -1
- package/skills/{debugging-and-error-recovery → i3-debugging-and-error-recovery}/SKILL.md +2 -2
- package/skills/{deprecation-and-migration → i3-deprecation-and-migration}/SKILL.md +2 -2
- package/skills/{documentation-and-adrs → i3-documentation-and-adrs}/SKILL.md +1 -1
- package/skills/{doubt-driven-development → i3-doubt-driven-development}/SKILL.md +8 -8
- package/skills/{frontend-ui-engineering → i3-frontend-ui-engineering}/SKILL.md +1 -1
- package/skills/{git-workflow-and-versioning → i3-git-workflow-and-versioning}/SKILL.md +4 -4
- package/skills/{idea-refine → i3-idea-refine}/SKILL.md +2 -2
- package/skills/{idea-refine → i3-idea-refine}/scripts/idea-refine.sh +1 -1
- package/skills/{incremental-implementation → i3-incremental-implementation}/SKILL.md +3 -3
- package/skills/{interview-me → i3-interview-me}/SKILL.md +12 -12
- package/skills/{observability-and-instrumentation → i3-observability-and-instrumentation}/SKILL.md +5 -5
- package/skills/{performance-optimization → i3-performance-optimization}/SKILL.md +1 -1
- package/skills/{performance-optimization → i3-performance-optimization}/references/optimization-patterns.md +1 -1
- package/skills/{planning-and-task-breakdown → i3-planning-and-task-breakdown}/SKILL.md +2 -2
- package/skills/{security-and-hardening → i3-security-and-hardening}/SKILL.md +3 -3
- package/skills/{security-and-hardening → i3-security-and-hardening}/references/hardening-patterns.md +1 -1
- package/skills/{shipping-and-launch → i3-shipping-and-launch}/SKILL.md +2 -2
- package/skills/{source-driven-development → i3-source-driven-development}/SKILL.md +2 -2
- package/skills/{spec-driven-development → i3-spec-driven-development}/SKILL.md +7 -7
- package/skills/{test-driven-development → i3-test-driven-development}/SKILL.md +2 -2
- package/skills/{using-agent-skills → i3-using-agent-skills}/SKILL.md +67 -67
- package/CHANGELOG.md +0 -34
- package/NOTICE.md +0 -14
- package/docs/advanced-per-agent-configuration.md +0 -70
- package/docs/comparison.md +0 -131
- package/docs/developer-onboarding.md +0 -116
- package/docs/skill-anatomy.md +0 -203
- package/evals/README.md +0 -101
- package/evals/cases/api-and-interface-design.json +0 -45
- package/evals/cases/browser-testing-with-devtools.json +0 -44
- package/evals/cases/ci-cd-and-automation.json +0 -45
- package/evals/cases/code-review-and-quality.json +0 -49
- package/evals/cases/code-simplification.json +0 -45
- package/evals/cases/constraint-driven-development.json +0 -79
- package/evals/cases/context-engineering.json +0 -44
- package/evals/cases/debugging-and-error-recovery.json +0 -58
- package/evals/cases/deprecation-and-migration.json +0 -52
- package/evals/cases/documentation-and-adrs.json +0 -44
- package/evals/cases/doubt-driven-development.json +0 -43
- package/evals/cases/frontend-ui-engineering.json +0 -52
- package/evals/cases/git-workflow-and-versioning.json +0 -47
- package/evals/cases/idea-refine.json +0 -43
- package/evals/cases/incremental-implementation.json +0 -57
- package/evals/cases/interview-me.json +0 -42
- package/evals/cases/observability-and-instrumentation.json +0 -44
- package/evals/cases/performance-optimization.json +0 -53
- package/evals/cases/planning-and-task-breakdown.json +0 -45
- package/evals/cases/security-and-hardening.json +0 -53
- package/evals/cases/shipping-and-launch.json +0 -56
- package/evals/cases/source-driven-development.json +0 -44
- package/evals/cases/spec-driven-development.json +0 -72
- package/evals/cases/test-driven-development.json +0 -73
- package/evals/cases/using-agent-skills.json +0 -44
- package/evals/fixtures/api-and-interface-design/service-brief.md +0 -19
- package/evals/fixtures/browser-testing-with-devtools/README.md +0 -5
- package/evals/fixtures/browser-testing-with-devtools/index.html +0 -24
- package/evals/fixtures/browser-testing-with-devtools/server.js +0 -15
- package/evals/fixtures/ci-cd-and-automation/package.json +0 -8
- package/evals/fixtures/ci-cd-and-automation/src/slug.js +0 -3
- package/evals/fixtures/ci-cd-and-automation/test/slug.test.js +0 -9
- package/evals/fixtures/code-review-and-quality/user-search.diff +0 -16
- package/evals/fixtures/code-simplification/config-parser.js +0 -46
- package/evals/fixtures/code-simplification/config-parser.test.js +0 -15
- package/evals/fixtures/context-engineering/context-audit.md +0 -15
- package/evals/fixtures/debugging-and-error-recovery/pagination.js +0 -8
- package/evals/fixtures/debugging-and-error-recovery/pagination.test.js +0 -9
- package/evals/fixtures/debugging-and-error-recovery/time-pressure.md +0 -6
- package/evals/fixtures/deprecation-and-migration/api-inventory.md +0 -9
- package/evals/fixtures/documentation-and-adrs/decision-context.md +0 -16
- package/evals/fixtures/doubt-driven-development/migration-plan.md +0 -19
- package/evals/fixtures/frontend-ui-engineering/Button.tsx +0 -7
- package/evals/fixtures/frontend-ui-engineering/design-system.md +0 -11
- package/evals/fixtures/git-workflow-and-versioning/.eval/working-tree.patch +0 -21
- package/evals/fixtures/git-workflow-and-versioning/app.js +0 -7
- package/evals/fixtures/git-workflow-and-versioning/app.test.js +0 -9
- package/evals/fixtures/incremental-implementation/reports.js +0 -7
- package/evals/fixtures/incremental-implementation/reports.test.js +0 -12
- package/evals/fixtures/incremental-implementation/tasks/plan.md +0 -8
- package/evals/fixtures/incremental-implementation-pressure/draft-export.js +0 -17
- package/evals/fixtures/incremental-implementation-pressure/scenario.md +0 -9
- package/evals/fixtures/observability-and-instrumentation/operations.md +0 -11
- package/evals/fixtures/observability-and-instrumentation/payment-retry.js +0 -14
- package/evals/fixtures/performance-optimization/benchmark.js +0 -15
- package/evals/fixtures/performance-optimization/products.js +0 -14
- package/evals/fixtures/planning-and-task-breakdown/notifications-spec.md +0 -18
- package/evals/fixtures/security-and-hardening/webhook.js +0 -11
- package/evals/fixtures/security-and-hardening/webhook.test.js +0 -13
- package/evals/fixtures/shipping-and-launch/authority-pressure.md +0 -6
- package/evals/fixtures/shipping-and-launch/launch-status.md +0 -11
- package/evals/fixtures/source-driven-development/framework-task.md +0 -10
- package/evals/fixtures/spec-driven-development/billing-brief.md +0 -16
- package/evals/fixtures/spec-driven-development-decomposition/portal-brief.md +0 -22
- package/evals/fixtures/test-driven-development/BUG.md +0 -10
- package/evals/fixtures/test-driven-development/README.md +0 -28
- package/evals/fixtures/test-driven-development/package.json +0 -9
- package/evals/fixtures/test-driven-development/src/split.js +0 -8
- package/evals/fixtures/test-driven-development/test/split.test.js +0 -13
- package/evals/fixtures/test-driven-development-ecosystem/README.md +0 -9
- package/evals/fixtures/test-driven-development-ecosystem/ledger.py +0 -15
- package/evals/fixtures/test-driven-development-ecosystem/test_ledger.py +0 -19
- package/evals/fixtures/using-agent-skills/incident.md +0 -6
- package/evals/plugin/code-review-fires/graders/off-by-one.md +0 -7
- package/evals/plugin/code-review-fires/graders/severity-labels.md +0 -4
- package/evals/plugin/code-review-fires/graders/skill-fired.md +0 -5
- package/evals/plugin/code-review-fires/prompt.md +0 -31
- package/evals/plugin/code-review-stays-quiet/graders/not-fired.md +0 -8
- package/evals/plugin/code-review-stays-quiet/graders/tdd-fired.md +0 -6
- package/evals/plugin/code-review-stays-quiet/prompt.md +0 -8
- package/evals/plugin/code-review-stays-quiet-on-commit-message/graders/not-fired.md +0 -8
- package/evals/plugin/code-review-stays-quiet-on-commit-message/prompt.md +0 -25
- package/evals/skill-impact.md +0 -6
- package/rebrand/INSTALLATION-SPEC.md +0 -46
- package/rebrand/MAINTENANCE.md +0 -113
- package/rebrand/NOTICE.md +0 -14
- package/rebrand/PR-WORKFLOW.md +0 -34
- package/rebrand/UNIFICATION-SPEC.md +0 -33
- package/rebrand/VALIDATION.md +0 -32
- package/rebrand/VERSIONING.md +0 -33
- package/rebrand/apply.cjs +0 -194
- package/rebrand/brand.json +0 -13
- package/rebrand/catalog.cjs +0 -56
- package/rebrand/fork-patches.json +0 -12
- package/rebrand/overlay/.github/workflows/test-plugin-install.yml +0 -177
- package/rebrand/overlay/CHANGELOG.md +0 -34
- package/rebrand/overlay/bin/agent-targets.json +0 -726
- package/rebrand/overlay/bin/i3-composer-agent.cjs +0 -190
- package/rebrand/overlay/bin/install.cjs +0 -164
- package/rebrand/overlay/bin/skills-registry.LICENSE +0 -21
- package/rebrand/overlay/bin/wizard.cjs +0 -66
- package/rebrand/overlay/scripts/validate-brand.cjs +0 -44
- package/rebrand/overlay/tests/bundle.test.cjs +0 -85
- package/rebrand/overlay/tests/installer.test.cjs +0 -193
- package/rebrand/package.template.json +0 -82
- package/rebrand/rebrand.sh +0 -4
- package/rebrand/record-upstream.cjs +0 -37
- package/rebrand/templates/README.md +0 -124
- package/rebrand/templates/codebuddy-setup.md +0 -88
- package/rebrand/templates/codex-setup.md +0 -45
- package/rebrand/tests/pipeline.test.cjs +0 -185
- package/rebrand/upstream.json +0 -171
- package/scripts/floor-guard-reference-test.js +0 -291
- package/scripts/lib/skill-lint-test.js +0 -650
- package/scripts/lib/skill-lint.js +0 -584
- package/scripts/run-evals-test.js +0 -623
- package/scripts/run-evals.js +0 -638
- package/scripts/validate-artifact-paths-test.js +0 -179
- package/scripts/validate-artifact-paths.js +0 -128
- package/scripts/validate-brand.cjs +0 -44
- package/scripts/validate-commands-test.js +0 -216
- package/scripts/validate-commands.js +0 -222
- package/scripts/validate-reference-links-test.js +0 -495
- package/scripts/validate-reference-links.js +0 -187
- package/scripts/validate-skills.js +0 -69
- package/scripts/validate-versions-test.js +0 -32
- package/scripts/validate-versions.js +0 -35
- package/tests/bundle.test.cjs +0 -85
- package/tests/installer.test.cjs +0 -193
- /package/skills/{constraint-driven-development → i3-constraint-driven-development}/references/floor-guard.md +0 -0
- /package/skills/{idea-refine → i3-idea-refine}/examples.md +0 -0
- /package/skills/{idea-refine → i3-idea-refine}/frameworks.md +0 -0
- /package/skills/{idea-refine → i3-idea-refine}/refinement-criteria.md +0 -0
package/docs/gemini-cli-setup.md
CHANGED
|
@@ -41,9 +41,9 @@ For skills you want always loaded as persistent project context (rather than on-
|
|
|
41
41
|
|
|
42
42
|
```bash
|
|
43
43
|
# Create GEMINI.md with core skills as persistent context
|
|
44
|
-
cat /path/to/i3-composer-agent/skills/incremental-implementation/SKILL.md > GEMINI.md
|
|
44
|
+
cat /path/to/i3-composer-agent/skills/i3-incremental-implementation/SKILL.md > GEMINI.md
|
|
45
45
|
echo -e "\n---\n" >> GEMINI.md
|
|
46
|
-
cat /path/to/i3-composer-agent/skills/code-review-and-quality/SKILL.md >> GEMINI.md
|
|
46
|
+
cat /path/to/i3-composer-agent/skills/i3-code-review-and-quality/SKILL.md >> GEMINI.md
|
|
47
47
|
```
|
|
48
48
|
|
|
49
49
|
You can also modularize by importing from separate files:
|
|
@@ -51,8 +51,8 @@ You can also modularize by importing from separate files:
|
|
|
51
51
|
```markdown
|
|
52
52
|
# Project Instructions
|
|
53
53
|
|
|
54
|
-
@skills/test-driven-development/SKILL.md
|
|
55
|
-
@skills/incremental-implementation/SKILL.md
|
|
54
|
+
@skills/i3-test-driven-development/SKILL.md
|
|
55
|
+
@skills/i3-incremental-implementation/SKILL.md
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
Use `/memory show` to verify loaded context, and `/memory reload` to refresh after changes.
|
|
@@ -65,18 +65,18 @@ Use `/memory show` to verify loaded context, and `/memory reload` to refresh aft
|
|
|
65
65
|
|
|
66
66
|
Add these as persistent context for every session:
|
|
67
67
|
|
|
68
|
-
- `incremental-implementation` — Build in small verifiable slices
|
|
69
|
-
- `code-review-and-quality` — Five-axis review
|
|
68
|
+
- `i3-incremental-implementation` — Build in small verifiable slices
|
|
69
|
+
- `i3-code-review-and-quality` — Five-axis review
|
|
70
70
|
|
|
71
71
|
### On-Demand (Skills)
|
|
72
72
|
|
|
73
73
|
Install these as skills so they activate only when relevant:
|
|
74
74
|
|
|
75
|
-
- `test-driven-development` — Activates when implementing logic or fixing bugs
|
|
76
|
-
- `spec-driven-development` — Activates when starting a new project or feature
|
|
77
|
-
- `frontend-ui-engineering` — Activates when building UI
|
|
78
|
-
- `security-and-hardening` — Activates during security reviews
|
|
79
|
-
- `performance-optimization` — Activates during performance work
|
|
75
|
+
- `i3-test-driven-development` — Activates when implementing logic or fixing bugs
|
|
76
|
+
- `i3-spec-driven-development` — Activates when starting a new project or feature
|
|
77
|
+
- `i3-frontend-ui-engineering` — Activates when building UI
|
|
78
|
+
- `i3-security-and-hardening` — Activates during security reviews
|
|
79
|
+
- `i3-performance-optimization` — Activates during performance work
|
|
80
80
|
|
|
81
81
|
## Advanced Configuration
|
|
82
82
|
|
|
@@ -84,8 +84,8 @@ Install these as skills so they activate only when relevant:
|
|
|
84
84
|
|
|
85
85
|
Many skills in this pack leverage [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) tools to interact with the environment. For example:
|
|
86
86
|
|
|
87
|
-
- `browser-testing-with-devtools` uses the `chrome-devtools` MCP extension.
|
|
88
|
-
- `performance-optimization` can benefit from performance-related MCP tools.
|
|
87
|
+
- `i3-browser-testing-with-devtools` uses the `chrome-devtools` MCP extension.
|
|
88
|
+
- `i3-performance-optimization` can benefit from performance-related MCP tools.
|
|
89
89
|
|
|
90
90
|
To enable these, ensure you have the relevant MCP extensions installed in your Gemini CLI configuration (`~/.gemini/config.json`).
|
|
91
91
|
|
|
@@ -93,37 +93,37 @@ To enable these, ensure you have the relevant MCP extensions installed in your G
|
|
|
93
93
|
|
|
94
94
|
Gemini CLI supports session lifecycle hooks. You can use these to automatically inject context or run validation scripts at the start of a session.
|
|
95
95
|
|
|
96
|
-
To replicate the `i3-composer-agent` experience from other tools, you can configure a `SessionStart` hook that reminds you of the available skills or loads a meta-skill. `hooks/session-start.sh` in this repo is a ready-made script for that: it prints the `using-agent-skills` meta-skill as a standard `SessionStart` JSON envelope on stdout.
|
|
96
|
+
To replicate the `i3-composer-agent` experience from other tools, you can configure a `SessionStart` hook that reminds you of the available skills or loads a meta-skill. `hooks/session-start.sh` in this repo is a ready-made script for that: it prints the `i3-using-agent-skills` meta-skill as a standard `SessionStart` JSON envelope on stdout.
|
|
97
97
|
|
|
98
98
|
### Explicit Context Loading
|
|
99
99
|
|
|
100
100
|
You can explicitly load any skill into your current session by referencing it with the `@` symbol in your prompt:
|
|
101
101
|
|
|
102
102
|
```markdown
|
|
103
|
-
Use the @skills/test-driven-development/SKILL.md skill to implement this fix.
|
|
103
|
+
Use the @skills/i3-test-driven-development/SKILL.md skill to implement this fix.
|
|
104
104
|
```
|
|
105
105
|
|
|
106
106
|
This is useful when you want to ensure a specific workflow is followed without waiting for auto-discovery.
|
|
107
107
|
|
|
108
108
|
## Slash Commands
|
|
109
109
|
|
|
110
|
-
The repo ships 9 slash commands under `.gemini/commands/`: 8 lifecycle commands plus the `/webperf` specialist audit. Gemini CLI auto-discovers them when you run from the project root.
|
|
110
|
+
The repo ships 9 slash commands under `.gemini/commands/`: 8 lifecycle commands plus the `/i3-webperf` specialist audit. Gemini CLI auto-discovers them when you run from the project root.
|
|
111
111
|
|
|
112
112
|
| Command | What it does |
|
|
113
113
|
|---------|--------------|
|
|
114
|
-
| `/spec` | Write a structured spec before writing code |
|
|
115
|
-
| `/constraints` | Define and enforce the project's quality bar |
|
|
116
|
-
| `/planning` | Break work into small, verifiable tasks |
|
|
117
|
-
| `/build` | Implement the next task incrementally |
|
|
118
|
-
| `/test` | Run TDD workflow — red, green, refactor |
|
|
119
|
-
| `/review` | Five-axis code review |
|
|
120
|
-
| `/code-simplify` | Reduce complexity without changing behavior |
|
|
121
|
-
| `/ship` | Pre-launch checklist via parallel persona fan-out |
|
|
122
|
-
| `/webperf` | Audit browser-facing apps for Core Web Vitals and performance issues |
|
|
114
|
+
| `/i3-spec` | Write a structured spec before writing code |
|
|
115
|
+
| `/i3-constraints` | Define and enforce the project's quality bar |
|
|
116
|
+
| `/i3-planning` | Break work into small, verifiable tasks |
|
|
117
|
+
| `/i3-build` | Implement the next task incrementally |
|
|
118
|
+
| `/i3-test` | Run TDD workflow — red, green, refactor |
|
|
119
|
+
| `/i3-review` | Five-axis code review |
|
|
120
|
+
| `/i3-code-simplify` | Reduce complexity without changing behavior |
|
|
121
|
+
| `/i3-ship` | Pre-launch checklist via parallel persona fan-out |
|
|
122
|
+
| `/i3-webperf` | Audit browser-facing apps for Core Web Vitals and performance issues |
|
|
123
123
|
|
|
124
124
|
Each command invokes the corresponding skill automatically — no manual skill loading required.
|
|
125
125
|
|
|
126
|
-
> **Note:** Use `/planning` instead of `/plan` — `/plan` conflicts with a Gemini CLI internal command name.
|
|
126
|
+
> **Note:** Use `/i3-planning` instead of `/i3-plan` — `/i3-plan` conflicts with a Gemini CLI internal command name.
|
|
127
127
|
|
|
128
128
|
## Usage Tips
|
|
129
129
|
|
package/docs/getting-started.md
CHANGED
|
@@ -38,13 +38,13 @@ Copy the relevant `SKILL.md` content into your agent's system prompt, rules file
|
|
|
38
38
|
|
|
39
39
|
**Rules file:** Add skill content to your project's rules file (CLAUDE.md, .cursorrules, etc.).
|
|
40
40
|
|
|
41
|
-
**Conversation:** Reference the skill when giving instructions: "Follow the test-driven-development process for this change."
|
|
41
|
+
**Conversation:** Reference the skill when giving instructions: "Follow the i3-test-driven-development process for this change."
|
|
42
42
|
|
|
43
43
|
### 4. Use the meta-skill for discovery when needed
|
|
44
44
|
|
|
45
|
-
If your agent does not route skills natively, start with the `using-agent-skills` skill loaded. It contains a flowchart that maps task types to the appropriate skill.
|
|
45
|
+
If your agent does not route skills natively, start with the `i3-using-agent-skills` skill loaded. It contains a flowchart that maps task types to the appropriate skill.
|
|
46
46
|
|
|
47
|
-
If your host already discovers and activates skills from their descriptions, do not also paste `using-agent-skills` into an always-on system prompt or rules file. That creates two routers for the same task. Install the individual skills and let the host activate them on demand instead.
|
|
47
|
+
If your host already discovers and activates skills from their descriptions, do not also paste `i3-using-agent-skills` into an always-on system prompt or rules file. That creates two routers for the same task. Install the individual skills and let the host activate them on demand instead.
|
|
48
48
|
|
|
49
49
|
### Existing projects need no migration
|
|
50
50
|
|
|
@@ -66,9 +66,9 @@ Rolling out to a real project? The **[Adoption Guide](adoption-guide.md)** cover
|
|
|
66
66
|
|
|
67
67
|
Load three essential skills into your rules file:
|
|
68
68
|
|
|
69
|
-
1. **spec-driven-development** — For defining what to build
|
|
70
|
-
2. **test-driven-development** — For proving it works
|
|
71
|
-
3. **code-review-and-quality** — For verifying quality before merge
|
|
69
|
+
1. **i3-spec-driven-development** — For defining what to build
|
|
70
|
+
2. **i3-test-driven-development** — For proving it works
|
|
71
|
+
3. **i3-code-review-and-quality** — For verifying quality before merge
|
|
72
72
|
|
|
73
73
|
These three cover the most critical quality gaps in AI-assisted development.
|
|
74
74
|
|
|
@@ -77,19 +77,19 @@ These three cover the most critical quality gaps in AI-assisted development.
|
|
|
77
77
|
For comprehensive coverage, load skills by phase:
|
|
78
78
|
|
|
79
79
|
```
|
|
80
|
-
Starting a project: spec-driven-development → planning-and-task-breakdown
|
|
81
|
-
During development: incremental-implementation + test-driven-development
|
|
82
|
-
Before merge: code-review-and-quality + security-and-hardening
|
|
83
|
-
Before deploy: shipping-and-launch
|
|
80
|
+
Starting a project: i3-spec-driven-development → i3-planning-and-task-breakdown
|
|
81
|
+
During development: i3-incremental-implementation + i3-test-driven-development
|
|
82
|
+
Before merge: i3-code-review-and-quality + i3-security-and-hardening
|
|
83
|
+
Before deploy: i3-shipping-and-launch
|
|
84
84
|
```
|
|
85
85
|
|
|
86
86
|
### Context-Aware Loading
|
|
87
87
|
|
|
88
88
|
Don't load all skills at once — it wastes context. Load skills relevant to the current task:
|
|
89
89
|
|
|
90
|
-
- Working on UI? Load `frontend-ui-engineering`
|
|
91
|
-
- Debugging? Load `debugging-and-error-recovery`
|
|
92
|
-
- Setting up CI? Load `ci-cd-and-automation`
|
|
90
|
+
- Working on UI? Load `i3-frontend-ui-engineering`
|
|
91
|
+
- Debugging? Load `i3-debugging-and-error-recovery`
|
|
92
|
+
- Setting up CI? Load `i3-ci-cd-and-automation`
|
|
93
93
|
|
|
94
94
|
## Skill Anatomy
|
|
95
95
|
|
|
@@ -117,7 +117,7 @@ The `agents/` directory contains pre-configured agent personas:
|
|
|
117
117
|
| `code-reviewer.md` | Five-axis code review |
|
|
118
118
|
| `test-engineer.md` | Test strategy and writing |
|
|
119
119
|
| `security-auditor.md` | Vulnerability detection |
|
|
120
|
-
| `web-performance-auditor.md` | Core Web Vitals & performance audit (via `/webperf`) |
|
|
120
|
+
| `web-performance-auditor.md` | Core Web Vitals & performance audit (via `/i3-webperf`) |
|
|
121
121
|
|
|
122
122
|
Load an agent definition when you need specialized review. For example, ask your coding agent to "review this change using the code-reviewer agent persona" and provide the agent definition.
|
|
123
123
|
|
|
@@ -127,16 +127,16 @@ The `.claude/commands/` directory contains slash commands for Claude Code:
|
|
|
127
127
|
|
|
128
128
|
| Command | Skill Invoked |
|
|
129
129
|
|---------|---------------|
|
|
130
|
-
| `/spec` | spec-driven-development |
|
|
131
|
-
| `/constraints` | constraint-driven-development |
|
|
132
|
-
| `/plan` | planning-and-task-breakdown |
|
|
133
|
-
| `/build` | incremental-implementation + test-driven-development |
|
|
134
|
-
| `/build auto` | planning-and-task-breakdown → incremental-implementation + test-driven-development (whole plan, one approval) |
|
|
135
|
-
| `/test` | test-driven-development |
|
|
136
|
-
| `/review` | code-review-and-quality |
|
|
137
|
-
| `/code-simplify` | code-simplification |
|
|
138
|
-
| `/ship` | shipping-and-launch |
|
|
139
|
-
| `/webperf` | web-performance-auditor (specialist agent, web apps only) |
|
|
130
|
+
| `/i3-spec` | i3-spec-driven-development |
|
|
131
|
+
| `/i3-constraints` | i3-constraint-driven-development |
|
|
132
|
+
| `/i3-plan` | i3-planning-and-task-breakdown |
|
|
133
|
+
| `/i3-build` | i3-incremental-implementation + i3-test-driven-development |
|
|
134
|
+
| `/i3-build auto` | i3-planning-and-task-breakdown → i3-incremental-implementation + i3-test-driven-development (whole plan, one approval) |
|
|
135
|
+
| `/i3-test` | i3-test-driven-development |
|
|
136
|
+
| `/i3-review` | i3-code-review-and-quality |
|
|
137
|
+
| `/i3-code-simplify` | i3-code-simplification |
|
|
138
|
+
| `/i3-ship` | i3-shipping-and-launch |
|
|
139
|
+
| `/i3-webperf` | web-performance-auditor (specialist agent, web apps only) |
|
|
140
140
|
|
|
141
141
|
> **Note:** When installed as a Claude Code plugin you may see a warning like
|
|
142
142
|
> _"Default commands/ folder is ignored because the manifest sets 'commands'"_.
|
|
@@ -150,13 +150,13 @@ The `references/` directory contains supplementary checklists:
|
|
|
150
150
|
|
|
151
151
|
| Reference | Use With |
|
|
152
152
|
|-----------|----------|
|
|
153
|
-
| `testing-patterns.md` | test-driven-development |
|
|
154
|
-
| `performance-checklist.md` | performance-optimization |
|
|
155
|
-
| `security-checklist.md` | security-and-hardening |
|
|
156
|
-
| `accessibility-checklist.md` | frontend-ui-engineering |
|
|
153
|
+
| `testing-patterns.md` | i3-test-driven-development |
|
|
154
|
+
| `performance-checklist.md` | i3-performance-optimization |
|
|
155
|
+
| `security-checklist.md` | i3-security-and-hardening |
|
|
156
|
+
| `accessibility-checklist.md` | i3-frontend-ui-engineering |
|
|
157
157
|
| `definition-of-done.md` | all skills / every change |
|
|
158
|
-
| `observability-checklist.md` | observability-and-instrumentation |
|
|
159
|
-
| `orchestration-patterns.md` | doubt-driven-development |
|
|
158
|
+
| `observability-checklist.md` | i3-observability-and-instrumentation |
|
|
159
|
+
| `orchestration-patterns.md` | i3-doubt-driven-development |
|
|
160
160
|
|
|
161
161
|
Load a reference when you need detailed patterns beyond what the skill covers.
|
|
162
162
|
|
|
@@ -165,12 +165,10 @@ selected `skills/<name>/` directory is copied. The skill still works, but paths
|
|
|
165
165
|
to supplementary checklists in the repo-level `references/` directory are
|
|
166
166
|
unavailable. Use a whole-repo integration, clone the repository, or copy the
|
|
167
167
|
needed checklist into a `references/` directory inside the installed skill.
|
|
168
|
-
This portability gap is tracked in
|
|
169
|
-
[upstream agent-skills #361](https://github.com/addyosmani/agent-skills/issues/361).
|
|
170
168
|
|
|
171
169
|
## Spec and task artifacts
|
|
172
170
|
|
|
173
|
-
The `/spec` and `/plan` commands create working artifacts (`SPEC.md`, `tasks/plan.md`, `tasks/todo.md`). Treat them as **living documents** while the work is in progress:
|
|
171
|
+
The `/i3-spec` and `/i3-plan` commands create working artifacts (`SPEC.md`, `tasks/plan.md`, `tasks/todo.md`). Treat them as **living documents** while the work is in progress:
|
|
174
172
|
|
|
175
173
|
- Keep them in version control during development so the human and the agent have a shared source of truth.
|
|
176
174
|
- Update them when scope or decisions change.
|
|
@@ -189,11 +187,11 @@ The same artifacts are the handoff between sessions. For a small task, run the w
|
|
|
189
187
|
|
|
190
188
|
#### Task-boundary restarts and Ralph loops
|
|
191
189
|
|
|
192
|
-
`/build auto` can run the whole approved plan in one session. It does not require or perform a fresh process per task. Its per-task status updates, verification results, and commits make each completed task a restartable boundary, so a capable external harness may exit and resume there without depending on chat history.
|
|
190
|
+
`/i3-build auto` can run the whole approved plan in one session. It does not require or perform a fresh process per task. Its per-task status updates, verification results, and commits make each completed task a restartable boundary, so a capable external harness may exit and resume there without depending on chat history.
|
|
193
191
|
|
|
194
|
-
A shell-level "Ralph loop" is harness behavior, not a separate skill workflow. If you use one, restart only after the current task has reached a recorded boundary; on re-entry, read the durable artifacts and repository state before selecting the next pending task. A process exit is not evidence that a task passed, and a restart must not bypass an approval gate. See the `context-engineering` skill's **Restartable Session Boundaries** section for the handoff checklist.
|
|
192
|
+
A shell-level "Ralph loop" is harness behavior, not a separate skill workflow. If you use one, restart only after the current task has reached a recorded boundary; on re-entry, read the durable artifacts and repository state before selecting the next pending task. A process exit is not evidence that a task passed, and a restart must not bypass an approval gate. See the `i3-context-engineering` skill's **Restartable Session Boundaries** section for the handoff checklist.
|
|
195
193
|
|
|
196
|
-
This doesn't need the `/spec` and `/plan` wrappers — plain requests work in any agent, including a `npx skills add` install that only has the skills:
|
|
194
|
+
This doesn't need the `/i3-spec` and `/i3-plan` wrappers — plain requests work in any agent, including a `npx skills add` install that only has the skills:
|
|
197
195
|
|
|
198
196
|
> Read SPEC.md, then break it into small verifiable tasks with acceptance criteria and dependency order. Save them to tasks/plan.md and tasks/todo.md. No product code yet — show me the plan first.
|
|
199
197
|
|
|
@@ -201,8 +199,8 @@ This doesn't need the `/spec` and `/plan` wrappers — plain requests work in an
|
|
|
201
199
|
|
|
202
200
|
## Tips
|
|
203
201
|
|
|
204
|
-
1. **Start with spec-driven-development** for any non-trivial work
|
|
205
|
-
2. **Always load test-driven-development** when writing code
|
|
202
|
+
1. **Start with i3-spec-driven-development** for any non-trivial work
|
|
203
|
+
2. **Always load i3-test-driven-development** when writing code
|
|
206
204
|
3. **Don't skip verification steps** — they're the whole point
|
|
207
205
|
4. **Load skills selectively** — more context isn't always better
|
|
208
206
|
5. **Use the agents for review** — different perspectives catch different issues
|
package/docs/opencode-setup.md
CHANGED
|
@@ -30,7 +30,7 @@ npx skills add /path/to/i3-composer-agent --list # browse before installing
|
|
|
30
30
|
Install a single skill:
|
|
31
31
|
|
|
32
32
|
```bash
|
|
33
|
-
npx skills add /path/to/i3-composer-agent --skill spec-driven-development
|
|
33
|
+
npx skills add /path/to/i3-composer-agent --skill i3-spec-driven-development
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
By default `npx skills` installs into a tool-specific directory (often `.claude/skills/` or a shared location). OpenCode will discover skills placed there because it reads `.claude/skills/<name>/SKILL.md` and the generic `.agents/skills/<name>/SKILL.md` paths.
|
|
@@ -42,7 +42,7 @@ mkdir -p .opencode/skills
|
|
|
42
42
|
cp -r .claude/skills/<skill-name> .opencode/skills/
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
> **Note:** Per-skill installs copy only the skill directory itself. If a skill references shared files under `references/`, copy those into the installed skill directory or install the whole pack.
|
|
45
|
+
> **Note:** Per-skill installs copy only the skill directory itself. If a skill references shared files under `references/`, copy those into the installed skill directory or install the whole pack.
|
|
46
46
|
|
|
47
47
|
### Option 2: Prepare the plugin bundle
|
|
48
48
|
|
|
@@ -61,12 +61,12 @@ mkdir -p .opencode/skills
|
|
|
61
61
|
cp -r /path/to/i3-composer-agent/skills/<skill-name> .opencode/skills/
|
|
62
62
|
```
|
|
63
63
|
|
|
64
|
-
For example, to install `spec-driven-development` and `incremental-implementation`:
|
|
64
|
+
For example, to install `i3-spec-driven-development` and `i3-incremental-implementation`:
|
|
65
65
|
|
|
66
66
|
```bash
|
|
67
67
|
mkdir -p .opencode/skills
|
|
68
|
-
cp -r /path/to/i3-composer-agent/skills/spec-driven-development .opencode/skills/
|
|
69
|
-
cp -r /path/to/i3-composer-agent/skills/incremental-implementation .opencode/skills/
|
|
68
|
+
cp -r /path/to/i3-composer-agent/skills/i3-spec-driven-development .opencode/skills/
|
|
69
|
+
cp -r /path/to/i3-composer-agent/skills/i3-incremental-implementation .opencode/skills/
|
|
70
70
|
```
|
|
71
71
|
|
|
72
72
|
#### Global installation
|
|
@@ -89,11 +89,11 @@ If you already share skills across Claude Code and OpenCode, any of these locati
|
|
|
89
89
|
|
|
90
90
|
### What to copy
|
|
91
91
|
|
|
92
|
-
Copy the directories under `skills/` (for example `skills/spec-driven-development/`). Each directory must contain a `SKILL.md` file. Do not copy the repository's root `AGENTS.md` or `CLAUDE.md`; those files configure development of this repository itself.
|
|
92
|
+
Copy the directories under `skills/` (for example `skills/i3-spec-driven-development/`). Each directory must contain a `SKILL.md` file. Do not copy the repository's root `AGENTS.md` or `CLAUDE.md`; those files configure development of this repository itself.
|
|
93
93
|
|
|
94
94
|
## Project `AGENTS.md`
|
|
95
95
|
|
|
96
|
-
Create an `AGENTS.md` in **your own project** root. This is the system prompt that tells OpenCode when and how to invoke the installed skills. Unlike the repo-scoped `AGENTS.md` in `
|
|
96
|
+
Create an `AGENTS.md` in **your own project** root. This is the system prompt that tells OpenCode when and how to invoke the installed skills. Unlike the repo-scoped `AGENTS.md` in `i3-composer-agent`, this file belongs to your project and should be adapted to your stack.
|
|
97
97
|
|
|
98
98
|
Below is a template you can paste into your project's `AGENTS.md`:
|
|
99
99
|
|
|
@@ -113,13 +113,13 @@ This project uses skills installed under `.opencode/skills/` (or a compatible pa
|
|
|
113
113
|
|
|
114
114
|
Map the user's intent to the matching skill automatically:
|
|
115
115
|
|
|
116
|
-
- Feature / new functionality → `spec-driven-development`, then `incremental-implementation` and `test-driven-development`
|
|
117
|
-
- Planning / breakdown → `planning-and-task-breakdown`
|
|
118
|
-
- Bug / failure / unexpected behavior → `debugging-and-error-recovery`
|
|
119
|
-
- Code review → `code-review-and-quality`
|
|
120
|
-
- Refactoring / simplification → `code-simplification`
|
|
121
|
-
- API or interface design → `api-and-interface-design`
|
|
122
|
-
- UI work → `frontend-ui-engineering`
|
|
116
|
+
- Feature / new functionality → `i3-spec-driven-development`, then `i3-incremental-implementation` and `i3-test-driven-development`
|
|
117
|
+
- Planning / breakdown → `i3-planning-and-task-breakdown`
|
|
118
|
+
- Bug / failure / unexpected behavior → `i3-debugging-and-error-recovery`
|
|
119
|
+
- Code review → `i3-code-review-and-quality`
|
|
120
|
+
- Refactoring / simplification → `i3-code-simplification`
|
|
121
|
+
- API or interface design → `i3-api-and-interface-design`
|
|
122
|
+
- UI work → `i3-frontend-ui-engineering`
|
|
123
123
|
|
|
124
124
|
## Execution Model
|
|
125
125
|
|
|
@@ -133,7 +133,7 @@ For every request:
|
|
|
133
133
|
|
|
134
134
|
Save this as `AGENTS.md` in your project root. OpenCode will load it automatically.
|
|
135
135
|
|
|
136
|
-
> **Note:** The root `AGENTS.md` inside the `
|
|
136
|
+
> **Note:** The root `AGENTS.md` inside the `i3-composer-agent` repository is intended for contributors working on this repository and should not be copied into other projects. See [CONTRIBUTING.md](../CONTRIBUTING.md#repo-scoped-files).
|
|
137
137
|
|
|
138
138
|
## How It Works
|
|
139
139
|
|
|
@@ -156,21 +156,21 @@ When your project's `AGENTS.md` instructs the agent to use skills, the agent eva
|
|
|
156
156
|
|
|
157
157
|
Examples:
|
|
158
158
|
|
|
159
|
-
- "build a feature" → `incremental-implementation` + `test-driven-development`
|
|
160
|
-
- "design a system" → `spec-driven-development`
|
|
161
|
-
- "fix a bug" → `debugging-and-error-recovery`
|
|
162
|
-
- "review this code" → `code-review-and-quality`
|
|
159
|
+
- "build a feature" → `i3-incremental-implementation` + `i3-test-driven-development`
|
|
160
|
+
- "design a system" → `i3-spec-driven-development`
|
|
161
|
+
- "fix a bug" → `i3-debugging-and-error-recovery`
|
|
162
|
+
- "review this code" → `i3-code-review-and-quality`
|
|
163
163
|
|
|
164
164
|
### 3. Lifecycle Mapping (Implicit Commands)
|
|
165
165
|
|
|
166
166
|
OpenCode does not require slash commands, but if you prefer them see the next section. In agent-driven mode the lifecycle is mapped implicitly:
|
|
167
167
|
|
|
168
|
-
- DEFINE → `spec-driven-development`
|
|
169
|
-
- PLAN → `planning-and-task-breakdown`
|
|
170
|
-
- BUILD → `incremental-implementation` + `test-driven-development`
|
|
171
|
-
- VERIFY → `debugging-and-error-recovery`
|
|
172
|
-
- REVIEW → `code-review-and-quality`
|
|
173
|
-
- SHIP → `shipping-and-launch`
|
|
168
|
+
- DEFINE → `i3-spec-driven-development`
|
|
169
|
+
- PLAN → `i3-planning-and-task-breakdown`
|
|
170
|
+
- BUILD → `i3-incremental-implementation` + `i3-test-driven-development`
|
|
171
|
+
- VERIFY → `i3-debugging-and-error-recovery`
|
|
172
|
+
- REVIEW → `i3-code-review-and-quality`
|
|
173
|
+
- SHIP → `i3-shipping-and-launch`
|
|
174
174
|
|
|
175
175
|
### Copy the optional slash commands
|
|
176
176
|
|
|
@@ -190,10 +190,10 @@ A typical command file looks like:
|
|
|
190
190
|
description: Break work into small verifiable tasks
|
|
191
191
|
---
|
|
192
192
|
|
|
193
|
-
Invoke the planning-and-task-breakdown skill. Read the spec and create tasks with acceptance criteria.
|
|
193
|
+
Invoke the i3-planning-and-task-breakdown skill. Read the spec and create tasks with acceptance criteria.
|
|
194
194
|
```
|
|
195
195
|
|
|
196
|
-
Save it as `.opencode/commands/plan.md` to enable `/plan` in OpenCode.
|
|
196
|
+
Save it as `.opencode/commands/i3-plan.md` to enable `/i3-plan` in OpenCode.
|
|
197
197
|
|
|
198
198
|
## Usage Examples
|
|
199
199
|
|
|
@@ -206,7 +206,7 @@ Add authentication to this app
|
|
|
206
206
|
|
|
207
207
|
Agent behavior:
|
|
208
208
|
- Detects feature work
|
|
209
|
-
- Invokes `spec-driven-development`
|
|
209
|
+
- Invokes `i3-spec-driven-development`
|
|
210
210
|
- Produces a spec before writing code
|
|
211
211
|
- Moves to planning and implementation skills
|
|
212
212
|
|
|
@@ -218,7 +218,7 @@ This endpoint is returning 500 errors
|
|
|
218
218
|
```
|
|
219
219
|
|
|
220
220
|
Agent behavior:
|
|
221
|
-
- Invokes `debugging-and-error-recovery`
|
|
221
|
+
- Invokes `i3-debugging-and-error-recovery`
|
|
222
222
|
- Reproduces → localizes → fixes → adds guards
|
|
223
223
|
|
|
224
224
|
### Example 3: Code Review
|
|
@@ -229,7 +229,7 @@ Review this PR
|
|
|
229
229
|
```
|
|
230
230
|
|
|
231
231
|
Agent behavior:
|
|
232
|
-
- Invokes `code-review-and-quality`
|
|
232
|
+
- Invokes `i3-code-review-and-quality`
|
|
233
233
|
- Applies structured review (correctness, design, readability, etc.)
|
|
234
234
|
|
|
235
235
|
## Agent Expectations
|
|
@@ -256,4 +256,4 @@ These rules are enforced by your project's `AGENTS.md`, not by the copy of the s
|
|
|
256
256
|
3. OpenCode discovers the skills and your `AGENTS.md` guides the agent to invoke them.
|
|
257
257
|
4. Optionally add `.opencode/commands/*.md` for explicit slash commands.
|
|
258
258
|
|
|
259
|
-
This keeps the reusable assets (skills) separate from the repository-specific configuration (the `
|
|
259
|
+
This keeps the reusable assets (skills) separate from the repository-specific configuration (the `i3-composer-agent` root `AGENTS.md`).
|
package/docs/windsurf-setup.md
CHANGED
|
@@ -8,11 +8,11 @@ Windsurf uses `.windsurfrules` for project-specific agent instructions:
|
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
# Create a combined rules file from your most important skills
|
|
11
|
-
cat /path/to/i3-composer-agent/skills/test-driven-development/SKILL.md > .windsurfrules
|
|
11
|
+
cat /path/to/i3-composer-agent/skills/i3-test-driven-development/SKILL.md > .windsurfrules
|
|
12
12
|
echo "\n---\n" >> .windsurfrules
|
|
13
|
-
cat /path/to/i3-composer-agent/skills/incremental-implementation/SKILL.md >> .windsurfrules
|
|
13
|
+
cat /path/to/i3-composer-agent/skills/i3-incremental-implementation/SKILL.md >> .windsurfrules
|
|
14
14
|
echo "\n---\n" >> .windsurfrules
|
|
15
|
-
cat /path/to/i3-composer-agent/skills/code-review-and-quality/SKILL.md >> .windsurfrules
|
|
15
|
+
cat /path/to/i3-composer-agent/skills/i3-code-review-and-quality/SKILL.md >> .windsurfrules
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
### Global Rules
|
|
@@ -30,19 +30,19 @@ Keep `.windsurfrules` focused on 2-3 essential skills to stay within context lim
|
|
|
30
30
|
# .windsurfrules
|
|
31
31
|
# Essential i3-composer-agent for this project
|
|
32
32
|
|
|
33
|
-
[Paste test-driven-development SKILL.md]
|
|
33
|
+
[Paste i3-test-driven-development SKILL.md]
|
|
34
34
|
|
|
35
35
|
---
|
|
36
36
|
|
|
37
|
-
[Paste incremental-implementation SKILL.md]
|
|
37
|
+
[Paste i3-incremental-implementation SKILL.md]
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
41
|
-
[Paste code-review-and-quality SKILL.md]
|
|
41
|
+
[Paste i3-code-review-and-quality SKILL.md]
|
|
42
42
|
```
|
|
43
43
|
|
|
44
44
|
## Usage Tips
|
|
45
45
|
|
|
46
46
|
1. **Be selective** — Windsurf's context is limited. Choose skills that address your biggest quality gaps.
|
|
47
|
-
2. **Reference in conversation** — Paste additional skill content into the chat when working on specific phases (e.g., paste `security-and-hardening` when building auth).
|
|
47
|
+
2. **Reference in conversation** — Paste additional skill content into the chat when working on specific phases (e.g., paste `i3-security-and-hardening` when building auth).
|
|
48
48
|
3. **Use references as checklists** — Paste `references/security-checklist.md` and ask Windsurf to verify each item.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Using i3 Composer Agent with WorkBuddy
|
|
2
|
+
|
|
3
|
+
## Native installation
|
|
4
|
+
|
|
5
|
+
Run inside your project:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @givolt/i3-composer-agent --workbuddy
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
The terminal wizard preselects WorkBuddy and lets you add other clients before
|
|
12
|
+
choosing project or global scope. For explicit installation:
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
npx @givolt/i3-composer-agent --workbuddy --scope project --yes
|
|
16
|
+
npx @givolt/i3-composer-agent --agents codebuddy,workbuddy --scope project --yes
|
|
17
|
+
npx @givolt/i3-composer-agent --workbuddy --scope global --yes
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
| Selected clients | Project files | Global files |
|
|
21
|
+
| --- | --- | --- |
|
|
22
|
+
| CodeBuddy | `.codebuddy/` | `~/.codebuddy/` |
|
|
23
|
+
| WorkBuddy | `.codebuddy/` | `~/.workbuddy/` |
|
|
24
|
+
| CodeBuddy and WorkBuddy | One shared `.codebuddy/` installation | One installation in each client's directory |
|
|
25
|
+
|
|
26
|
+
WorkBuddy natively discovers project Commands, Skills and personas in
|
|
27
|
+
`.codebuddy/`. If your project already has `.workbuddy/`, i3 preserves its
|
|
28
|
+
contents and adds `.codebuddy/` for the shared native files. Both directories may
|
|
29
|
+
therefore exist in the same workspace.
|
|
30
|
+
|
|
31
|
+
Project installation includes:
|
|
32
|
+
|
|
33
|
+
- `.codebuddy/skills/`: all 25 Skills with their existing `i3-` IDs.
|
|
34
|
+
- `.codebuddy/commands/`: all 9 short `/i3-*` workflows.
|
|
35
|
+
- `.codebuddy/agents/`: all 4 persona prompts.
|
|
36
|
+
- `.codebuddy/references/`: shared references and the standard MIT license.
|
|
37
|
+
- `.codebuddy/docs/agents.md`: persona documentation.
|
|
38
|
+
- `.codebuddy/.i3-composer-agent.json`: managed asset and client records.
|
|
39
|
+
|
|
40
|
+
Global WorkBuddy installation uses the same layout under `~/.workbuddy/`.
|
|
41
|
+
If you use a separate WorkBuddy profile, set `WORKBUDDY_CONFIG_DIR` to its
|
|
42
|
+
configuration directory when installing. The installer does not borrow
|
|
43
|
+
`CODEBUDDY_CONFIG_DIR` for WorkBuddy. Open the corresponding profile in the host.
|
|
44
|
+
|
|
45
|
+
## Discovery and invocation
|
|
46
|
+
|
|
47
|
+
Open the project in WorkBuddy and start a new chat after installation. Type `/`
|
|
48
|
+
to inspect the project Commands, and inspect the Skills list. Examples:
|
|
49
|
+
|
|
50
|
+
```text
|
|
51
|
+
/i3-spec
|
|
52
|
+
/i3-plan
|
|
53
|
+
/i3-build
|
|
54
|
+
/i3-build auto
|
|
55
|
+
/i3-review
|
|
56
|
+
/i3-ship
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Commands invoke the installed Skill IDs without a plugin namespace. Native
|
|
60
|
+
Buddy commands refer to `CODEBUDDY.md` and the installed persona directories.
|
|
61
|
+
Shared project commands refer to the current host's user-level persona directory
|
|
62
|
+
so they work for either client. `/i3-ship` uses native subagents when available
|
|
63
|
+
and reads the installed persona prompts sequentially otherwise. Skill content,
|
|
64
|
+
`$ARGUMENTS`, workflow approval gates, and relative reference links are retained.
|
|
65
|
+
|
|
66
|
+
The [WorkBuddy project documentation](https://www.codebuddy.cn/docs/workbuddy/From-Beginner-to-Expert-Guide/Function-Description/Project)
|
|
67
|
+
describes these native project directories. The [task-bar command documentation](https://www.codebuddy.cn/docs/workbuddy/From-Beginner-to-Expert-Guide/Function-Description/Task-Bar)
|
|
68
|
+
describes command discovery, and the [CLI command documentation](https://www.codebuddy.cn/docs/cli/slash-commands)
|
|
69
|
+
describes Markdown commands and `$ARGUMENTS`.
|
|
70
|
+
|
|
71
|
+
## Adding a second client or upgrading
|
|
72
|
+
|
|
73
|
+
Either client can be installed first. Installing the other at the same package
|
|
74
|
+
version and scope reuses unmodified manifest-owned files and merges the client
|
|
75
|
+
IDs. It does not create a second project copy. Missing files are restored;
|
|
76
|
+
unrelated settings and custom command filenames are preserved.
|
|
77
|
+
|
|
78
|
+
Review an upgrade or conflict before replacing files:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
npx @givolt/i3-composer-agent --workbuddy --scope project --dry-run
|
|
82
|
+
npx @givolt/i3-composer-agent --workbuddy --scope project --yes --force
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Modified assets, unowned filename collisions and different versions require
|
|
86
|
+
confirmation or `--force`. Successful replacements remove old files and managed
|
|
87
|
+
historical backups. If installation fails, the previous files are restored.
|
|
88
|
+
|
|
89
|
+
Native installation provides Commands, Skills and personas. It does not register
|
|
90
|
+
a WorkBuddy plugin or enable plugin hooks; `--prepare --workbuddy` is unsupported.
|
|
91
|
+
File installation and command discovery are separate from model execution and
|
|
92
|
+
workflow acceptance in the host.
|
package/hooks/SDD-CACHE.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# sdd-cache hook
|
|
2
2
|
|
|
3
|
-
Cross-session citation cache for [`source-driven-development`](../skills/source-driven-development/SKILL.md). Skips redundant `WebFetch` calls without weakening the skill's "verify against current docs" guarantee.
|
|
3
|
+
Cross-session citation cache for [`i3-source-driven-development`](../skills/i3-source-driven-development/SKILL.md). Skips redundant `WebFetch` calls without weakening the skill's "verify against current docs" guarantee.
|
|
4
4
|
|
|
5
5
|
## Why
|
|
6
6
|
|
|
7
|
-
`source-driven-development` fetches official docs for every framework-specific decision. Working on the same project across sessions means fetching the same pages over and over. Caching the content as local memory would contradict the skill — docs change, and a stale cache hides that.
|
|
7
|
+
`i3-source-driven-development` fetches official docs for every framework-specific decision. Working on the same project across sessions means fetching the same pages over and over. Caching the content as local memory would contradict the skill — docs change, and a stale cache hides that.
|
|
8
8
|
|
|
9
9
|
This hook caches fetched content on disk, but **revalidates with the origin server on every reuse** via HTTP `If-None-Match` / `If-Modified-Since`. Content is only served from cache when the server responds `304 Not Modified`, which is a fresh verification — not a memory read.
|
|
10
10
|
|
|
@@ -48,7 +48,7 @@ This hook caches fetched content on disk, but **revalidates with the origin serv
|
|
|
48
48
|
|
|
49
49
|
2. Make sure `.claude/sdd-cache/` is in your `.gitignore` (already included in this repo).
|
|
50
50
|
|
|
51
|
-
3. Use `/source-driven-development` (or the skill) as usual. No changes to the skill or the agent's workflow — the cache is transparent.
|
|
51
|
+
3. Use `/i3-source-driven-development` (or the skill) as usual. No changes to the skill or the agent's workflow — the cache is transparent.
|
|
52
52
|
|
|
53
53
|
## Mental model
|
|
54
54
|
|
package/hooks/SIMPLIFY-IGNORE.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# simplify-ignore hook
|
|
2
2
|
|
|
3
|
-
Block-level protection for `/code-simplify`. Mark code that should never be simplified — the model won't see it.
|
|
3
|
+
Block-level protection for `/i3-code-simplify`. Mark code that should never be simplified — the model won't see it.
|
|
4
4
|
|
|
5
5
|
## Setup
|
|
6
6
|
|
|
@@ -42,7 +42,7 @@ result[3] = buf[3] ^ key[3];
|
|
|
42
42
|
}
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
3. Run `/code-simplify` — protected blocks become `/* BLOCK_de115a1d: perf-critical */` placeholders. The model reasons about surrounding code without seeing the protected implementation.
|
|
45
|
+
3. Run `/i3-code-simplify` — protected blocks become `/* BLOCK_de115a1d: perf-critical */` placeholders. The model reasons about surrounding code without seeing the protected implementation.
|
|
46
46
|
|
|
47
47
|
> **Note:** The hook stores temporary backups in `.claude/.simplify-ignore-cache/`. Make sure this path is in your `.gitignore`.
|
|
48
48
|
|
|
@@ -37,7 +37,7 @@ if (hasJq) {
|
|
|
37
37
|
throw new Error('additionalContext is missing startup preface');
|
|
38
38
|
}
|
|
39
39
|
if (!ctx.includes('# Using i3 Composer Agent')) {
|
|
40
|
-
throw new Error('additionalContext is missing using-agent-skills content');
|
|
40
|
+
throw new Error('additionalContext is missing i3-using-agent-skills content');
|
|
41
41
|
}
|
|
42
42
|
} else if (!ctx.includes('jq is required')) {
|
|
43
43
|
throw new Error('additionalContext is missing jq fallback guidance');
|
package/hooks/session-start.sh
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
#!/bin/bash
|
|
2
2
|
# i3-composer-agent session start hook
|
|
3
|
-
# Injects the using-agent-skills meta-skill into a new session.
|
|
3
|
+
# Injects the i3-using-agent-skills meta-skill into a new session.
|
|
4
4
|
#
|
|
5
5
|
# Not wired by the plugin: hosts that already route skills from their
|
|
6
6
|
# descriptions (Claude Code, Codex CLI) would run a second router on top of
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)"
|
|
15
15
|
SKILLS_DIR="$(dirname "$SCRIPT_DIR")/skills"
|
|
16
|
-
META_SKILL="$SKILLS_DIR/using-agent-skills/SKILL.md"
|
|
16
|
+
META_SKILL="$SKILLS_DIR/i3-using-agent-skills/SKILL.md"
|
|
17
17
|
|
|
18
18
|
if ! command -v jq >/dev/null 2>&1; then
|
|
19
19
|
echo '{"hookSpecificOutput": {"hookEventName": "SessionStart", "additionalContext": "i3-composer-agent: jq is required for the session-start hook but was not found on PATH. Install jq (e.g. `brew install jq` or `apt-get install jq`) to enable meta-skill injection. Skills remain available individually."}}'
|
|
@@ -29,5 +29,5 @@ if [ -f "$META_SKILL" ]; then
|
|
|
29
29
|
$CONTENT" \
|
|
30
30
|
'{hookSpecificOutput: {hookEventName: "SessionStart", additionalContext: $context}}'
|
|
31
31
|
else
|
|
32
|
-
echo '{"hookSpecificOutput": {"hookEventName": "SessionStart", "additionalContext": "i3-composer-agent: using-agent-skills meta-skill not found. Skills may still be available individually."}}'
|
|
32
|
+
echo '{"hookSpecificOutput": {"hookEventName": "SessionStart", "additionalContext": "i3-composer-agent: i3-using-agent-skills meta-skill not found. Skills may still be available individually."}}'
|
|
33
33
|
fi
|