claude-code-autoconfig 1.0.183 → 1.0.185
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/agents/README.md +10 -0
- package/.claude/docs/autoconfig.docs.html +14 -111
- package/.claude/scripts/sync-docs.js +1 -1
- package/CHANGELOG.md +0 -6
- package/README.md +2 -18
- package/package.json +1 -1
- package/.claude/agents/create-retro-item.md +0 -62
- package/.claude/agents/docs-refresh.md +0 -21
- package/.claude/commands/enable-retro.md +0 -58
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
<!-- @description Placeholder — drop your project's custom subagent definitions in this directory. -->
|
|
2
|
+
|
|
3
|
+
# Agents
|
|
4
|
+
|
|
5
|
+
This directory is where you define **subagents** — focused assistants Claude can delegate to during a task (e.g., a code reviewer, a test writer, a security auditor).
|
|
6
|
+
|
|
7
|
+
claude-code-autoconfig ships this folder empty so you can populate it with agents tuned to your project. Each agent is a single Markdown file with frontmatter describing its purpose, tools, and system prompt.
|
|
8
|
+
|
|
9
|
+
See Anthropic's subagents docs for the file format:
|
|
10
|
+
https://docs.anthropic.com/en/docs/claude-code/sub-agents
|
|
@@ -878,11 +878,6 @@
|
|
|
878
878
|
<span class="tree-file-icon">📄</span>
|
|
879
879
|
<span class="file">commit-and-push.md</span>
|
|
880
880
|
</div>
|
|
881
|
-
<div class="tree-item indent-3 hidden" data-info="enable-retro" data-parent="commands">
|
|
882
|
-
<span class="tree-spacer"></span>
|
|
883
|
-
<span class="tree-file-icon">📄</span>
|
|
884
|
-
<span class="file">enable-retro.md</span>
|
|
885
|
-
</div>
|
|
886
881
|
<div class="tree-item indent-3 hidden" data-info="extract-rules" data-parent="commands">
|
|
887
882
|
<span class="tree-spacer"></span>
|
|
888
883
|
<span class="tree-file-icon">📄</span>
|
|
@@ -923,15 +918,10 @@
|
|
|
923
918
|
<span class="tree-folder-icon">📁</span>
|
|
924
919
|
<span class="folder">agents</span>
|
|
925
920
|
</div>
|
|
926
|
-
<div class="tree-item indent-3 hidden" data-info="
|
|
921
|
+
<div class="tree-item indent-3 hidden" data-info="README-agent" data-parent="agents">
|
|
927
922
|
<span class="tree-spacer"></span>
|
|
928
923
|
<span class="tree-file-icon">📄</span>
|
|
929
|
-
<span class="file">
|
|
930
|
-
</div>
|
|
931
|
-
<div class="tree-item indent-3 hidden" data-info="docs-refresh-agent" data-parent="agents">
|
|
932
|
-
<span class="tree-spacer"></span>
|
|
933
|
-
<span class="tree-file-icon">📄</span>
|
|
934
|
-
<span class="file">docs-refresh.md</span>
|
|
924
|
+
<span class="file">README.md</span>
|
|
935
925
|
</div>
|
|
936
926
|
<div class="tree-item indent-2 folder-row hidden collapsed" data-info="feedback" data-folder="feedback" data-parent="claude-dir">
|
|
937
927
|
<span class="tree-chevron">›</span>
|
|
@@ -1268,7 +1258,7 @@
|
|
|
1268
1258
|
title: '.claude/ Directory',
|
|
1269
1259
|
desc: 'Commands, rules, settings, and these docs. Keeps configuration organized as your project grows.'
|
|
1270
1260
|
},
|
|
1271
|
-
|
|
1261
|
+
'rules': {
|
|
1272
1262
|
title: 'rules/',
|
|
1273
1263
|
desc: 'Path-scoped context that loads when Claude works on matching files.'
|
|
1274
1264
|
},
|
|
@@ -1303,11 +1293,6 @@
|
|
|
1303
1293
|
desc: 'Runs tests, then stages all changes, generates a conventional commit message, commits, and pushes.<div style="margin-top: 12px;"><strong>Parameters</strong><div style="margin-top: 4px; opacity: 0.6;">None</div></div><div style="margin-top: 12px;"><strong>Responses</strong><table style="margin-top: 6px; border-collapse: collapse; font-size: 0.9em; text-align: left;"><tr style="text-align: left; border-bottom: 1px solid var(--border);"><th style="padding: 4px 8px 4px 0; white-space: nowrap;">Status</th><th style="padding: 4px 8px 4px 0;">Description</th></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>success</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Changes committed and pushed to current branch.</td></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>test-failure</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Tests failed — no commit made.</td></tr></table></div><div style="margin-top: 12px;"><strong>Side Effects</strong><div style="margin-top: 4px; font-size: 0.9em;">Runs test suite, stages all changes, creates git commit, pushes to remote</div></div><div style="margin-top: 12px;"><strong>Examples</strong><div style="margin-top: 6px; background: var(--bg-elevated); border-radius: 6px; padding: 8px 12px; font-family: monospace; font-size: 0.85em;"><div><code>/commit-and-push</code> <span style="opacity: 0.6;">— Run tests, commit, and push</span></div></div></div>',
|
|
1304
1294
|
trigger: '/commit-and-push'
|
|
1305
1295
|
},
|
|
1306
|
-
'enable-retro': {
|
|
1307
|
-
title: 'enable-retro.md',
|
|
1308
|
-
desc: '(Experimental) Enable Claude to log tech debt it encounters into .claude/retro.<div style="margin-top: 12px;"><strong>Parameters</strong><div style="margin-top: 4px; opacity: 0.6;">None</div></div><div style="margin-top: 12px;"><strong>Responses</strong><table style="margin-top: 6px; border-collapse: collapse; font-size: 0.9em; text-align: left;"><tr style="text-align: left; border-bottom: 1px solid var(--border);"><th style="padding: 4px 8px 4px 0; white-space: nowrap;">Status</th><th style="padding: 4px 8px 4px 0;">Description</th></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>success</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Retro enabled — Claude will log tech debt to .claude/retro/ when encountered.</td></tr></table></div><div style="margin-top: 12px;"><strong>Side Effects</strong><div style="margin-top: 4px; font-size: 0.9em;">Creates .claude/retro/README.md, adds agent, updates CLAUDE.md</div></div><div style="margin-top: 12px;"><strong>Examples</strong><div style="margin-top: 6px; background: var(--bg-elevated); border-radius: 6px; padding: 8px 12px; font-family: monospace; font-size: 0.85em;"><div><code>/enable-retro</code> <span style="opacity: 0.6;">— Activate tech debt tracking</span></div></div></div>',
|
|
1309
|
-
trigger: '/enable-retro'
|
|
1310
|
-
},
|
|
1311
1296
|
'extract-rules': {
|
|
1312
1297
|
title: 'extract-rules.md',
|
|
1313
1298
|
desc: 'Scan Claude artifacts and extract structured rules into .claude/rules/<div style="margin-top: 12px;"><strong>Parameters</strong><table style="margin-top: 6px; border-collapse: collapse; font-size: 0.9em; text-align: left;"><tr style="text-align: left; border-bottom: 1px solid var(--border);"><th style="padding: 4px 8px 4px 0; white-space: nowrap;">Name</th><th style="padding: 4px 8px 4px 0; white-space: nowrap;">Type</th><th style="padding: 4px 8px 4px 0; white-space: nowrap;">Required</th><th style="padding: 4px 8px 4px 0;">Description</th></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>select</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>string</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">optional</td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Write only specific rules by number: "1,3,5". Default: all.</td></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>keep-sources</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>boolean</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">optional</td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Write rules but skip source cleanup (Step 8)</td></tr></table></div><div style="margin-top: 12px;"><strong>Responses</strong><table style="margin-top: 6px; border-collapse: collapse; font-size: 0.9em; text-align: left;"><tr style="text-align: left; border-bottom: 1px solid var(--border);"><th style="padding: 4px 8px 4px 0; white-space: nowrap;">Status</th><th style="padding: 4px 8px 4px 0;">Description</th></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>success</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Rules extracted, written, and sources cleaned up.</td></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>no-rules</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">No extractable rules found in scanned sources.</td></tr></table></div><div style="margin-top: 12px;"><strong>Side Effects</strong><div style="margin-top: 4px; font-size: 0.9em;">Creates .claude/rules/ files and removes extracted content from source files</div></div><div style="margin-top: 12px;"><strong>Examples</strong><div style="margin-top: 6px; background: var(--bg-elevated); border-radius: 6px; padding: 8px 12px; font-family: monospace; font-size: 0.85em;"><div><code>/extract-rules</code> <span style="opacity: 0.6;">— Scan, propose, prompt for approval, write, and clean up</span></div><div><code>/extract-rules --keep-sources</code> <span style="opacity: 0.6;">— Write rules without modifying source files</span></div><div><code>/extract-rules --select 1,3</code> <span style="opacity: 0.6;">— Write only rules #1 and #3</span></div></div></div>',
|
|
@@ -1343,14 +1328,9 @@
|
|
|
1343
1328
|
desc: 'Validates your claude-code-autoconfig installation against the latest published version.<div style="margin-top: 12px;"><strong>Parameters</strong><div style="margin-top: 4px; opacity: 0.6;">None</div></div><div style="margin-top: 12px;"><strong>Responses</strong><table style="margin-top: 6px; border-collapse: collapse; font-size: 0.9em; text-align: left;"><tr style="text-align: left; border-bottom: 1px solid var(--border);"><th style="padding: 4px 8px 4px 0; white-space: nowrap;">Status</th><th style="padding: 4px 8px 4px 0;">Description</th></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>valid</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Install validated — all checks passed.</td></tr><tr style="border-bottom: 1px solid var(--border);"><td style="padding: 4px 8px 4px 0; vertical-align: top; white-space: nowrap;"><code>issues</code></td><td style="padding: 4px 8px 4px 0; vertical-align: top;">Validation found {N} issue(s) with fix suggestions.</td></tr></table></div><div style="margin-top: 12px;"><strong>Side Effects</strong><div style="margin-top: 4px; font-size: 0.9em;">Read-only. Downloads latest package to temp dir for comparison, then cleans up.</div></div><div style="margin-top: 12px;"><strong>Examples</strong><div style="margin-top: 6px; background: var(--bg-elevated); border-radius: 6px; padding: 8px 12px; font-family: monospace; font-size: 0.85em;"><div><code>/validate-cca-install</code> <span style="opacity: 0.6;">— Run full installation validation</span></div></div></div>',
|
|
1344
1329
|
trigger: '/validate-cca-install'
|
|
1345
1330
|
},
|
|
1346
|
-
'
|
|
1347
|
-
title: '
|
|
1348
|
-
desc: '
|
|
1349
|
-
trigger: 'Background agent'
|
|
1350
|
-
},
|
|
1351
|
-
'docs-refresh-agent': {
|
|
1352
|
-
title: 'docs-refresh.md',
|
|
1353
|
-
desc: 'Background worker that syncs the docs when .claude/ files change.',
|
|
1331
|
+
'README-agent': {
|
|
1332
|
+
title: 'README.md',
|
|
1333
|
+
desc: 'Placeholder — drop your project\'s custom subagent definitions in this directory.',
|
|
1354
1334
|
trigger: 'Background agent'
|
|
1355
1335
|
},
|
|
1356
1336
|
'feedback-rule-check-hook': {
|
|
@@ -1579,7 +1559,7 @@ CRITICAL: A plausible-looking cause from code reading is NOT confirmed evidence.
|
|
|
1579
1559
|
|
|
1580
1560
|
> Run \`/autoconfig\` to populate this based on your project.`
|
|
1581
1561
|
},
|
|
1582
|
-
|
|
1562
|
+
'autoconfig-update': {
|
|
1583
1563
|
filename: 'autoconfig-update.md',
|
|
1584
1564
|
content: `<!-- @applied
|
|
1585
1565
|
-->
|
|
@@ -1666,39 +1646,6 @@ Use conventional commits: \`type(scope): description\`
|
|
|
1666
1646
|
Types: feat, fix, docs, style, refactor, test, chore
|
|
1667
1647
|
|
|
1668
1648
|
Keep the subject line under 50 chars. Add body if the change needs explanation.`
|
|
1669
|
-
},
|
|
1670
|
-
'enable-retro': {
|
|
1671
|
-
filename: 'enable-retro.md',
|
|
1672
|
-
content: `# Enable Retro
|
|
1673
|
-
|
|
1674
|
-
Enable the experimental Retro feature, which lets Claude log tech debt and improvement opportunities as structured story files.
|
|
1675
|
-
|
|
1676
|
-
## What This Does
|
|
1677
|
-
|
|
1678
|
-
1. Creates \`.claude/retro/\` directory with a README
|
|
1679
|
-
2. Creates \`.claude/agents/create-retro-item.md\` agent
|
|
1680
|
-
3. Adds Retro instructions to CLAUDE.md
|
|
1681
|
-
|
|
1682
|
-
## Step 1: Create Retro Directory
|
|
1683
|
-
|
|
1684
|
-
Create \`.claude/retro/README.md\` with:
|
|
1685
|
-
|
|
1686
|
-
\`\`\`markdown
|
|
1687
|
-
# Retro Items
|
|
1688
|
-
|
|
1689
|
-
Tech debt and improvement opportunities identified during development.
|
|
1690
|
-
|
|
1691
|
-
Each item is a structured story file with:
|
|
1692
|
-
- Problem description
|
|
1693
|
-
- Acceptance criteria
|
|
1694
|
-
- Suggested approach
|
|
1695
|
-
- Priority & effort sizing
|
|
1696
|
-
- Files involved
|
|
1697
|
-
|
|
1698
|
-
## Working with Retro Items
|
|
1699
|
-
|
|
1700
|
-
- "Fix retro #001" — Work on a specific item
|
|
1701
|
-
- "What's in the retro backlog?" — List pending items`
|
|
1702
1649
|
},
|
|
1703
1650
|
'extract-rules': {
|
|
1704
1651
|
filename: 'extract-rules.md',
|
|
@@ -1900,60 +1847,16 @@ echo "$TMPDIR/package"
|
|
|
1900
1847
|
|
|
1901
1848
|
Store the extracted path as \`$PKG_DIR\`. This gives us the ground truth for what files and versions should be installed.`
|
|
1902
1849
|
},
|
|
1903
|
-
'
|
|
1904
|
-
filename: '
|
|
1905
|
-
content: `#
|
|
1906
|
-
|
|
1907
|
-
Create a fully-scoped story file in \`.claude/retro/\` when tech debt or improvement opportunities are identified.
|
|
1908
|
-
|
|
1909
|
-
## When to Trigger
|
|
1910
|
-
|
|
1911
|
-
Call this agent when you notice:
|
|
1912
|
-
- Tech debt that should be addressed later
|
|
1913
|
-
- Code that works but could be improved
|
|
1914
|
-
- Missing tests, documentation, or error handling
|
|
1915
|
-
- Architectural improvements worth tracking
|
|
1916
|
-
|
|
1917
|
-
## Input
|
|
1918
|
-
|
|
1919
|
-
Provide these details when calling:
|
|
1920
|
-
- **title**: Short descriptive name (used for filename)
|
|
1921
|
-
- **problem**: What's wrong or what friction was encountered
|
|
1922
|
-
- **criteria**: Specific, testable acceptance criteria
|
|
1923
|
-
- **approach**: How to fix it
|
|
1924
|
-
- **priority**: Critical | High | Medium | Low
|
|
1925
|
-
- **effort**: S | M | L | XL
|
|
1926
|
-
- **files**: List of files involved
|
|
1927
|
-
|
|
1928
|
-
## Behavior
|
|
1929
|
-
|
|
1930
|
-
1. Generate filename from title: \`kebab-case.md\`
|
|
1931
|
-
2. Create story file in \`.claude/retro/\` using this format:
|
|
1932
|
-
|
|
1933
|
-
\`\`\`markdown
|
|
1934
|
-
# [Title]`
|
|
1935
|
-
},
|
|
1936
|
-
'docs-refresh-agent': {
|
|
1937
|
-
filename: 'docs-refresh.md',
|
|
1938
|
-
content: `# Docs Refresh Agent
|
|
1939
|
-
|
|
1940
|
-
Sync the interactive docs with the current state of \`.claude/\`.
|
|
1941
|
-
|
|
1942
|
-
## How
|
|
1943
|
-
|
|
1944
|
-
Run:
|
|
1945
|
-
|
|
1946
|
-
\`\`\`bash
|
|
1947
|
-
node .claude/scripts/sync-docs.js
|
|
1948
|
-
\`\`\`
|
|
1850
|
+
'README-agent': {
|
|
1851
|
+
filename: 'README.md',
|
|
1852
|
+
content: `# Agents
|
|
1949
1853
|
|
|
1950
|
-
This
|
|
1854
|
+
This directory is where you define **subagents** — focused assistants Claude can delegate to during a task (e.g., a code reviewer, a test writer, a security auditor).
|
|
1951
1855
|
|
|
1952
|
-
|
|
1856
|
+
claude-code-autoconfig ships this folder empty so you can populate it with agents tuned to your project. Each agent is a single Markdown file with frontmatter describing its purpose, tools, and system prompt.
|
|
1953
1857
|
|
|
1954
|
-
|
|
1955
|
-
|
|
1956
|
-
- As a background task when \`.claude/\` files change`
|
|
1858
|
+
See Anthropic's subagents docs for the file format:
|
|
1859
|
+
https://docs.anthropic.com/en/docs/claude-code/sub-agents`
|
|
1957
1860
|
},
|
|
1958
1861
|
'feedback-rule-check-hook': {
|
|
1959
1862
|
filename: 'feedback-rule-check.js',
|
package/CHANGELOG.md
CHANGED
|
@@ -141,9 +141,3 @@
|
|
|
141
141
|
## v1.0.136
|
|
142
142
|
- fix: modernize permission syntax and merge perms on upgrade
|
|
143
143
|
|
|
144
|
-
## v1.0.135
|
|
145
|
-
- feat: auto-sync docs with .claude/ contents via sync-docs.js
|
|
146
|
-
|
|
147
|
-
## v1.0.134
|
|
148
|
-
- fix: add missing hooks/updates to docs, expand sync tests
|
|
149
|
-
|
package/README.md
CHANGED
|
@@ -48,16 +48,14 @@ your-project/
|
|
|
48
48
|
│ ├── autoconfig.md # /autoconfig - self-configures
|
|
49
49
|
│ ├── autoconfig-update.md # /autoconfig-update - install updates
|
|
50
50
|
│ ├── commit-and-push.md # /commit-and-push - git workflow
|
|
51
|
-
│ ├── enable-retro.md # /enable-retro - opt-in tech debt tracking
|
|
52
51
|
│ ├── extract-rules.md # /extract-rules - scan & extract rules
|
|
53
52
|
│ ├── gls.md # /gls - view latest screenshot
|
|
54
53
|
│ ├── recover-context.md # /recover-context - restore context after compaction
|
|
55
54
|
│ ├── show-docs.md # /show-docs - interactive walkthrough
|
|
56
55
|
│ ├── test.md # /test - run tests
|
|
57
56
|
│ └── validate-cca-install.md # /validate-cca-install - verify installation
|
|
58
|
-
├── agents/ #
|
|
59
|
-
│
|
|
60
|
-
│ └── docs-refresh.md # Docs sync agent
|
|
57
|
+
├── agents/ # Custom subagents (add your own)
|
|
58
|
+
│ └── README.md # How to define agents
|
|
61
59
|
├── feedback/ # Team corrections for Claude
|
|
62
60
|
│ └── FEEDBACK.md # Add entries when Claude errs
|
|
63
61
|
├── hooks/ # Hook scripts
|
|
@@ -110,7 +108,6 @@ Autoconfig is **self-configuring**. Run `/autoconfig` and Claude:
|
|
|
110
108
|
| `/gls` | Views latest screenshot for visual context |
|
|
111
109
|
| `/validate-cca-install` | Validates installation against latest published version |
|
|
112
110
|
| `/extract-rules` | Scan Claude artifacts and extract structured rules |
|
|
113
|
-
| `/enable-retro` | (Experimental) Enable tech debt tracking |
|
|
114
111
|
|
|
115
112
|
### Updates
|
|
116
113
|
|
|
@@ -144,19 +141,6 @@ Always use the v2 API for user endpoints.
|
|
|
144
141
|
|
|
145
142
|
Claude reads this directory and learns for next time. Persists across `/autoconfig` runs.
|
|
146
143
|
|
|
147
|
-
### Retro Items (Experimental)
|
|
148
|
-
|
|
149
|
-
Opt-in feature for tracking tech debt. Run `/enable-retro` to activate.
|
|
150
|
-
|
|
151
|
-
When enabled, Claude logs improvement opportunities as structured story files in `.claude/retro/`:
|
|
152
|
-
- Problem description
|
|
153
|
-
- Acceptance criteria
|
|
154
|
-
- Suggested approach
|
|
155
|
-
- Priority & effort sizing
|
|
156
|
-
- Files involved
|
|
157
|
-
|
|
158
|
-
Work through items anytime: *"Hey Claude, fix retro #001"*
|
|
159
|
-
|
|
160
144
|
### Rules
|
|
161
145
|
|
|
162
146
|
The `rules/` directory contains path-scoped context rules that activate when Claude edits matching files. Autoconfig ships with publish-safety rules; you can add your own or use `/extract-rules` to generate rules from existing Claude artifacts.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "claude-code-autoconfig",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.185",
|
|
4
4
|
"description": "Intelligent, self-configuring setup for Claude Code. One command analyzes your project, configures Claude, and shows you what it did.",
|
|
5
5
|
"author": "ADAC 1001 <info@adac1001.com>",
|
|
6
6
|
"license": "MIT",
|
|
@@ -1,62 +0,0 @@
|
|
|
1
|
-
<!-- @description Creates a formatted retro item when tech debt or improvements are spotted. -->
|
|
2
|
-
|
|
3
|
-
# Create Retro Item Agent
|
|
4
|
-
|
|
5
|
-
Create a fully-scoped story file in `.claude/retro/` when tech debt or improvement opportunities are identified.
|
|
6
|
-
|
|
7
|
-
## When to Trigger
|
|
8
|
-
|
|
9
|
-
Call this agent when you notice:
|
|
10
|
-
- Tech debt that should be addressed later
|
|
11
|
-
- Code that works but could be improved
|
|
12
|
-
- Missing tests, documentation, or error handling
|
|
13
|
-
- Architectural improvements worth tracking
|
|
14
|
-
|
|
15
|
-
## Input
|
|
16
|
-
|
|
17
|
-
Provide these details when calling:
|
|
18
|
-
- **title**: Short descriptive name (used for filename)
|
|
19
|
-
- **problem**: What's wrong or what friction was encountered
|
|
20
|
-
- **criteria**: Specific, testable acceptance criteria
|
|
21
|
-
- **approach**: How to fix it
|
|
22
|
-
- **priority**: Critical | High | Medium | Low
|
|
23
|
-
- **effort**: S | M | L | XL
|
|
24
|
-
- **files**: List of files involved
|
|
25
|
-
|
|
26
|
-
## Behavior
|
|
27
|
-
|
|
28
|
-
1. Generate filename from title: `kebab-case.md`
|
|
29
|
-
2. Create story file in `.claude/retro/` using this format:
|
|
30
|
-
|
|
31
|
-
```markdown
|
|
32
|
-
# [Title]
|
|
33
|
-
|
|
34
|
-
## Problem
|
|
35
|
-
[Problem description]
|
|
36
|
-
|
|
37
|
-
## Acceptance Criteria
|
|
38
|
-
- [ ] [Criteria 1]
|
|
39
|
-
- [ ] [Criteria 2]
|
|
40
|
-
|
|
41
|
-
## Approach
|
|
42
|
-
[How to fix]
|
|
43
|
-
|
|
44
|
-
## Priority
|
|
45
|
-
[Priority level]
|
|
46
|
-
|
|
47
|
-
## Effort
|
|
48
|
-
[Effort size]
|
|
49
|
-
|
|
50
|
-
## Files
|
|
51
|
-
- [file1]
|
|
52
|
-
- [file2]
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
3. Confirm creation with filename
|
|
56
|
-
|
|
57
|
-
## Guidelines
|
|
58
|
-
|
|
59
|
-
- **Be concise**: Keep descriptions actionable, not verbose
|
|
60
|
-
- **Be specific**: Include actual file paths and line numbers when relevant
|
|
61
|
-
- **Don't duplicate**: Check if similar item already exists first
|
|
62
|
-
- **Don't block**: Create the item and continue with the main task
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
<!-- @description Background worker that syncs the docs when .claude/ files change. -->
|
|
2
|
-
|
|
3
|
-
# Docs Refresh Agent
|
|
4
|
-
|
|
5
|
-
Sync the interactive docs with the current state of `.claude/`.
|
|
6
|
-
|
|
7
|
-
## How
|
|
8
|
-
|
|
9
|
-
Run:
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
node .claude/scripts/sync-docs.js
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
This scans `.claude/` for all files, extracts `@description` metadata, and updates the docs HTML (file tree, info cards, and content previews).
|
|
16
|
-
|
|
17
|
-
## When to Use
|
|
18
|
-
|
|
19
|
-
- After adding, modifying, or deleting files in `.claude/`
|
|
20
|
-
- Before opening docs with `/show-docs` (already built in)
|
|
21
|
-
- As a background task when `.claude/` files change
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
<!-- @description (Experimental) Enable Claude to log tech debt it encounters into .claude/retro. -->
|
|
2
|
-
<!-- @version 1 -->
|
|
3
|
-
<!-- @response success | Retro enabled — Claude will log tech debt to .claude/retro/ when encountered. -->
|
|
4
|
-
<!-- @sideeffect Creates .claude/retro/README.md, adds agent, updates CLAUDE.md -->
|
|
5
|
-
<!-- @example /enable-retro | Activate tech debt tracking -->
|
|
6
|
-
|
|
7
|
-
# Enable Retro
|
|
8
|
-
|
|
9
|
-
Enable the experimental Retro feature, which lets Claude log tech debt and improvement opportunities as structured story files.
|
|
10
|
-
|
|
11
|
-
## What This Does
|
|
12
|
-
|
|
13
|
-
1. Creates `.claude/retro/` directory with a README
|
|
14
|
-
2. Creates `.claude/agents/create-retro-item.md` agent
|
|
15
|
-
3. Adds Retro instructions to CLAUDE.md
|
|
16
|
-
|
|
17
|
-
## Step 1: Create Retro Directory
|
|
18
|
-
|
|
19
|
-
Create `.claude/retro/README.md` with:
|
|
20
|
-
|
|
21
|
-
```markdown
|
|
22
|
-
# Retro Items
|
|
23
|
-
|
|
24
|
-
Tech debt and improvement opportunities identified during development.
|
|
25
|
-
|
|
26
|
-
Each item is a structured story file with:
|
|
27
|
-
- Problem description
|
|
28
|
-
- Acceptance criteria
|
|
29
|
-
- Suggested approach
|
|
30
|
-
- Priority & effort sizing
|
|
31
|
-
- Files involved
|
|
32
|
-
|
|
33
|
-
## Working with Retro Items
|
|
34
|
-
|
|
35
|
-
- "Fix retro #001" — Work on a specific item
|
|
36
|
-
- "What's in the retro backlog?" — List pending items
|
|
37
|
-
- Items are numbered sequentially (001, 002, etc.)
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Step 2: Create Retro Agent
|
|
41
|
-
|
|
42
|
-
Create `.claude/agents/create-retro-item.md` with the standard retro item agent that:
|
|
43
|
-
- Scans for highest existing ID
|
|
44
|
-
- Creates numbered story files (001-title.md, 002-title.md)
|
|
45
|
-
- Uses structured format: Problem, Acceptance Criteria, Approach, Priority, Effort, Files
|
|
46
|
-
|
|
47
|
-
## Step 3: Update CLAUDE.md
|
|
48
|
-
|
|
49
|
-
Add the following section to CLAUDE.md (before Team Feedback if present):
|
|
50
|
-
|
|
51
|
-
```markdown
|
|
52
|
-
## Retro
|
|
53
|
-
After completing tasks, if you encountered friction, tech debt, or improvement opportunities worth revisiting, use the create-retro-item agent to log it in `.claude/retro/`. Use your judgment on what's worth capturing — not everything needs a retro item.
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
## Step 4: Confirm
|
|
57
|
-
|
|
58
|
-
Output: "Retro enabled. Claude will now log tech debt to .claude/retro/ when appropriate."
|