hatch3r 1.1.0 → 1.2.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/README.md +79 -370
- package/agents/hatch3r-a11y-auditor.md +7 -4
- package/agents/hatch3r-architect.md +1 -0
- package/agents/hatch3r-ci-watcher.md +1 -0
- package/agents/hatch3r-context-rules.md +1 -0
- package/agents/hatch3r-dependency-auditor.md +1 -0
- package/agents/hatch3r-devops.md +1 -0
- package/agents/hatch3r-docs-writer.md +1 -0
- package/agents/hatch3r-fixer.md +2 -0
- package/agents/hatch3r-implementer.md +32 -0
- package/agents/hatch3r-learnings-loader.md +56 -11
- package/agents/hatch3r-lint-fixer.md +2 -10
- package/agents/hatch3r-perf-profiler.md +1 -0
- package/agents/hatch3r-researcher.md +252 -0
- package/agents/hatch3r-reviewer.md +75 -3
- package/agents/hatch3r-security-auditor.md +3 -3
- package/agents/hatch3r-test-writer.md +2 -7
- package/commands/board/pickup-azure-devops.md +81 -0
- package/commands/board/pickup-delegation-multi.md +197 -0
- package/commands/board/pickup-delegation.md +100 -0
- package/commands/board/pickup-github.md +82 -0
- package/commands/board/pickup-gitlab.md +81 -0
- package/commands/board/pickup-modes.md +143 -0
- package/commands/board/pickup-post-impl.md +120 -0
- package/commands/board/shared-azure-devops.md +149 -0
- package/commands/board/shared-board-overview.md +215 -0
- package/commands/board/shared-github.md +169 -0
- package/commands/board/shared-gitlab.md +142 -0
- package/commands/hatch3r-agent-customize.md +3 -2
- package/commands/hatch3r-api-spec.md +1 -0
- package/commands/hatch3r-benchmark.md +1 -0
- package/commands/hatch3r-board-fill.md +15 -16
- package/commands/hatch3r-board-groom.md +50 -10
- package/commands/hatch3r-board-init.md +1 -0
- package/commands/hatch3r-board-pickup.md +44 -572
- package/commands/hatch3r-board-refresh.md +31 -10
- package/commands/hatch3r-board-shared.md +62 -439
- package/commands/hatch3r-bug-plan.md +1 -0
- package/commands/hatch3r-codebase-map.md +1 -0
- package/commands/hatch3r-command-customize.md +1 -0
- package/commands/hatch3r-context-health.md +1 -0
- package/commands/hatch3r-cost-tracking.md +1 -0
- package/commands/hatch3r-debug.md +1 -0
- package/commands/hatch3r-dep-audit.md +2 -1
- package/commands/hatch3r-feature-plan.md +1 -0
- package/commands/hatch3r-healthcheck.md +2 -1
- package/commands/hatch3r-hooks.md +1 -0
- package/commands/hatch3r-learn.md +1 -0
- package/commands/hatch3r-migration-plan.md +1 -0
- package/commands/hatch3r-onboard.md +1 -0
- package/commands/hatch3r-project-spec.md +1 -0
- package/commands/hatch3r-quick-change.md +1 -0
- package/commands/hatch3r-recipe.md +1 -0
- package/commands/hatch3r-refactor-plan.md +1 -0
- package/commands/hatch3r-release.md +2 -1
- package/commands/hatch3r-revision.md +1 -0
- package/commands/hatch3r-roadmap.md +8 -1
- package/commands/hatch3r-rule-customize.md +1 -0
- package/commands/hatch3r-security-audit.md +2 -1
- package/commands/hatch3r-skill-customize.md +1 -0
- package/commands/hatch3r-test-plan.md +532 -0
- package/commands/hatch3r-workflow.md +1 -0
- package/dist/cli/index.js +2640 -1057
- package/dist/cli/index.js.map +1 -1
- package/github-agents/hatch3r-docs-agent.md +1 -0
- package/github-agents/hatch3r-lint-agent.md +1 -0
- package/github-agents/hatch3r-security-agent.md +1 -0
- package/github-agents/hatch3r-test-agent.md +1 -0
- package/hooks/hatch3r-ci-failure.md +1 -0
- package/hooks/hatch3r-file-save.md +1 -0
- package/hooks/hatch3r-post-merge.md +1 -0
- package/hooks/hatch3r-pre-commit.md +1 -0
- package/hooks/hatch3r-pre-push.md +1 -0
- package/hooks/hatch3r-session-start.md +1 -0
- package/package.json +2 -2
- package/prompts/hatch3r-bug-triage.md +1 -0
- package/prompts/hatch3r-code-review.md +1 -0
- package/prompts/hatch3r-pr-description.md +1 -0
- package/rules/hatch3r-accessibility-standards.md +1 -0
- package/rules/hatch3r-agent-orchestration.md +277 -73
- package/rules/hatch3r-api-design.md +1 -0
- package/rules/hatch3r-browser-verification.md +1 -0
- package/rules/hatch3r-ci-cd.md +1 -0
- package/rules/hatch3r-code-standards.md +9 -0
- package/rules/hatch3r-component-conventions.md +1 -0
- package/rules/hatch3r-data-classification.md +1 -0
- package/rules/hatch3r-deep-context.md +1 -0
- package/rules/hatch3r-dependency-management.md +13 -0
- package/rules/hatch3r-feature-flags.md +1 -0
- package/rules/hatch3r-git-conventions.md +1 -0
- package/rules/hatch3r-i18n.md +1 -0
- package/rules/hatch3r-learning-consult.md +1 -0
- package/rules/hatch3r-migrations.md +12 -0
- package/rules/hatch3r-observability.md +290 -0
- package/rules/hatch3r-performance-budgets.md +1 -0
- package/rules/hatch3r-secrets-management.md +1 -0
- package/rules/hatch3r-security-patterns.md +12 -0
- package/rules/hatch3r-testing.md +1 -0
- package/rules/hatch3r-theming.md +1 -0
- package/rules/hatch3r-tooling-hierarchy.md +1 -0
- package/skills/hatch3r-a11y-audit/SKILL.md +1 -0
- package/skills/hatch3r-agent-customize/SKILL.md +1 -0
- package/skills/hatch3r-api-spec/SKILL.md +1 -0
- package/skills/hatch3r-architecture-review/SKILL.md +1 -0
- package/skills/hatch3r-bug-fix/SKILL.md +1 -0
- package/skills/hatch3r-ci-pipeline/SKILL.md +1 -0
- package/skills/hatch3r-command-customize/SKILL.md +1 -0
- package/skills/hatch3r-context-health/SKILL.md +1 -0
- package/skills/hatch3r-cost-tracking/SKILL.md +1 -0
- package/skills/hatch3r-dep-audit/SKILL.md +1 -0
- package/skills/hatch3r-feature/SKILL.md +1 -0
- package/skills/hatch3r-gh-agentic-workflows/SKILL.md +1 -0
- package/skills/hatch3r-incident-response/SKILL.md +1 -0
- package/skills/hatch3r-issue-workflow/SKILL.md +1 -0
- package/skills/hatch3r-logical-refactor/SKILL.md +1 -0
- package/skills/hatch3r-migration/SKILL.md +1 -0
- package/skills/hatch3r-perf-audit/SKILL.md +1 -0
- package/skills/hatch3r-pr-creation/SKILL.md +1 -0
- package/skills/hatch3r-qa-validation/SKILL.md +1 -0
- package/skills/hatch3r-recipe/SKILL.md +1 -0
- package/skills/hatch3r-refactor/SKILL.md +1 -0
- package/skills/hatch3r-release/SKILL.md +1 -0
- package/skills/hatch3r-rule-customize/SKILL.md +1 -0
- package/skills/hatch3r-skill-customize/SKILL.md +1 -0
- package/skills/hatch3r-visual-refactor/SKILL.md +1 -0
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**Crack the egg. Hatch better agents.**
|
|
6
6
|
|
|
7
|
-
hatch3r is an open-source CLI and Cursor plugin that installs a battle-tested, tool-agnostic agentic coding setup into any repository. One command gives you 16 agents, 25 skills, 22 rules,
|
|
7
|
+
hatch3r is an open-source CLI and Cursor plugin that installs a battle-tested, tool-agnostic agentic coding setup into any repository. One command gives you up to 16 agents, 25 skills, 22 rules, 34 commands, and MCP integrations -- optimized for your coding tool of choice. Selective init installs only what you need based on your project type and team size.
|
|
8
8
|
|
|
9
9
|
## Quick Start
|
|
10
10
|
|
|
@@ -14,7 +14,7 @@ Requires Node.js 22+.
|
|
|
14
14
|
npx hatch3r init
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
-
That's it. hatch3r detects your repo, asks
|
|
17
|
+
That's it. hatch3r detects your repo, asks about your project context (greenfield/brownfield, solo/team), lets you choose a content profile (minimal/standard/full/custom), and generates everything. The platform (GitHub, Azure DevOps, or GitLab) is auto-detected from your git remote. Run into issues? See [Troubleshooting](https://docs.hatch3r.com/docs/troubleshooting).
|
|
18
18
|
|
|
19
19
|
## What You Get
|
|
20
20
|
|
|
@@ -23,63 +23,30 @@ That's it. hatch3r detects your repo, asks which platform and tools you use, and
|
|
|
23
23
|
| **Agents** | 16 | Code reviewer, test writer, security auditor, implementer (sub-agentic), fixer, researcher, architect, DevOps, and more |
|
|
24
24
|
| **Skills** | 25 | Bug fix, feature implementation, issue workflow, release, incident response, context health, cost tracking, recipes, API spec, CI pipeline, migration, customization, and more |
|
|
25
25
|
| **Rules** | 22 | Code standards, testing, API design, observability, theming, i18n, security patterns, agent orchestration, deep context analysis, and more |
|
|
26
|
-
| **Commands** |
|
|
26
|
+
| **Commands** | 34 | Board management, planning (feature, bug, refactor, test), workflow, quick-change, revision, debug, healthcheck, security-audit, cost-tracking, onboard, benchmark, customization, and more |
|
|
27
27
|
| **MCP Servers** | 10 (3 default + 7 opt-in) | Playwright, Context7, Filesystem (default); GitHub, Brave Search, Sentry, Postgres, Linear, Azure DevOps, GitLab (opt-in) |
|
|
28
28
|
| **Platforms** | 3 | GitHub, Azure DevOps, GitLab -- auto-detected from git remote |
|
|
29
29
|
|
|
30
|
-
## Supported
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
|
35
|
-
|
|
36
|
-
| **
|
|
37
|
-
| **
|
|
38
|
-
| **
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
-
|
|
50
|
-
- **Codex CLI** -- `AGENTS.md`, `codex.md`
|
|
51
|
-
- **Gemini CLI** -- `GEMINI.md`
|
|
52
|
-
- **Cline / Roo Code** -- `.clinerules`
|
|
53
|
-
- **Aider** -- `CONVENTIONS.md`
|
|
54
|
-
- **Kiro** -- `kiro.md`, specs
|
|
55
|
-
- **Goose** -- `.goosehints`
|
|
56
|
-
- **Zed** -- `.rules`
|
|
57
|
-
|
|
58
|
-
### MCP Configuration
|
|
59
|
-
|
|
60
|
-
**Connecting MCP servers**
|
|
61
|
-
|
|
62
|
-
- **Cursor (init):** MCP config is written to `.cursor/mcp.json` when you run `npx hatch3r init` and select MCP servers. Restart Cursor after init.
|
|
63
|
-
- **Cursor (plugin):** The plugin provides `mcp.json` at the project root. Cursor loads it from there or from `~/.cursor/mcp.json` (project-level takes precedence).
|
|
64
|
-
- **Claude Code:** Config goes to `.mcp.json` in the project root.
|
|
65
|
-
- **Other tools:** Copilot uses `.vscode/mcp.json`; Cline/Roo uses `.roo/mcp.json`.
|
|
66
|
-
|
|
67
|
-
**Managing secrets**
|
|
68
|
-
|
|
69
|
-
`hatch3r init` creates a `.env.mcp` file at the project root with all required environment variables for your selected MCP servers. This file is gitignored by default. Fill in your API keys:
|
|
70
|
-
|
|
71
|
-
```bash
|
|
72
|
-
# .env.mcp (generated by hatch3r init)
|
|
73
|
-
GITHUB_PAT=ghp_xxxx
|
|
74
|
-
BRAVE_API_KEY=xxxx
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
How secrets are loaded depends on your editor:
|
|
78
|
-
|
|
79
|
-
- **VS Code / Copilot**: Secrets load automatically from `.env.mcp` via the native `envFile` field -- no extra steps.
|
|
80
|
-
- **Cursor / Claude Code / others**: Source the file before launching your editor: `set -a && source .env.mcp && set +a && cursor .`
|
|
81
|
-
|
|
82
|
-
See [docs/mcp-setup.md](docs/mcp-setup.md) for full setup, per-server details, and PAT scope guidance.
|
|
30
|
+
## Supported Tools (14 Adapters)
|
|
31
|
+
|
|
32
|
+
| Tool | Output |
|
|
33
|
+
|------|--------|
|
|
34
|
+
| **Cursor** | `.mdc` rules, agents, skills, commands, MCP config |
|
|
35
|
+
| **GitHub Copilot** | instructions, prompts, GitHub agents |
|
|
36
|
+
| **Claude Code** | `CLAUDE.md`, skills, `.mcp.json` |
|
|
37
|
+
| **OpenCode** | `AGENTS.md`, `opencode.json` |
|
|
38
|
+
| **Windsurf** | `.windsurfrules` |
|
|
39
|
+
| **Amp** | `AGENTS.md` |
|
|
40
|
+
| **Codex CLI** | `AGENTS.md`, `codex.md` |
|
|
41
|
+
| **Gemini CLI** | `GEMINI.md` |
|
|
42
|
+
| **Cline / Roo Code** | `.clinerules` |
|
|
43
|
+
| **Aider** | `CONVENTIONS.md` |
|
|
44
|
+
| **Kiro** | `.kiro/steering/`, `.kiro/settings/mcp.json` |
|
|
45
|
+
| **Goose** | `.goosehints` |
|
|
46
|
+
| **Zed** | `.rules` |
|
|
47
|
+
| **Amazon Q** | `.amazonq/rules/`, `.amazonq/settings.json` |
|
|
48
|
+
|
|
49
|
+
Platform is auto-detected from your git remote during `hatch3r init`. All board commands, agents, rules, and skills adapt to your selected platform.
|
|
83
50
|
|
|
84
51
|
## How It Works
|
|
85
52
|
|
|
@@ -101,70 +68,29 @@ AGENTS.md <- Generated (OpenCode, Amp, Codex adapters)
|
|
|
101
68
|
GEMINI.md <- Generated (Gemini adapter)
|
|
102
69
|
.clinerules <- Generated (Cline adapter)
|
|
103
70
|
CONVENTIONS.md <- Generated (Aider adapter)
|
|
104
|
-
kiro
|
|
71
|
+
.kiro/ <- Generated (Kiro adapter)
|
|
105
72
|
.goosehints <- Generated (Goose adapter)
|
|
106
73
|
.rules <- Generated (Zed adapter)
|
|
74
|
+
.amazonq/ <- Generated (Amazon Q adapter)
|
|
75
|
+
.worktreeinclude <- Generated (worktree isolation)
|
|
107
76
|
```
|
|
108
77
|
|
|
109
78
|
hatch3r keeps one source of truth in `.agents/` and generates native configuration for each tool.
|
|
110
79
|
|
|
111
80
|
## Workflow
|
|
112
81
|
|
|
113
|
-
hatch3r provides a full project lifecycle, from setup to release
|
|
114
|
-
|
|
115
|
-
### 1. Initialize
|
|
116
|
-
|
|
117
|
-
```bash
|
|
118
|
-
npx hatch3r init
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
Interactive setup detects your repository and platform (GitHub, Azure DevOps, or GitLab), asks which coding tools you use, and generates all agents, skills, rules, commands, and MCP configuration. See the [agentic process diagrams](docs/agentic-process.md) for a visual overview of the full workflow.
|
|
122
|
-
|
|
123
|
-
> **Next steps after init:** For a new project, run `hatch3r-project-spec`. For an existing codebase, run `hatch3r-codebase-map`. To plan a single feature, run `hatch3r-feature-plan`. To investigate a complex bug, run `hatch3r-bug-plan`. To plan a refactoring effort, run `hatch3r-refactor-plan`. For small, board-free changes (typos, config tweaks, small refactors), run `hatch3r-quick-change`. Or skip straight to creating a `todo.md` and running `hatch3r-board-fill`.
|
|
124
|
-
|
|
125
|
-
### For new projects (greenfield)
|
|
126
|
-
|
|
127
|
-
If you're starting from scratch, use `hatch3r-project-spec` to generate documentation from your vision, then `hatch3r-roadmap` to create a phased plan:
|
|
128
|
-
|
|
129
|
-
1. Run `hatch3r-project-spec` with your project idea — produces `docs/specs/`, `docs/adr/`, and `todo.md`
|
|
130
|
-
2. Run `hatch3r-roadmap` to refine the plan into dependency-ordered epics
|
|
131
|
-
3. Continue with `hatch3r-board-fill` (step 4 below) to create GitHub issues
|
|
82
|
+
hatch3r provides a full project lifecycle, from setup to release:
|
|
132
83
|
|
|
133
|
-
|
|
84
|
+
1. **Initialize** -- `npx hatch3r init` detects your repo and platform, asks about context and profile, generates agents/skills/rules/commands/MCP. For headless CI, pass `--yes` with optional flags. See [agentic process diagrams](https://docs.hatch3r.com/docs/guides/agentic-process).
|
|
85
|
+
2. **Set up the board** -- `hatch3r-board-init` creates or connects a Projects V2 board with status fields, label taxonomy, and config writeback.
|
|
86
|
+
3. **Define work** -- Create a `todo.md` at the project root (one item per line).
|
|
87
|
+
4. **Fill the board** -- `hatch3r-board-fill` parses `todo.md`, classifies items, groups into epics, builds a dependency DAG, and marks issues `status:ready`.
|
|
88
|
+
5. **Groom the backlog** -- `hatch3r-board-groom` surfaces stale items, priority imbalances, and decomposition candidates for selective refinement.
|
|
89
|
+
6. **Pick up work** -- `hatch3r-board-pickup` auto-selects the next issue by dependency order and priority, creates a branch, delegates implementation, and opens a PR.
|
|
90
|
+
7. **Review cycle** -- Reviewer + fixer agents loop (max 3 iterations) until clean, then test-writer and security-auditor run final checks.
|
|
91
|
+
8. **Release** -- `hatch3r-release` determines the semver bump, generates a changelog, tags, and publishes.
|
|
134
92
|
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
1. Run `hatch3r-codebase-map` — spawns analyzers to discover modules, conventions, and tech debt
|
|
138
|
-
2. Run `hatch3r-roadmap` to plan improvements from the analysis
|
|
139
|
-
3. Continue with `hatch3r-board-fill` (step 4 below) to create GitHub issues
|
|
140
|
-
|
|
141
|
-
### 2. Set up the board
|
|
142
|
-
|
|
143
|
-
Run the `hatch3r-board-init` command to create or connect a GitHub Projects V2 board. You do not need to manually create a GitHub Project -- `hatch3r-board-init` handles project creation via GraphQL, configures status fields (Backlog, Ready, In Progress, In Review, Done), creates the full label taxonomy, and writes all IDs back to `hatch.json`.
|
|
144
|
-
|
|
145
|
-
### 3. Define work
|
|
146
|
-
|
|
147
|
-
Create a `todo.md` file at the project root with your planned work -- epics, features, bugs, refactors, anything. One item per line.
|
|
148
|
-
|
|
149
|
-
### 4. Fill the board
|
|
150
|
-
|
|
151
|
-
Run `hatch3r-board-fill` to parse `todo.md` and turn items into GitHub issues. `hatch3r-board-fill` classifies each item by type, priority, executor, area, and risk. It groups items into epics, analyzes dependencies, builds a dependency DAG, determines implementation order, identifies parallel work, and marks issues as `status:ready` when all readiness criteria are met.
|
|
152
|
-
|
|
153
|
-
### 5. Groom the backlog (ongoing)
|
|
154
|
-
|
|
155
|
-
As priorities shift, scope evolves, and work gets completed, run `hatch3r-board-groom` to refine the backlog. It surfaces stale items, priority imbalances, missing metadata, and decomposition candidates, then lets you selectively re-prioritize, reclassify, re-scope, archive, or restructure existing issues. Run periodically -- not required every cycle, but recommended when the board drifts from current reality.
|
|
156
|
-
|
|
157
|
-
### 6. Pick up work
|
|
158
|
-
|
|
159
|
-
Run `hatch3r-board-pickup` to auto-select the next best issue based on dependency order, priority, and readiness. It performs collision detection against in-progress work and open PRs, creates a branch, delegates implementation to the appropriate skill (or spawns parallel sub-agents for epics), runs quality checks, and creates a pull request with full board status sync.
|
|
160
|
-
|
|
161
|
-
### 7. Review cycle
|
|
162
|
-
|
|
163
|
-
The reviewer agent reviews the work. If Critical or Warning findings exist, the fixer agent automatically implements fixes, and the reviewer re-reviews — this loop repeats until clean (max 3 iterations). After the review loop passes, the test-writer and security-auditor agents run final quality checks in parallel. For structured post-implementation revision, open a fresh context window and run `hatch3r-revision` -- it interviews you for feedback, scans for agent leftovers, delegates fixes to specialist sub-agents, and drives toward merge readiness.
|
|
164
|
-
|
|
165
|
-
### 8. Release
|
|
166
|
-
|
|
167
|
-
Run the `hatch3r-release` command to cut a versioned release. It classifies merged PRs to determine the semantic version bump, generates a grouped changelog, runs quality gates, creates a git tag, publishes a GitHub release, and optionally triggers deployment.
|
|
93
|
+
> **After init:** For greenfield, run `hatch3r-project-spec` then `hatch3r-roadmap`. For brownfield, run `hatch3r-codebase-map`. For a single feature, run `hatch3r-feature-plan`. For small changes, run `hatch3r-quick-change`.
|
|
168
94
|
|
|
169
95
|
## Commands
|
|
170
96
|
|
|
@@ -177,169 +103,39 @@ npx hatch3r sync # Re-generate from canonical state
|
|
|
177
103
|
npx hatch3r update # Pull latest templates (safe merge)
|
|
178
104
|
npx hatch3r status # Check sync status between canonical and generated files
|
|
179
105
|
npx hatch3r validate # Validate canonical .agents/ structure
|
|
106
|
+
npx hatch3r verify # Verify file integrity checksums
|
|
107
|
+
npx hatch3r worktree-setup <path> # Set up gitignored files in a worktree
|
|
180
108
|
npx hatch3r add <pack> # Install a community pack (coming soon)
|
|
181
109
|
```
|
|
182
110
|
|
|
183
111
|
### Agent Commands
|
|
184
112
|
|
|
185
|
-
These commands are invoked inside your coding tool (e.g., as Cursor commands)
|
|
186
|
-
|
|
187
|
-
**`hatch3r-board-init`** -- Bootstrap a GitHub Projects V2 board for your repository. Creates a new project or connects to an existing one, configures status fields with five default columns, creates the full hatch3r label taxonomy (type, executor, status, priority, risk, meta), prompts for default branch (main/master), optionally migrates issues from another project, and writes all project IDs back to `hatch.json`. All mutations require user confirmation.
|
|
188
|
-
|
|
189
|
-
**`hatch3r-board-fill`** -- Parse `todo.md` and create GitHub epics and issues with full board reorganization. Deduplicates against existing issues, classifies each item by type/executor/priority/area/risk, groups into epics, builds a dependency graph, determines implementation order, identifies parallel work lanes, and marks issues as `status:ready` when all readiness criteria are met. Reads project documentation and codebase context to produce well-scoped issues.
|
|
190
|
-
|
|
191
|
-
**`hatch3r-board-groom`** -- Ongoing backlog refinement for existing board items. Scans all open issues, surfaces health-driven refinement suggestions (stale items, priority imbalances, missing metadata, decomposition candidates, duplicates), and lets you selectively apply grooming actions: re-prioritize, reclassify, re-scope, demote to triage, archive stale items, decompose oversized issues, merge duplicates, refresh dependencies, and remediate board health gaps. Complements `hatch3r-board-fill` (which ingests new work) and `hatch3r-board-refresh` (which is read-only).
|
|
192
|
-
|
|
193
|
-
**`hatch3r-board-pickup`** -- Pick up the next best issue from the board for development. Auto-selects based on dependency order and priority when no specific issue is referenced. Performs collision detection against in-progress work, creates a branch, marks the issue in-progress, runs adaptive deep context analysis (complexity scoring, requirements elicitation, similar implementation discovery, transitive dependency tracing), delegates to the appropriate implementation skill with convention lock, and creates a pull request with label transitions and Projects V2 status sync.
|
|
194
|
-
|
|
195
|
-
**`hatch3r-board-refresh`** -- Regenerate the living board overview dashboard on demand. Scans all open and recently closed issues, computes board health metrics (missing metadata, stale issues, blocked dependency chains), assigns recommended models using the quality-first heuristic, and updates the `meta:board-overview` issue with current status tables, epic progress, and health diagnostics. No user prompts required.
|
|
196
|
-
|
|
197
|
-
**`hatch3r-board-shared`** -- Shared context and procedures referenced by all board commands. Provides board configuration from `hatch.json`, GitHub context, Projects V2 sync procedure, label taxonomy, tooling directives, and token-saving guidelines. Not invoked directly.
|
|
198
|
-
|
|
199
|
-
**`hatch3r-healthcheck`** -- Create a full-product QA and testing audit epic. Discovers logical modules from the project's directory structure, creates a parent epic with one sub-issue per module plus cross-cutting audits for inter-module wiring and product vision alignment. Each audit sub-issue, when picked up via `hatch3r-board-pickup`, performs deep static analysis and produces a findings epic with actionable sub-issues.
|
|
200
|
-
|
|
201
|
-
**`hatch3r-security-audit`** -- Create a full-product security audit epic. Discovers logical modules from the project's directory structure, creates a parent epic with one sub-issue per module plus cross-cutting audits for trust boundaries and OWASP Top 10 alignment. Each module sub-issue audits 7 security domains (authentication, input validation, data protection, access control, secret management, error handling, API security) and produces a findings epic with severity-rated, actionable sub-issues.
|
|
202
|
-
|
|
203
|
-
**`hatch3r-dep-audit`** -- Scan, assess, and upgrade npm dependencies. Runs `npm audit` and `npm outdated` across root and workspace packages, categorizes findings by severity (CVEs, major/minor/patch outdated), researches migration paths via Context7 and web search, upgrades packages one at a time with testing after each, and creates tracking issues for any unaddressed items.
|
|
204
|
-
|
|
205
|
-
**`hatch3r-release`** -- Cut a versioned release with changelog. Determines the semantic version bump from merged PR classifications, generates a grouped changelog (features, fixes, refactors, docs, infra), runs quality verification, bumps `package.json`, creates a git tag, publishes a GitHub release with notes, and optionally verifies deployment.
|
|
113
|
+
These commands are invoked inside your coding tool (e.g., as Cursor commands).
|
|
206
114
|
|
|
207
|
-
|
|
115
|
+
**Board management:** `board-init`, `board-fill`, `board-groom`, `board-pickup`, `board-refresh`, `board-shared`
|
|
208
116
|
|
|
209
|
-
|
|
117
|
+
**Planning:** `project-spec`, `codebase-map`, `roadmap`, `feature-plan`, `bug-plan`, `refactor-plan`, `migration-plan`, `test-plan`, `api-spec`
|
|
210
118
|
|
|
211
|
-
|
|
119
|
+
**Workflow:** `workflow`, `quick-change`, `revision`, `debug`, `onboard`, `benchmark`, `hooks`, `learn`, `recipe`
|
|
212
120
|
|
|
213
|
-
|
|
121
|
+
**Operations:** `healthcheck`, `security-audit`, `dep-audit`, `release`, `context-health`, `cost-tracking`
|
|
214
122
|
|
|
215
|
-
|
|
123
|
+
**Customization:** `agent-customize`, `command-customize`, `skill-customize`, `rule-customize`
|
|
216
124
|
|
|
217
|
-
|
|
125
|
+
All commands are prefixed with `hatch3r-` (e.g., `hatch3r-board-fill`). See the [CLI Commands reference](https://docs.hatch3r.com/docs/reference/commands/cli-commands) and [Agent Commands reference](https://docs.hatch3r.com/docs/reference/commands/agent-commands) for full details.
|
|
218
126
|
|
|
219
|
-
|
|
127
|
+
## MCP Configuration
|
|
220
128
|
|
|
221
|
-
|
|
129
|
+
`hatch3r init` creates a `.env.mcp` file with required environment variables for your selected MCP servers (gitignored by default). MCP config is written to the tool-appropriate location (`.cursor/mcp.json`, `.mcp.json`, `.vscode/mcp.json`, etc.).
|
|
222
130
|
|
|
223
|
-
|
|
131
|
+
- **VS Code / Copilot**: Secrets load automatically via the native `envFile` field.
|
|
132
|
+
- **Cursor / Claude Code / others**: Source the file first: `set -a && source .env.mcp && set +a && cursor .`
|
|
224
133
|
|
|
225
|
-
|
|
134
|
+
See [MCP Setup](https://docs.hatch3r.com/docs/guides/mcp-setup) for full setup, per-server details, and PAT scope guidance.
|
|
226
135
|
|
|
227
|
-
|
|
136
|
+
## Platform Agentic Workflows
|
|
228
137
|
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
**`hatch3r-revision`** -- User-guided revision of agent-implemented code in a fresh context window. Reconstructs what was done from the git diff, interviews the user for structured feedback, proactively scans for agent leftovers (dead code, TODOs, type issues), delegates fixes to specialist sub-agents (implementer, lint-fixer, test-writer), runs quality checks, commits and pushes, and assesses merge readiness. Designed for the feedback loop between implementation and merge.
|
|
232
|
-
|
|
233
|
-
**`hatch3r-debug`** -- Standalone debug-and-fix command. Adds strategic debug logging (`[HATCH3R-DEBUG]` prefixed) to the affected code area, pauses for the user to reproduce the issue and provide runtime logs, performs root cause analysis from the collected evidence, implements the fix, removes all debug artifacts, and runs the full review-fix-test-security pipeline. Five stages: Gather Context, Add Debug Logging, Collect Logs, Root Cause Analysis, Implement Fix. No board integration required.
|
|
234
|
-
|
|
235
|
-
**`hatch3r-hooks`** -- Interactive hook management for event-driven agent activation. View, add, remove, and test lifecycle hooks that trigger agents on specific events (e.g., post-commit, pre-push, issue assignment). Supports both local and CI hook targets.
|
|
236
|
-
|
|
237
|
-
**`hatch3r-learn`** -- Capture learnings from completed issues, code reviews, and architectural decisions into reusable knowledge files. Learnings are indexed by topic and auto-consulted when similar work is encountered in the future.
|
|
238
|
-
|
|
239
|
-
**`hatch3r-context-health`** -- Monitor conversation context health and detect degradation during long agent sessions. Provides metrics on token usage, context window utilization, and recommendations for when to start a fresh session.
|
|
240
|
-
|
|
241
|
-
**`hatch3r-cost-tracking`** -- Track token usage and estimated costs across agent workflows. Provides per-command and per-agent cost breakdowns with budget alerts.
|
|
242
|
-
|
|
243
|
-
**`hatch3r-recipe`** -- Create and manage composable workflow recipes. Recipes are reusable workflow templates that chain multiple commands and skills into repeatable sequences.
|
|
244
|
-
|
|
245
|
-
**`hatch3r-agent-customize`** -- Configure per-agent customization via `.customize.yaml` files. Allows project-specific agent behavior overrides without modifying managed agent definitions.
|
|
246
|
-
|
|
247
|
-
**`hatch3r-command-customize`** -- Configure per-command customization via `.customize.yaml` files. Allows project-specific command behavior overrides without modifying managed command definitions.
|
|
248
|
-
|
|
249
|
-
**`hatch3r-skill-customize`** -- Configure per-skill customization via `.customize.yaml` files. Allows project-specific skill behavior overrides without modifying managed skill definitions.
|
|
250
|
-
|
|
251
|
-
**`hatch3r-rule-customize`** -- Configure per-rule customization via `.customize.yaml` files. Allows project-specific rule behavior overrides without modifying managed rule definitions.
|
|
252
|
-
|
|
253
|
-
## Agents
|
|
254
|
-
|
|
255
|
-
| Agent | Description |
|
|
256
|
-
|-------|-------------|
|
|
257
|
-
| **a11y-auditor** | Accessibility specialist who audits WCAG AA compliance -- keyboard navigation, color contrast, ARIA attributes, and reduced motion support. |
|
|
258
|
-
| **architect** | Architecture design and review specialist who evaluates system structure, proposes improvements, and produces ADRs. |
|
|
259
|
-
| **ci-watcher** | CI/CD specialist who monitors GitHub Actions runs, reads failure logs to identify root causes, and suggests focused fixes with local verification commands. |
|
|
260
|
-
| **context-rules** | Dynamic context rule generation agent that creates and maintains context-aware rules based on project patterns and conventions. |
|
|
261
|
-
| **dependency-auditor** | Supply chain security analyst who scans for CVEs, evaluates upgrade paths, assesses bundle size impact, and verifies lockfile integrity. |
|
|
262
|
-
| **devops** | CI/CD and deployment operations specialist who manages build pipelines, infrastructure configuration, and deployment workflows. |
|
|
263
|
-
| **docs-writer** | Technical writer who maintains specs, ADRs, glossary, and process documentation, keeping them in sync with code changes. |
|
|
264
|
-
| **implementer** | Focused implementation agent for a single sub-issue. Receives issue context from a parent orchestrator, delivers code and tests, and reports structured results. Does not handle git or board operations. |
|
|
265
|
-
| **learnings-loader** | Load and apply project learnings from the knowledge base to provide relevant context for current development tasks. |
|
|
266
|
-
| **lint-fixer** | Code quality enforcer who fixes ESLint, Prettier, and TypeScript strict mode violations without changing logic. Removes dead code and unused imports. |
|
|
267
|
-
| **perf-profiler** | Performance engineer who profiles runtime performance, analyzes bundle size, identifies memory leaks, and benchmarks against defined performance budgets. |
|
|
268
|
-
| **researcher** | Research specialist who performs deep investigation on assigned topics using parallel analysis. Used as a sub-agent by planning commands (project-spec, feature-plan, bug-plan, refactor-plan). |
|
|
269
|
-
| **reviewer** | Senior code reviewer who checks for correctness, security, privacy invariants, performance regressions, and accessibility. Outputs structured feedback by priority (critical, warning, suggestion). |
|
|
270
|
-
| **fixer** | Targeted fix agent that takes structured reviewer output (Critical and Warning findings) and implements minimal, focused fixes. Operates in the review loop between reviewer iterations. |
|
|
271
|
-
| **security-auditor** | Security analyst who audits database rules, cloud functions, and data flows. Verifies privacy invariants, writes security rules tests, and validates entitlement enforcement. |
|
|
272
|
-
| **test-writer** | QA engineer who writes deterministic, isolated tests -- unit, integration, E2E, security rules, and contract tests. Focuses on edge cases and regression coverage. |
|
|
273
|
-
|
|
274
|
-
## Skills
|
|
275
|
-
|
|
276
|
-
| Skill | Description |
|
|
277
|
-
|-------|-------------|
|
|
278
|
-
| **a11y-audit** | Comprehensive WCAG AA audit with automated scanning, manual verification, and fix implementation. |
|
|
279
|
-
| **agent-customize** | Configure per-agent customization via `.customize.yaml` files. |
|
|
280
|
-
| **api-spec** | API specification generation from project requirements, producing OpenAPI/Swagger specs with endpoint definitions, schemas, and documentation. |
|
|
281
|
-
| **architecture-review** | Evaluate architectural decisions, compare options with pros/cons, and produce ADRs following the project template. |
|
|
282
|
-
| **bug-fix** | Diagnose root cause, implement minimal fix, and write a regression test that fails before the fix. TDD/test-first workflow option. |
|
|
283
|
-
| **ci-pipeline** | CI/CD pipeline setup and configuration for GitHub Actions, including build, test, lint, and deploy workflows. |
|
|
284
|
-
| **command-customize** | Configure per-command customization via `.customize.yaml` files. |
|
|
285
|
-
| **context-health** | Monitor conversation context health and detect degradation during long sessions. |
|
|
286
|
-
| **cost-tracking** | Track token usage and estimated costs across agent workflows. |
|
|
287
|
-
| **dep-audit** | Audit npm dependencies for CVEs and freshness, research migration paths, upgrade one at a time with testing. |
|
|
288
|
-
| **feature** | End-to-end feature implementation as a vertical slice covering data model, domain logic, API, and UI. TDD/test-first workflow option. |
|
|
289
|
-
| **gh-agentic-workflows** | Set up GitHub Agentic Workflows for continuous AI-powered triage, testing, and documentation automation. Includes DoD, verification, troubleshooting, and rollback. |
|
|
290
|
-
| **incident-response** | Structured triage, mitigation, root cause analysis, and post-mortem for production incidents with follow-up issues. |
|
|
291
|
-
| **issue-workflow** | 8-step development workflow for GitHub issues: parse, load skill, read specs, plan, implement, test, PR, address review. |
|
|
292
|
-
| **logical-refactor** | Change business logic or data flows without adding features, with explicit invariant tracking and verification. |
|
|
293
|
-
| **migration** | Database and system migration planning with backward-compatible schema changes, rollback plans, and phased execution. |
|
|
294
|
-
| **perf-audit** | Profile and optimize against defined performance budgets with before/after measurements for every change. |
|
|
295
|
-
| **pr-creation** | Create pull requests following project conventions -- branch naming, PR template, self-review checklist, and size guidelines. |
|
|
296
|
-
| **qa-validation** | E2E validation workflow producing structured pass/fail reports with evidence and ship/hold recommendations. |
|
|
297
|
-
| **recipe** | Create and manage composable workflow recipes. |
|
|
298
|
-
| **refactor** | Internal code quality improvement without changing external behavior, with behavioral preservation tests. |
|
|
299
|
-
| **release** | Cut a release with semantic versioning, changelog generation, pre-release/RC support, git tagging, and deploy verification. |
|
|
300
|
-
| **rule-customize** | Configure per-rule customization via `.customize.yaml` files. |
|
|
301
|
-
| **skill-customize** | Configure per-skill customization via `.customize.yaml` files. |
|
|
302
|
-
| **visual-refactor** | UI/UX changes matching design mockups with WCAG AA accessibility and responsiveness verification. |
|
|
303
|
-
|
|
304
|
-
## Rules
|
|
305
|
-
|
|
306
|
-
| Rule | Description |
|
|
307
|
-
|------|-------------|
|
|
308
|
-
| **accessibility-standards** | WCAG AA compliance, ARIA, focus management, color contrast, keyboard and screen reader support, and inclusive design. |
|
|
309
|
-
| **agent-orchestration** | Agent delegation patterns, sub-agent spawning conventions, result aggregation, and multi-agent coordination protocols. |
|
|
310
|
-
| **api-design** | Endpoint versioning, request validation, idempotency keys, structured error responses, auth, CORS, CSP, pagination, and webhook security. |
|
|
311
|
-
| **browser-verification** | When and how to verify UI changes in the browser via automation MCP — dev server lifecycle, navigation, interaction, visual regression, screenshot evidence. |
|
|
312
|
-
| **ci-cd** | CI/CD pipeline standards, build caching, artifact management, deployment gates, and rollback procedures. |
|
|
313
|
-
| **code-standards** | TypeScript strict mode, naming conventions (`camelCase`/`PascalCase`/`SCREAMING_SNAKE`), and function/file length limits. |
|
|
314
|
-
| **component-conventions** | Component structure, typed props/emits, design tokens, WCAG AA accessibility, loading/error/empty states, form UX, and 60fps render targets. |
|
|
315
|
-
| **data-classification** | Data sensitivity levels, PII handling, encryption requirements, retention policies, and cross-border compliance. |
|
|
316
|
-
| **deep-context** | Deep context retrieval, codebase understanding, and efficient context management for AI agents. |
|
|
317
|
-
| **dependency-management** | Lockfile hygiene, new-dependency justification, CVE patching timelines (48h for critical), and bundle size budgets. |
|
|
318
|
-
| **feature-flags** | Flag naming (`FF_AREA_FEATURE`), storage, evaluation, gradual rollout, dependencies, kill switches, 30-day cleanup deadlines, and audit. |
|
|
319
|
-
| **git-conventions** | Git workflow, branch naming, commit message conventions, and merge strategy. |
|
|
320
|
-
| **i18n** | Internationalization, RTL support, locale management, and ICU message format. |
|
|
321
|
-
| **learning-consult** | When and how to consult project learnings during development. |
|
|
322
|
-
| **migrations** | Backward-compatible schema changes, idempotent scripts, rollback plans, and deploy-then-migrate ordering. |
|
|
323
|
-
| **observability** | Structured JSON logging, OpenTelemetry, SLO/SLI, distributed tracing, alerting, dashboards, and no PII in logs. |
|
|
324
|
-
| **performance-budgets** | Core Web Vitals, API latency, database query budgets, bundle size, and enforcement mechanisms. |
|
|
325
|
-
| **secrets-management** | Secret rotation, vault integration, environment variable handling, and credential lifecycle management. |
|
|
326
|
-
| **security-patterns** | Input validation, output encoding, auth enforcement, AI/agentic security, and OWASP alignment. |
|
|
327
|
-
| **testing** | Deterministic, isolated, fast tests with clear naming, regression coverage, no network in unit tests, no `any`. |
|
|
328
|
-
| **theming** | Dark mode, `prefers-color-scheme`, CSS custom properties, and semantic color tokens. |
|
|
329
|
-
| **tooling-hierarchy** | Priority order for knowledge: project specs > codebase > library docs (Context7 MCP) > web research; GitHub CLI-first. |
|
|
330
|
-
|
|
331
|
-
## Board Management
|
|
332
|
-
|
|
333
|
-
hatch3r includes a complete board management system supporting GitHub, Azure DevOps, and GitLab:
|
|
334
|
-
|
|
335
|
-
- **`hatch3r-board-init`** -- Create or connect a GitHub Projects V2 board with status fields, label taxonomy, and optional migration
|
|
336
|
-
- **`hatch3r-board-fill`** -- Parse `todo.md`, create epics/issues, deduplicate, analyze dependencies, set implementation order
|
|
337
|
-
- **`hatch3r-board-groom`** -- Ongoing backlog refinement: re-prioritize, reclassify, re-scope, archive stale items, decompose, merge duplicates, refresh dependencies
|
|
338
|
-
- **`hatch3r-board-pickup`** -- Auto-pick the next best issue, check collisions, delegate to sub-agents, create PRs
|
|
339
|
-
- **`hatch3r-board-refresh`** -- Regenerate the board overview dashboard with current state, health metrics, and model recommendations
|
|
340
|
-
- **`hatch3r-board-shared`** -- Configurable shared context (org, repo, project board IDs, label taxonomy)
|
|
341
|
-
|
|
342
|
-
Configure your board in `hatch.json`:
|
|
138
|
+
hatch3r includes a complete board management system supporting GitHub, Azure DevOps, and GitLab. Configure in `hatch.json`:
|
|
343
139
|
|
|
344
140
|
```json
|
|
345
141
|
{
|
|
@@ -351,148 +147,61 @@ Configure your board in `hatch.json`:
|
|
|
351
147
|
},
|
|
352
148
|
"models": {
|
|
353
149
|
"default": "opus",
|
|
354
|
-
"agents": {
|
|
355
|
-
"hatch3r-lint-fixer": "sonnet"
|
|
356
|
-
}
|
|
150
|
+
"agents": { "hatch3r-lint-fixer": "sonnet" }
|
|
357
151
|
}
|
|
358
152
|
}
|
|
359
153
|
```
|
|
360
154
|
|
|
361
|
-
## Model Selection
|
|
362
|
-
|
|
363
|
-
hatch3r lets you set preferred AI models per agent. Configure via `hatch.json` (global default and per-agent overrides), canonical agent frontmatter (`model: opus` in `.agents/agents/*.md`), or `.hatch3r/agents/{id}.customize.yaml`. Resolution order: customization file > manifest per-agent > agent frontmatter > manifest default. If you omit `models`, each tool uses its own default.
|
|
364
|
-
|
|
365
|
-
See [docs/model-selection.md](docs/model-selection.md) for the full guide, aliases, and platform support.
|
|
366
|
-
|
|
367
155
|
## Sub-Agentic Architecture
|
|
368
156
|
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
- **Four-phase pipeline** -- Research → Implement → Review Loop (reviewer + fixer, max 3 iterations) → Final Quality (testing + security)
|
|
157
|
+
- **Four-phase pipeline** -- Research, Implement, Review Loop (reviewer + fixer, max 3 iterations), Final Quality (testing + security)
|
|
372
158
|
- **Implementer agent** -- Receives a single sub-issue, delivers code + tests, reports back
|
|
373
|
-
- **Fixer agent** -- Takes reviewer findings and implements targeted fixes
|
|
159
|
+
- **Fixer agent** -- Takes reviewer findings and implements targeted fixes
|
|
374
160
|
- **Issue workflow skill** -- 8-step structured workflow with parallel sub-agent delegation for epics
|
|
375
|
-
- **Board pickup** -- Dependency-aware auto-pick with collision detection and sub-agent orchestration
|
|
376
161
|
- **Tooling hierarchy** -- Project docs > Codebase search > Library docs (Context7) > Web research
|
|
377
162
|
|
|
378
|
-
##
|
|
379
|
-
|
|
380
|
-
hatch3r projects use a `docs/` folder with three core subdirectories. The docs-writer agent reads source code and maintains these docs automatically, keeping specs, decisions, and processes in sync with implementation.
|
|
381
|
-
|
|
382
|
-
```
|
|
383
|
-
docs/
|
|
384
|
-
specs/ Modular specifications with stable IDs
|
|
385
|
-
adr/ Architecture Decision Records
|
|
386
|
-
process/ Process documentation
|
|
387
|
-
```
|
|
163
|
+
## Content Profiles
|
|
388
164
|
|
|
389
|
-
|
|
165
|
+
During `hatch3r init`, you choose a content profile:
|
|
390
166
|
|
|
391
|
-
|
|
167
|
+
| Profile | What's included | Best for |
|
|
168
|
+
|---------|----------------|----------|
|
|
169
|
+
| **Minimal** | Core agents and workflows only (`core` tag) | Quick setup, minimal footprint |
|
|
170
|
+
| **Standard** (recommended) | Full development lifecycle without niche audits | Most projects |
|
|
171
|
+
| **Full** | Everything including board management and all audits | Large teams, full coverage |
|
|
172
|
+
| **Custom** | Choose exactly what you need | Fine-grained control |
|
|
392
173
|
|
|
393
|
-
|
|
394
|
-
|------|---------|
|
|
395
|
-
| `00_glossary.md` | Term definitions, stable ID prefixes, TOC for all specs |
|
|
396
|
-
| `01_core-engine.md` | Core engine behavior, invariants, acceptance criteria |
|
|
397
|
-
| `02_event-model.md` | Event schemas, lifecycle, validation rules |
|
|
398
|
-
| `03_quality-engineering.md` | Performance budgets, testing pyramid, coverage targets |
|
|
399
|
-
|
|
400
|
-
Conventions:
|
|
401
|
-
- Every spec starts with a **Purpose** section and ends with **Owner / Reviewers / Last updated**.
|
|
402
|
-
- Use stable IDs from the glossary (e.g., `INV-001`, `EVT_USER_CREATED`) so agents and humans can reference specific requirements across docs, issues, and code.
|
|
403
|
-
- Feature matrices, invariants, and schemas use tables. Acceptance criteria use checklists.
|
|
404
|
-
|
|
405
|
-
### `docs/adr/` -- Architecture Decision Records
|
|
406
|
-
|
|
407
|
-
Numbered records that capture significant architectural decisions, their context, and consequences.
|
|
408
|
-
|
|
409
|
-
| File | Purpose |
|
|
410
|
-
|------|---------|
|
|
411
|
-
| `0001_template.md` | ADR template with required sections |
|
|
412
|
-
| `0002_adapter-pattern.md` | Example: why the project uses an adapter pattern |
|
|
413
|
-
|
|
414
|
-
Each ADR includes: Status, Date, Decision Makers, Context, Decision, Alternatives Considered (with pros/cons table), Consequences, Compliance checklist, and Related links. New ADRs use the next available number and are saved as `XXXX_short-title.md`. Superseded ADRs are updated to reference their replacement.
|
|
415
|
-
|
|
416
|
-
### `docs/process/` -- Process Documentation
|
|
417
|
-
|
|
418
|
-
Guides for recurring workflows -- how the team (human or agent) ships, reviews, and maintains the project.
|
|
419
|
-
|
|
420
|
-
Examples: branching strategy, release process, on-call runbook, code review checklist, agent delegation guidelines.
|
|
421
|
-
|
|
422
|
-
### Relationship to the GSD Framework
|
|
423
|
-
|
|
424
|
-
The [GSD (Get Shit Done)](https://github.com/gsd-build/get-shit-done) framework is a spec-driven development system for AI coding assistants. hatch3r shares GSD's conviction that structured documentation prevents context degradation, but the two projects organize that documentation differently.
|
|
425
|
-
|
|
426
|
-
**Shared principles:**
|
|
427
|
-
|
|
428
|
-
- Documentation is the primary context source for AI agents, not just a reference for humans.
|
|
429
|
-
- Specifications are modular and scoped to single domains rather than monolithic.
|
|
430
|
-
- State and decisions are captured in version-controlled markdown, not ephemeral chat.
|
|
431
|
-
- Stable identifiers enable reliable cross-referencing across docs, code, and issues.
|
|
432
|
-
|
|
433
|
-
**Structural differences:**
|
|
434
|
-
|
|
435
|
-
| Concern | GSD | hatch3r |
|
|
436
|
-
|---------|-----|---------|
|
|
437
|
-
| Project state | `STATE.md` (single file, session memory) | `docs/specs/` (distributed across domain specs) |
|
|
438
|
-
| Requirements | `REQUIREMENTS.md` (flat, phase-tagged) | `docs/specs/*.md` (modular, per-domain with stable IDs) |
|
|
439
|
-
| Architectural decisions | Inline in `STATE.md` or plans | `docs/adr/` (dedicated, numbered, templated) |
|
|
440
|
-
| Project vision | `PROJECT.md` | `docs/specs/00_glossary.md` + project README |
|
|
441
|
-
| Process docs | Encoded in GSD commands and agents | `docs/process/` (explicit, human-readable guides) |
|
|
442
|
-
| Planning artifacts | `.planning/` (research, plans, summaries) | GitHub Issues + board commands |
|
|
443
|
-
| Scope | Single-project, single-runtime | Multi-project, multi-editor via adapters |
|
|
444
|
-
|
|
445
|
-
GSD optimizes for a linear milestone-driven workflow with a single AI runtime. hatch3r's `docs/` structure is editor-agnostic and designed to be consumed by any agent system -- Cursor, Copilot, Claude Code, OpenCode, or custom tooling. The explicit `docs/adr/` directory reflects hatch3r's emphasis on long-lived, multi-contributor projects where architectural decisions need formal traceability rather than inline state tracking.
|
|
446
|
-
|
|
447
|
-
## Presets
|
|
448
|
-
|
|
449
|
-
hatch3r currently ships with the `default` preset which includes everything. Additional preset packs (web-app, api-service, cli-tool, monorepo, legacy, security) are planned for future releases.
|
|
174
|
+
Content is tagged with workflow, context, and domain tags. After init, use `hatch3r config` to add or remove individual content items.
|
|
450
175
|
|
|
451
176
|
## Customization
|
|
452
177
|
|
|
453
|
-
hatch3r
|
|
178
|
+
hatch3r separates managed from custom files:
|
|
454
179
|
|
|
455
|
-
- `hatch3r-*` files are managed by hatch3r
|
|
180
|
+
- `hatch3r-*` files are managed by hatch3r and fully replaced on update
|
|
456
181
|
- Files without the prefix are your customizations and are never touched
|
|
182
|
+
- All hatch3r-generated markdown files use managed blocks (`<!-- HATCH3R:BEGIN -->` / `<!-- HATCH3R:END -->`). Content outside these markers is preserved. Bridge files are emitted by 14 adapters: Cursor, Claude, Copilot, Cline, Codex, Gemini, Windsurf, Amp, OpenCode, Aider, Kiro, Goose, Zed, Amazon Q.
|
|
457
183
|
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
```
|
|
461
|
-
.cursor/rules/
|
|
462
|
-
hatch3r-code-standards.mdc # Managed — add custom content outside the block
|
|
463
|
-
my-project-conventions.mdc # Custom — never touched
|
|
464
|
-
```
|
|
465
|
-
|
|
466
|
-
Example: add your own sections to any hatch3r file:
|
|
184
|
+
## Model Selection
|
|
467
185
|
|
|
468
|
-
|
|
469
|
-
<!-- HATCH3R:BEGIN -->
|
|
470
|
-
...managed content (updated on sync/update)...
|
|
471
|
-
<!-- HATCH3R:END -->
|
|
186
|
+
Configure preferred AI models per agent via `hatch.json` (global default and per-agent overrides), canonical agent frontmatter, or `.hatch3r/agents/{id}.customize.yaml`. Resolution order: customization file > manifest per-agent > agent frontmatter > manifest default.
|
|
472
187
|
|
|
473
|
-
|
|
474
|
-
...never overwritten...
|
|
475
|
-
```
|
|
188
|
+
See [Model Selection](https://docs.hatch3r.com/docs/guides/model-selection) for the full guide.
|
|
476
189
|
|
|
477
190
|
## Cursor Plugin
|
|
478
191
|
|
|
479
|
-
hatch3r is also available as a [Cursor plugin](https://cursor.com/marketplace). Enable it
|
|
480
|
-
|
|
481
|
-
## Community Packs
|
|
482
|
-
|
|
483
|
-
Community pack support is coming soon.
|
|
192
|
+
hatch3r is also available as a [Cursor plugin](https://cursor.com/marketplace). Enable it for instant access to all rules, skills, agents, and commands without running `init`.
|
|
484
193
|
|
|
485
194
|
## Documentation
|
|
486
195
|
|
|
487
|
-
Full documentation is available
|
|
196
|
+
Full documentation is available at [docs.hatch3r.com](https://docs.hatch3r.com).
|
|
488
197
|
|
|
489
|
-
- [MCP Setup](docs/mcp-setup
|
|
490
|
-
- [Adapter Capability Matrix](docs/adapter-capability-matrix
|
|
491
|
-
- [Agent Teams](docs/agent-teams
|
|
492
|
-
- [Model Selection](docs/model-selection
|
|
493
|
-
- [Agentic Process](docs/agentic-process
|
|
494
|
-
- [Troubleshooting](docs/troubleshooting
|
|
495
|
-
- [Changelog](CHANGELOG.md)
|
|
198
|
+
- [MCP Setup](https://docs.hatch3r.com/docs/guides/mcp-setup) -- Connecting MCP servers and managing secrets
|
|
199
|
+
- [Adapter Capability Matrix](https://docs.hatch3r.com/docs/reference/adapter-capability-matrix) -- Per-tool support and output paths
|
|
200
|
+
- [Agent Teams](https://docs.hatch3r.com/docs/guides/agent-teams) -- Multi-agent team coordination and delegation patterns
|
|
201
|
+
- [Model Selection](https://docs.hatch3r.com/docs/guides/model-selection) -- Configuring AI models per agent
|
|
202
|
+
- [Agentic Process](https://docs.hatch3r.com/docs/guides/agentic-process) -- Visual diagrams of init flow, board workflow, and agent orchestration
|
|
203
|
+
- [Troubleshooting](https://docs.hatch3r.com/docs/troubleshooting) -- Common issues and solutions
|
|
204
|
+
- [Changelog](CHANGELOG.md) -- Release history
|
|
496
205
|
|
|
497
206
|
## License
|
|
498
207
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
id: hatch3r-a11y-auditor
|
|
3
3
|
description: Accessibility specialist who audits for WCAG AA compliance. Use when auditing accessibility, reviewing UI components, or fixing a11y issues.
|
|
4
4
|
model: standard
|
|
5
|
+
tags: [review, a11y]
|
|
5
6
|
---
|
|
6
7
|
You are an accessibility specialist for the project.
|
|
7
8
|
|
|
@@ -38,12 +39,14 @@ Browser verification provides ground-truth confirmation that cannot be achieved
|
|
|
38
39
|
|
|
39
40
|
## Standards to Enforce
|
|
40
41
|
|
|
42
|
+
Follow the full accessibility standards defined in `.agents/rules/hatch3r-accessibility-standards.md` (WCAG 2.2 AA compliance, keyboard navigation, focus management, color/contrast, screen reader support, ARIA patterns, motion, forms). Summary of key thresholds:
|
|
43
|
+
|
|
41
44
|
| Requirement | Standard | Details |
|
|
42
45
|
| ------------------- | -------- | ---------------------------------------------------------------- |
|
|
43
|
-
| Reduced motion | WCAG 2.
|
|
44
|
-
| Color contrast | WCAG AA | Text contrast ratio
|
|
45
|
-
| Keyboard navigation | WCAG 2.
|
|
46
|
-
| Screen reader | WCAG 2.
|
|
46
|
+
| Reduced motion | WCAG 2.2 | All animations respect `prefers-reduced-motion` and user setting |
|
|
47
|
+
| Color contrast | WCAG AA | Text contrast ratio >= 4.5:1, non-text >= 3:1 |
|
|
48
|
+
| Keyboard navigation | WCAG 2.2 | All interactive elements focusable with visible focus indicator |
|
|
49
|
+
| Screen reader | WCAG 2.2 | Dynamic state announced via `aria-live` regions |
|
|
47
50
|
| High contrast mode | Custom | User-configurable high contrast theme supported |
|
|
48
51
|
|
|
49
52
|
## Commands
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
id: hatch3r-architect
|
|
3
3
|
description: System architect who designs architecture, creates ADRs, analyzes dependencies, designs APIs and database schemas, and evaluates architectural trade-offs. Use when making architectural decisions, designing new systems, or evaluating design trade-offs.
|
|
4
4
|
model: standard
|
|
5
|
+
tags: [planning]
|
|
5
6
|
---
|
|
6
7
|
You are a senior system architect for the project.
|
|
7
8
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
id: hatch3r-ci-watcher
|
|
3
3
|
description: CI/CD specialist who monitors CI pipeline runs, diagnoses failures, and suggests fixes. Use when CI fails, when waiting for CI results, or when investigating flaky tests.
|
|
4
4
|
model: fast
|
|
5
|
+
tags: [devops]
|
|
5
6
|
---
|
|
6
7
|
You are a CI/CD specialist for the project.
|
|
7
8
|
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
id: hatch3r-context-rules
|
|
3
3
|
description: Context-aware rules engine that applies coding standards based on file type, location, and project conventions. Use when enforcing project rules on save or reviewing files against established patterns.
|
|
4
4
|
model: fast
|
|
5
|
+
tags: [core, maintenance]
|
|
5
6
|
---
|
|
6
7
|
You are a context-aware rules engine for the project.
|
|
7
8
|
|