codeforge-dev 1.7.0 → 1.9.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/.devcontainer/.env +4 -6
- package/.devcontainer/.env.example +29 -0
- package/.devcontainer/.gitignore +8 -0
- package/.devcontainer/.secrets.example +12 -0
- package/.devcontainer/CHANGELOG.md +181 -0
- package/.devcontainer/CLAUDE.md +57 -20
- package/.devcontainer/README.md +111 -56
- package/.devcontainer/config/{main-system-prompt.md → defaults/main-system-prompt.md} +72 -0
- package/.devcontainer/config/defaults/rules/spec-workflow.md +67 -0
- package/.devcontainer/config/defaults/rules/workspace-scope.md +7 -0
- package/.devcontainer/config/defaults/settings.json +67 -0
- package/.devcontainer/config/file-manifest.json +32 -0
- package/.devcontainer/devcontainer.json +20 -0
- package/.devcontainer/docs/configuration-reference.md +90 -0
- package/.devcontainer/docs/keybindings.md +100 -0
- package/.devcontainer/docs/optional-features.md +129 -0
- package/.devcontainer/docs/plugins.md +154 -0
- package/.devcontainer/docs/troubleshooting.md +128 -0
- package/.devcontainer/features/agent-browser/install.sh +6 -0
- package/.devcontainer/features/ast-grep/install.sh +6 -0
- package/.devcontainer/features/biome/README.md +27 -0
- package/.devcontainer/features/biome/install.sh +6 -0
- package/.devcontainer/features/ccburn/install.sh +6 -0
- package/.devcontainer/features/ccstatusline/devcontainer-feature.json +5 -0
- package/.devcontainer/features/ccstatusline/install.sh +7 -0
- package/.devcontainer/features/ccusage/install.sh +6 -0
- package/.devcontainer/features/claude-monitor/install.sh +6 -0
- package/.devcontainer/features/dprint/README.md +30 -0
- package/.devcontainer/features/dprint/devcontainer-feature.json +18 -0
- package/.devcontainer/features/dprint/install.sh +131 -0
- package/.devcontainer/features/hadolint/README.md +35 -0
- package/.devcontainer/features/hadolint/devcontainer-feature.json +13 -0
- package/.devcontainer/features/hadolint/install.sh +86 -0
- package/.devcontainer/features/lsp-servers/devcontainer-feature.json +5 -0
- package/.devcontainer/features/lsp-servers/install.sh +7 -0
- package/.devcontainer/features/mcp-qdrant/devcontainer-feature.json +5 -0
- package/.devcontainer/features/mcp-qdrant/install.sh +13 -6
- package/.devcontainer/features/mcp-reasoner/devcontainer-feature.json +5 -0
- package/.devcontainer/features/mcp-reasoner/install.sh +8 -1
- package/.devcontainer/features/notify-hook/devcontainer-feature.json +5 -0
- package/.devcontainer/features/notify-hook/install.sh +7 -0
- package/.devcontainer/features/ruff/README.md +26 -0
- package/.devcontainer/features/ruff/devcontainer-feature.json +21 -0
- package/.devcontainer/features/ruff/install.sh +74 -0
- package/.devcontainer/features/shellcheck/README.md +38 -0
- package/.devcontainer/features/shellcheck/devcontainer-feature.json +13 -0
- package/.devcontainer/features/shellcheck/install.sh +24 -0
- package/.devcontainer/features/shfmt/README.md +37 -0
- package/.devcontainer/features/shfmt/devcontainer-feature.json +13 -0
- package/.devcontainer/features/shfmt/install.sh +85 -0
- package/.devcontainer/features/splitrail/devcontainer-feature.json +5 -0
- package/.devcontainer/features/splitrail/install.sh +7 -0
- package/.devcontainer/features/tmux/install.sh +8 -0
- package/.devcontainer/features/tree-sitter/install.sh +6 -0
- package/.devcontainer/plugins/devs-marketplace/.claude-plugin/marketplace.json +104 -104
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-code-quality/.claude-plugin/plugin.json +7 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-code-quality/README.md +158 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-code-quality/hooks/hooks.json +39 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-code-quality/scripts/collect-edited-files.py +47 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-code-quality/scripts/format-on-stop.py +297 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-code-quality/scripts/lint-file.py +536 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-code-quality/scripts/syntax-validator.py +146 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-formatter/.claude-plugin/plugin.json +1 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-formatter/scripts/__pycache__/format-on-stop.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-formatter/scripts/format-on-stop.py +114 -9
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-linter/.claude-plugin/plugin.json +1 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-linter/hooks/hooks.json +4 -5
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-linter/scripts/__pycache__/lint-file.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/auto-linter/scripts/lint-file.py +478 -76
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/.claude-plugin/plugin.json +1 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/AGENT-REDIRECTION.md +226 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/architect.md +94 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/bash-exec.md +4 -4
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/claude-guide.md +14 -23
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/debug-logs.md +20 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/dependency-analyst.md +20 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/doc-writer.md +99 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/explorer.md +20 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/generalist.md +152 -9
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/git-archaeologist.md +18 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/migrator.md +114 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/perf-profiler.md +24 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/refactorer.md +101 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/researcher.md +33 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/security-auditor.md +24 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/spec-writer.md +65 -24
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/statusline-config.md +3 -3
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/test-writer.md +99 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/hooks/hooks.json +100 -56
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/__pycache__/advisory-test-runner.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/__pycache__/collect-edited-files.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/__pycache__/commit-reminder.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/__pycache__/git-state-injector.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/__pycache__/redirect-builtin-agents.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/__pycache__/ticket-linker.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/__pycache__/todo-harvester.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/advisory-test-runner.py +174 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/collect-edited-files.py +8 -6
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/commit-reminder.py +90 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/git-state-injector.py +114 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/skill-suggester.py +61 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/spec-reminder.py +121 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/ticket-linker.py +137 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/scripts/todo-harvester.py +130 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/api-design/SKILL.md +224 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/api-design/references/error-handling.md +166 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/api-design/references/rest-conventions.md +215 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/ast-grep-patterns/SKILL.md +211 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/ast-grep-patterns/references/language-patterns.md +327 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/dependency-management/SKILL.md +134 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/dependency-management/references/ecosystem-commands.md +264 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/dependency-management/references/license-compliance.md +80 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/documentation-patterns/SKILL.md +153 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/documentation-patterns/references/api-doc-templates.md +221 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/documentation-patterns/references/docstring-formats.md +296 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/migration-patterns/SKILL.md +150 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/migration-patterns/references/javascript-migrations.md +179 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/migration-patterns/references/python-migrations.md +141 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/spec-check/SKILL.md +86 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/spec-init/SKILL.md +97 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/spec-init/references/backlog-template.md +7 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/spec-init/references/roadmap-template.md +13 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/spec-new/SKILL.md +101 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/spec-new/references/template.md +110 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/spec-update/SKILL.md +124 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/skills/specification-writing/SKILL.md +32 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/dangerous-command-blocker/scripts/__pycache__/block-dangerous.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/notify-hook/hooks/hooks.json +1 -1
- package/.devcontainer/plugins/devs-marketplace/plugins/protected-files-guard/scripts/__pycache__/guard-protected.cpython-314.pyc +0 -0
- package/.devcontainer/scripts/check-setup.sh +72 -0
- package/.devcontainer/scripts/setup-aliases.sh +43 -3
- package/.devcontainer/scripts/setup-auth.sh +74 -0
- package/.devcontainer/scripts/setup-config.sh +117 -24
- package/.devcontainer/scripts/setup-update-claude.sh +8 -0
- package/.devcontainer/scripts/setup.sh +46 -13
- package/README.md +23 -190
- package/package.json +42 -42
- package/setup.js +245 -71
- package/.devcontainer/config/settings.json +0 -70
- package/.devcontainer/features/claude-code/README.md +0 -498
- package/.devcontainer/features/claude-code/config/settings.json +0 -72
- package/.devcontainer/features/claude-code/config/system-prompt.md +0 -118
- package/.devcontainer/features/claude-code/config/world-building-sp.md +0 -1432
- package/.devcontainer/features/claude-code/devcontainer-feature.json +0 -42
- package/.devcontainer/features/claude-code/install.sh +0 -466
- package/.devcontainer/plugins/devs-marketplace/plugins/planning-reminder/.claude-plugin/plugin.json +0 -7
- package/.devcontainer/plugins/devs-marketplace/plugins/planning-reminder/hooks/hooks.json +0 -17
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/.claude-plugin/plugin.json +0 -6
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/config/planning-instructions.md +0 -14
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/functional-conjuring-map.md +0 -989
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/hooks/hooks.json +0 -33
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/scripts/__pycache__/post-enhance-task.cpython-314.pyc +0 -0
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/scripts/enhance-planning.py +0 -71
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/scripts/enhancers/enhance-plan.sh +0 -68
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/scripts/enhancers/enhance-task.sh +0 -120
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/scripts/post-enhance-plan.py +0 -133
- package/.devcontainer/plugins/devs-marketplace/plugins/workflow-enhancer/scripts/post-enhance-task.py +0 -253
- /package/.devcontainer/config/{keybindings.json → defaults/keybindings.json} +0 -0
|
@@ -0,0 +1,226 @@
|
|
|
1
|
+
# Agent Redirection Guide
|
|
2
|
+
|
|
3
|
+
How Claude Code's hook system lets you replace, reroute, or transform any tool call — including swapping built-in subagents for custom ones.
|
|
4
|
+
|
|
5
|
+
## How It Works
|
|
6
|
+
|
|
7
|
+
Claude Code plugins can register **PreToolUse hooks** that intercept tool calls before they execute. The hook receives the full tool input as JSON on stdin and can return modified input on stdout. This is the mechanism behind agent redirection: when Claude spawns a subagent via the `Task` tool, a hook intercepts the call and rewrites `subagent_type` to point at a custom agent definition.
|
|
8
|
+
|
|
9
|
+
### The Hook Contract
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
stdin → { "tool_name": "Task", "tool_input": { "subagent_type": "Explore", "prompt": "...", ... } }
|
|
13
|
+
stdout ← { "hookSpecificOutput": { "hookEventName": "PreToolUse", "permissionDecision": "allow", "updatedInput": { ...modified tool_input... } } }
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
The hook script receives the tool call context on stdin, and can return:
|
|
17
|
+
|
|
18
|
+
| Field | Effect |
|
|
19
|
+
|-------|--------|
|
|
20
|
+
| `permissionDecision: "allow"` | Let the call proceed (with optional modifications) |
|
|
21
|
+
| `permissionDecision: "deny"` | Block the call entirely (with a reason) |
|
|
22
|
+
| `updatedInput: {...}` | Replace the tool input — Claude Code uses the new values instead of the originals |
|
|
23
|
+
|
|
24
|
+
**Critical detail**: `updatedInput` **replaces** the original input (it does not merge). Always spread the original fields and override only what you need:
|
|
25
|
+
|
|
26
|
+
```python
|
|
27
|
+
updated = {**tool_input, "subagent_type": "my-custom-agent"}
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### Hook Registration
|
|
31
|
+
|
|
32
|
+
In your plugin's `hooks/hooks.json`:
|
|
33
|
+
|
|
34
|
+
```json
|
|
35
|
+
{
|
|
36
|
+
"hooks": {
|
|
37
|
+
"PreToolUse": [
|
|
38
|
+
{
|
|
39
|
+
"matcher": "Task",
|
|
40
|
+
"hooks": [{
|
|
41
|
+
"type": "command",
|
|
42
|
+
"command": "python3 ${CLAUDE_PLUGIN_ROOT}/scripts/my-hook.py",
|
|
43
|
+
"timeout": 5
|
|
44
|
+
}]
|
|
45
|
+
}
|
|
46
|
+
]
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
The `matcher` field controls which tool triggers the hook. Use `"Task"` to intercept subagent spawning, `"Bash"` for command execution, `"Edit|Write"` for file modifications, etc.
|
|
52
|
+
|
|
53
|
+
## What We Do: Built-in → Custom Agent Swap
|
|
54
|
+
|
|
55
|
+
The `redirect-builtin-agents.py` hook maps Claude Code's built-in agent types to our custom agents:
|
|
56
|
+
|
|
57
|
+
```python
|
|
58
|
+
REDIRECT_MAP = {
|
|
59
|
+
"Explore": "explorer", # Fast codebase search
|
|
60
|
+
"Plan": "architect", # Implementation planning
|
|
61
|
+
"general-purpose": "generalist", # Multi-step tasks
|
|
62
|
+
"Bash": "bash-exec", # Command execution
|
|
63
|
+
"claude-code-guide": "claude-guide",
|
|
64
|
+
"statusline-setup": "statusline-config",
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
When Claude decides to spawn an `Explore` agent, the hook rewrites it to `code-directive:explorer` — a custom agent with tailored instructions, tool restrictions, and model selection. The original prompt passes through unchanged.
|
|
69
|
+
|
|
70
|
+
### Custom Agent Definitions
|
|
71
|
+
|
|
72
|
+
Agents are Markdown files with YAML frontmatter in the `agents/` directory:
|
|
73
|
+
|
|
74
|
+
```yaml
|
|
75
|
+
---
|
|
76
|
+
name: explorer
|
|
77
|
+
description: >-
|
|
78
|
+
Fast codebase search. Use when you need to find files,
|
|
79
|
+
search code, or answer structural questions.
|
|
80
|
+
tools: Read, Glob, Grep, Bash # Restrict available tools
|
|
81
|
+
model: sonnet # Or: opus, haiku, inherit
|
|
82
|
+
color: cyan
|
|
83
|
+
memory:
|
|
84
|
+
scope: project # Or: user, global
|
|
85
|
+
skills:
|
|
86
|
+
- debugging # Inject skill knowledge
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
# Explorer Agent
|
|
90
|
+
|
|
91
|
+
You are a codebase navigation specialist...
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Key frontmatter fields:
|
|
95
|
+
|
|
96
|
+
| Field | What it controls |
|
|
97
|
+
|-------|-----------------|
|
|
98
|
+
| `tools` | Which tools the agent can use (`"*"` for all, or comma-separated list) |
|
|
99
|
+
| `model` | Which model runs the agent (`sonnet`, `opus`, `haiku`, `inherit`) |
|
|
100
|
+
| `skills` | Skills injected into the agent's context |
|
|
101
|
+
| `memory.scope` | Memory persistence level |
|
|
102
|
+
|
|
103
|
+
The Markdown body below the frontmatter becomes the agent's system prompt.
|
|
104
|
+
|
|
105
|
+
## What Else You Can Do
|
|
106
|
+
|
|
107
|
+
The same hook mechanism supports far more than agent swapping. Here are patterns that work today:
|
|
108
|
+
|
|
109
|
+
### Modify the Prompt
|
|
110
|
+
|
|
111
|
+
Inject additional context, constraints, or instructions into any subagent's prompt:
|
|
112
|
+
|
|
113
|
+
```python
|
|
114
|
+
updated = {
|
|
115
|
+
**tool_input,
|
|
116
|
+
"prompt": tool_input["prompt"] + "\n\nALWAYS check for security issues.",
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### Change the Model
|
|
121
|
+
|
|
122
|
+
Force a specific model for certain agent types or tasks:
|
|
123
|
+
|
|
124
|
+
```python
|
|
125
|
+
if "security" in tool_input.get("prompt", "").lower():
|
|
126
|
+
updated = {**tool_input, "model": "opus"} # Use strongest model for security tasks
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Conditional Routing
|
|
130
|
+
|
|
131
|
+
Route to different agents based on prompt content, file patterns, or environment:
|
|
132
|
+
|
|
133
|
+
```python
|
|
134
|
+
prompt = tool_input.get("prompt", "")
|
|
135
|
+
if "test" in prompt.lower():
|
|
136
|
+
target = "test-writer"
|
|
137
|
+
elif "refactor" in prompt.lower():
|
|
138
|
+
target = "refactorer"
|
|
139
|
+
else:
|
|
140
|
+
target = "generalist"
|
|
141
|
+
updated = {**tool_input, "subagent_type": f"code-directive:{target}"}
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
### Block Certain Operations
|
|
145
|
+
|
|
146
|
+
Deny tool calls that match dangerous patterns:
|
|
147
|
+
|
|
148
|
+
```python
|
|
149
|
+
# This is exactly how dangerous-command-blocker works for Bash
|
|
150
|
+
response = {
|
|
151
|
+
"hookSpecificOutput": {
|
|
152
|
+
"hookEventName": "PreToolUse",
|
|
153
|
+
"permissionDecision": "deny",
|
|
154
|
+
"permissionDecisionReason": "This operation is not allowed.",
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
### Intercept Any Tool (Not Just Task)
|
|
160
|
+
|
|
161
|
+
Hooks aren't limited to subagent spawning. You can intercept `Bash`, `Edit`, `Write`, `WebFetch` — any tool:
|
|
162
|
+
|
|
163
|
+
```json
|
|
164
|
+
{ "matcher": "Bash", "hooks": [{ "type": "command", "command": "python3 my-script.py" }] }
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
The `dangerous-command-blocker` plugin uses this to inspect Bash commands before execution. The `protected-files-guard` does the same for Edit/Write to block modifications to sensitive files.
|
|
168
|
+
|
|
169
|
+
### Chain with External Services
|
|
170
|
+
|
|
171
|
+
Since hooks are just scripts that read stdin and write stdout, you can call anything:
|
|
172
|
+
|
|
173
|
+
```python
|
|
174
|
+
# Forward the prompt to an external API for analysis
|
|
175
|
+
import requests
|
|
176
|
+
result = requests.post("https://my-api.example.com/analyze", json=tool_input)
|
|
177
|
+
# Use the response to modify the tool call
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
This opens up patterns like:
|
|
181
|
+
- **External LLM routing** — send the prompt to a classifier that picks the best model/agent
|
|
182
|
+
- **Audit logging** — POST every tool call to an external logging service
|
|
183
|
+
- **Cost control** — check a budget API before allowing expensive operations
|
|
184
|
+
- **RAG injection** — query a vector DB and inject relevant context into the prompt
|
|
185
|
+
|
|
186
|
+
### PostToolUse: React After Execution
|
|
187
|
+
|
|
188
|
+
`PostToolUse` hooks run after a tool completes and can inject context back to Claude:
|
|
189
|
+
|
|
190
|
+
```python
|
|
191
|
+
# Return diagnostic information that Claude will see
|
|
192
|
+
print(json.dumps({"additionalContext": "Lint warning: unused import on line 12"}))
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
This is how the auto-linter and syntax validator work — they inspect the result of Edit/Write operations and feed findings back into the conversation.
|
|
196
|
+
|
|
197
|
+
## File Layout
|
|
198
|
+
|
|
199
|
+
```
|
|
200
|
+
code-directive/
|
|
201
|
+
├── agents/ # Agent definitions (17 .md files)
|
|
202
|
+
│ ├── explorer.md
|
|
203
|
+
│ ├── architect.md
|
|
204
|
+
│ ├── generalist.md
|
|
205
|
+
│ └── ...
|
|
206
|
+
├── hooks/
|
|
207
|
+
│ └── hooks.json # Hook registrations
|
|
208
|
+
├── scripts/
|
|
209
|
+
│ ├── redirect-builtin-agents.py # The redirection hook
|
|
210
|
+
│ ├── collect-edited-files.py # Collects paths for Stop hooks
|
|
211
|
+
│ ├── syntax-validator.py # PostToolUse syntax checks
|
|
212
|
+
│ └── skill-suggester.py # Suggests skills on prompt
|
|
213
|
+
└── skills/ # Skill definitions (16 directories)
|
|
214
|
+
├── fastapi/
|
|
215
|
+
├── svelte5/
|
|
216
|
+
└── ...
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
## Writing Your Own
|
|
220
|
+
|
|
221
|
+
1. **Create the agent** — add a `.md` file to `agents/` with YAML frontmatter
|
|
222
|
+
2. **Add the redirect** — add an entry to `REDIRECT_MAP` in `redirect-builtin-agents.py`, or write a new hook script
|
|
223
|
+
3. **Register the hook** — add it to `hooks/hooks.json` under the appropriate event type
|
|
224
|
+
4. **Test** — spawn the agent via Claude and check `/tmp/agent-redirect.log` for redirect entries
|
|
225
|
+
|
|
226
|
+
The hook always exits 0. If it crashes or times out, Claude Code falls back to the original tool call — so a broken hook never blocks work.
|
|
@@ -13,6 +13,11 @@ model: opus
|
|
|
13
13
|
color: magenta
|
|
14
14
|
memory:
|
|
15
15
|
scope: project
|
|
16
|
+
skills:
|
|
17
|
+
- api-design
|
|
18
|
+
- spec-new
|
|
19
|
+
- spec-update
|
|
20
|
+
- spec-init
|
|
16
21
|
hooks:
|
|
17
22
|
PreToolUse:
|
|
18
23
|
- matcher: Bash
|
|
@@ -25,6 +30,79 @@ hooks:
|
|
|
25
30
|
|
|
26
31
|
You are a **senior software architect** specializing in implementation planning, trade-off analysis, and technical decision-making. You explore codebases to understand existing patterns, design implementation strategies that follow established conventions, and produce clear, actionable plans. You are methodical, risk-aware, and pragmatic — you favor working solutions over theoretical elegance, and you identify problems before they become expensive.
|
|
27
32
|
|
|
33
|
+
## Project Context Discovery
|
|
34
|
+
|
|
35
|
+
Before starting any task, check for project-specific instructions that override or extend your defaults. These are invisible to you unless you read them.
|
|
36
|
+
|
|
37
|
+
### Step 1: Read Claude Rules
|
|
38
|
+
|
|
39
|
+
Check for rule files that apply to the entire workspace:
|
|
40
|
+
|
|
41
|
+
```
|
|
42
|
+
Glob: .claude/rules/*.md
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Read every file found. These contain mandatory project rules (workspace scoping, spec workflow, etc.). Follow them as hard constraints.
|
|
46
|
+
|
|
47
|
+
### Step 2: Read CLAUDE.md Files
|
|
48
|
+
|
|
49
|
+
CLAUDE.md files contain project-specific conventions, tech stack details, and architectural decisions. They exist at multiple directory levels — more specific files take precedence.
|
|
50
|
+
|
|
51
|
+
Starting from the directory you are working in, read CLAUDE.md files walking up to the workspace root:
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
# Example: working in /workspaces/myproject/src/engine/api/
|
|
55
|
+
Read: /workspaces/myproject/src/engine/api/CLAUDE.md (if exists)
|
|
56
|
+
Read: /workspaces/myproject/src/engine/CLAUDE.md (if exists)
|
|
57
|
+
Read: /workspaces/myproject/CLAUDE.md (if exists)
|
|
58
|
+
Read: /workspaces/CLAUDE.md (if exists — workspace root)
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Use Glob to discover them efficiently:
|
|
62
|
+
```
|
|
63
|
+
Glob: **/CLAUDE.md (within the project directory)
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Step 3: Apply What You Found
|
|
67
|
+
|
|
68
|
+
- **Conventions** (naming, nesting limits, framework choices): follow them in all work
|
|
69
|
+
- **Tech stack** (languages, frameworks, libraries): use them, don't introduce alternatives
|
|
70
|
+
- **Architecture decisions** (where logic lives, data flow patterns): respect boundaries
|
|
71
|
+
- **Workflow rules** (spec management, testing requirements): comply
|
|
72
|
+
|
|
73
|
+
If a CLAUDE.md instruction conflicts with your built-in instructions, the CLAUDE.md takes precedence — it represents the project owner's intent.
|
|
74
|
+
|
|
75
|
+
## Execution Discipline
|
|
76
|
+
|
|
77
|
+
- Do not assume file paths or project structure — read the filesystem to confirm.
|
|
78
|
+
- Never fabricate paths, API signatures, or facts. If uncertain, say so.
|
|
79
|
+
- If the task says "do X", investigate X — not a variation or shortcut.
|
|
80
|
+
- If you cannot answer what was asked, explain why rather than silently shifting scope.
|
|
81
|
+
- When a search approach yields nothing, try alternatives before reporting "not found."
|
|
82
|
+
|
|
83
|
+
## Code Standards Reference
|
|
84
|
+
|
|
85
|
+
When evaluating code or planning changes, apply these standards:
|
|
86
|
+
- **SOLID** principles (Single Responsibility, Open/Closed, Liskov, Interface Segregation, Dependency Inversion)
|
|
87
|
+
- **DRY, KISS, YAGNI** — no duplication, keep it simple, don't build what's not needed
|
|
88
|
+
- Functions: single purpose, <20 lines, max 3-4 params
|
|
89
|
+
- Never swallow exceptions. Actionable error messages.
|
|
90
|
+
- Validate inputs at system boundaries only. Parameterized queries.
|
|
91
|
+
- No god classes, magic numbers, dead code, copy-paste duplication, or hard-coded config.
|
|
92
|
+
|
|
93
|
+
## Professional Objectivity
|
|
94
|
+
|
|
95
|
+
Prioritize technical accuracy over agreement. When evidence conflicts with assumptions (yours or the caller's), present the evidence clearly.
|
|
96
|
+
|
|
97
|
+
When uncertain, investigate first — read the code, check the docs — rather than confirming a belief by default. Use direct, measured language. Avoid superlatives or unqualified claims.
|
|
98
|
+
|
|
99
|
+
## Communication Standards
|
|
100
|
+
|
|
101
|
+
- Open every response with substance — your finding, action, or answer. No preamble.
|
|
102
|
+
- Do not restate the problem or narrate intentions ("Let me...", "I'll now...").
|
|
103
|
+
- Mark uncertainty explicitly. Distinguish confirmed facts from inference.
|
|
104
|
+
- Reference code locations as `file_path:line_number`.
|
|
105
|
+
|
|
28
106
|
## Critical Constraints
|
|
29
107
|
|
|
30
108
|
- **NEVER** create, modify, write, or delete any file — you are strictly read-only. Your output is a plan, not an implementation.
|
|
@@ -60,7 +138,7 @@ Before moving to Phase 2, explicitly list:
|
|
|
60
138
|
Investigate the relevant parts of the project:
|
|
61
139
|
|
|
62
140
|
1. **Entry points** — Find where the feature/change would be initiated (routes, CLI handlers, event listeners).
|
|
63
|
-
2. **Existing patterns** — Search for similar features already implemented. The best plan follows established conventions.
|
|
141
|
+
2. **Existing patterns** — Search for similar features already implemented. Read CLAUDE.md files (per Project Context Discovery) — these document established conventions, tech stack decisions, and architectural boundaries that your plan must respect. The best plan follows established conventions.
|
|
64
142
|
3. **Dependencies** — Identify what libraries, services, and APIs are involved.
|
|
65
143
|
4. **Data model** — Read schema files, models, and type definitions to understand the data structures.
|
|
66
144
|
5. **Tests** — Check existing test patterns and coverage for the area being changed.
|
|
@@ -89,6 +167,16 @@ Based on your exploration:
|
|
|
89
167
|
6. **Flag performance-sensitive paths** — Even for non-performance requests, surface changes that touch hot paths, introduce N+1 queries, add blocking I/O, or change algorithmic complexity. Note measurement strategy if relevant.
|
|
90
168
|
7. **Assess risks** — What could go wrong? What are the edge cases? What dependencies could break?
|
|
91
169
|
8. **Define verification** — How will we know each step worked?
|
|
170
|
+
9. **Specify documentation outputs** — Identify which docs this work should produce
|
|
171
|
+
or update. Distinguish:
|
|
172
|
+
- **Roadmap entry**: one-line description of what the version delivers (no
|
|
173
|
+
implementation detail — that belongs in specs)
|
|
174
|
+
- **Feature spec**: ≤200 line file following the standard template (Version,
|
|
175
|
+
Status, Intent, Acceptance Criteria, Key Files, Schema, API, Dependencies)
|
|
176
|
+
- **As-built update**: if modifying an existing feature, identify which spec
|
|
177
|
+
to update post-implementation
|
|
178
|
+
Plans that mix roadmap-level and spec-level detail produce artifacts too
|
|
179
|
+
detailed for strategy and too shallow for implementation.
|
|
92
180
|
|
|
93
181
|
### Phase 4: Structure the Plan
|
|
94
182
|
|
|
@@ -150,6 +238,11 @@ List the 3-7 files most critical for implementing this plan:
|
|
|
150
238
|
- `/path/to/models.py` — Brief reason (e.g., "Data model to extend")
|
|
151
239
|
- `/path/to/test_file.py` — Brief reason (e.g., "Test patterns to follow")
|
|
152
240
|
|
|
241
|
+
### Documentation Outputs
|
|
242
|
+
- New spec: `.specs/vX.Y.0/feature-name.md` (≤200 lines)
|
|
243
|
+
- Updated spec: `.specs/vX.Y.0/existing-feature.md` — changes: [list]
|
|
244
|
+
- Roadmap update: `.specs/roadmap.md` — add `[ ] feature` to vX.Y.0
|
|
245
|
+
|
|
153
246
|
### Risks & Mitigations
|
|
154
247
|
|
|
155
248
|
| Risk | Likelihood | Impact | Mitigation |
|
|
@@ -29,10 +29,10 @@ You are a **command execution specialist** for terminal operations. You run bash
|
|
|
29
29
|
- **NEVER** amend commits unless the caller explicitly says "amend." Always create new commits by default — amending the previous commit risks destroying work, especially after a pre-commit hook failure.
|
|
30
30
|
- **NEVER** update git config (`git config user.name`, `git config user.email`, etc.).
|
|
31
31
|
- **NEVER** run commands that could expose secrets or credentials to stdout without redaction.
|
|
32
|
-
- **NEVER** run `rm -rf /` or any command that deletes system directories. Block recursive deletion outside of
|
|
32
|
+
- **NEVER** run `rm -rf /` or any command that deletes system directories. Block recursive deletion outside of the workspace root.
|
|
33
33
|
- **NEVER** run commands that risk runaway execution: `while true` loops without exit conditions, fork bombs (`: | : &`), commands that generate unbounded output (`yes`, `cat /dev/urandom`), or commands likely to fill disk (`dd if=/dev/zero`).
|
|
34
34
|
- Always **quote file paths** that contain spaces with double quotes.
|
|
35
|
-
- Prefer **absolute paths** within
|
|
35
|
+
- Prefer **absolute paths** within the workspace root to avoid working directory confusion.
|
|
36
36
|
|
|
37
37
|
## Git Safety Protocols
|
|
38
38
|
|
|
@@ -117,7 +117,7 @@ When a command is complex (piped chains, obscure flags) or potentially destructi
|
|
|
117
117
|
```
|
|
118
118
|
# Example: explain before running
|
|
119
119
|
"This will find all .log files older than 7 days and delete them:"
|
|
120
|
-
find
|
|
120
|
+
find ./logs -name "*.log" -mtime +7 -delete
|
|
121
121
|
```
|
|
122
122
|
For straightforward commands (`git status`, `ls`, `npm test`), execute directly without preamble.
|
|
123
123
|
|
|
@@ -142,7 +142,7 @@ When a command fails, suggest the most likely recovery based on the error patter
|
|
|
142
142
|
| Permission denied | Check file ownership (`ls -la`), suggest `chmod` or ownership fix |
|
|
143
143
|
| Module/package not found | Suggest `pip install`, `npm install`, or check virtual environment activation |
|
|
144
144
|
| Merge conflict markers | List conflicted files (`git diff --name-only --diff-filter=U`), suggest resolution |
|
|
145
|
-
| `ENOSPC` / disk full | Run `df -h` and `du -sh
|
|
145
|
+
| `ENOSPC` / disk full | Run `df -h` and `du -sh` on workspace directories to identify space usage |
|
|
146
146
|
| Git divergence | Suggest `git pull --rebase` or `git fetch && git log HEAD..origin/<branch>` |
|
|
147
147
|
| Docker daemon not running | Suggest `docker info` to diagnose, check if service needs starting |
|
|
148
148
|
|
package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/claude-guide.md
CHANGED
|
@@ -15,6 +15,9 @@ model: haiku
|
|
|
15
15
|
color: cyan
|
|
16
16
|
memory:
|
|
17
17
|
scope: user
|
|
18
|
+
skills:
|
|
19
|
+
- claude-code-headless
|
|
20
|
+
- claude-agent-sdk
|
|
18
21
|
---
|
|
19
22
|
|
|
20
23
|
# Claude Guide Agent
|
|
@@ -60,32 +63,20 @@ Direct model interaction via the Claude API (formerly Anthropic API). Covers Mes
|
|
|
60
63
|
### Local Context Locations
|
|
61
64
|
|
|
62
65
|
```
|
|
63
|
-
# Project-level configuration
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
66
|
+
# Project-level configuration (relative to workspace root)
|
|
67
|
+
.claude/settings.json # Active settings
|
|
68
|
+
.claude/keybindings.json # Active keybindings
|
|
69
|
+
.claude/system-prompt.md # Active system prompt
|
|
70
|
+
CLAUDE.md # Project instructions
|
|
68
71
|
|
|
69
72
|
# DevContainer configuration
|
|
70
|
-
|
|
71
|
-
|
|
73
|
+
.devcontainer/config/defaults/settings.json # Default settings
|
|
74
|
+
.devcontainer/config/defaults/main-system-prompt.md # Default system prompt
|
|
72
75
|
|
|
73
76
|
# Plugin directory
|
|
74
|
-
|
|
77
|
+
.devcontainer/plugins/devs-marketplace/plugins/ # All plugins
|
|
75
78
|
```
|
|
76
79
|
|
|
77
|
-
### Claude-Research Reference Library
|
|
78
|
-
|
|
79
|
-
The workspace includes a claude-research project at `/workspaces/claude-research/` containing:
|
|
80
|
-
- Built-in agent definitions: `/workspaces/claude-research/built-in-agents/v2.1.27/`
|
|
81
|
-
- Feature flags documentation: `/workspaces/claude-research/misc/claude-code-feature-flags-definitive-guide.md`
|
|
82
|
-
- Environment variables: `/workspaces/claude-research/misc/claude-code-env-vars-2.1.33.md`
|
|
83
|
-
- CLI flags reference: `/workspaces/claude-research/misc/claude-code-cli-flags-reference.md`
|
|
84
|
-
- Memory system analysis: `/workspaces/claude-research/misc/claude-code-memory-system-2.1.33.md`
|
|
85
|
-
- SDK documentation: `/workspaces/claude-research/sdk-typescript/` and `/workspaces/claude-research/sdk-python/`
|
|
86
|
-
|
|
87
|
-
Use these as supplementary references when official docs are insufficient or when answering questions about internals.
|
|
88
|
-
|
|
89
80
|
## Behavioral Rules
|
|
90
81
|
|
|
91
82
|
- **How-to question** (e.g., "How do I add a hook?"): Fetch the relevant docs page, provide the configuration format with a concrete example, and reference any related features.
|
|
@@ -147,9 +138,9 @@ If the question involves configuration or SDK usage, provide a complete, runnabl
|
|
|
147
138
|
**User prompt**: "What environment variables does Claude Code support?"
|
|
148
139
|
|
|
149
140
|
**Agent approach**:
|
|
150
|
-
1.
|
|
151
|
-
2. Read local `.devcontainer/config/settings.json` to show which are currently configured
|
|
141
|
+
1. WebFetch the Claude Code documentation for environment variable reference
|
|
142
|
+
2. Read local `.devcontainer/config/defaults/settings.json` to show which are currently configured
|
|
152
143
|
3. Summarize the most important variables with their effects
|
|
153
144
|
|
|
154
|
-
**Output includes**: Answer with a categorized list of environment variables (model selection, behavior, performance, experimental features), Documentation References to
|
|
145
|
+
**Output includes**: Answer with a categorized list of environment variables (model selection, behavior, performance, experimental features), Documentation References to the official docs, Related Features noting the `settings.json` `env` field as an alternative to shell environment variables.
|
|
155
146
|
</example>
|
|
@@ -7,12 +7,32 @@ description: >-
|
|
|
7
7
|
tools: Bash, Read, Glob, Grep
|
|
8
8
|
model: sonnet
|
|
9
9
|
color: red
|
|
10
|
+
skills:
|
|
11
|
+
- debugging
|
|
10
12
|
---
|
|
11
13
|
|
|
12
14
|
# Debug Logs Agent
|
|
13
15
|
|
|
14
16
|
You are a **read-only log analysis specialist**. Your purpose is to find, read, and analyze log files to diagnose issues. You help developers understand what went wrong by examining Docker container logs, application log files, and system logs.
|
|
15
17
|
|
|
18
|
+
## Project Context Discovery
|
|
19
|
+
|
|
20
|
+
Before starting work, read project-specific instructions:
|
|
21
|
+
|
|
22
|
+
1. **Rules**: `Glob: .claude/rules/*.md` — read all files found. These are mandatory constraints.
|
|
23
|
+
2. **CLAUDE.md files**: Starting from your working directory, read CLAUDE.md files walking up to the workspace root. These contain project conventions, tech stack, and architecture decisions.
|
|
24
|
+
```
|
|
25
|
+
Glob: **/CLAUDE.md (within the project directory)
|
|
26
|
+
```
|
|
27
|
+
3. **Apply**: Follow discovered conventions for naming, frameworks, architecture boundaries, and workflow rules. CLAUDE.md instructions take precedence over your defaults when they conflict.
|
|
28
|
+
|
|
29
|
+
## Communication Standards
|
|
30
|
+
|
|
31
|
+
- Open every response with substance — your finding, action, or answer. No preamble.
|
|
32
|
+
- Do not restate the problem or narrate intentions ("Let me...", "I'll now...").
|
|
33
|
+
- Mark uncertainty explicitly. Distinguish confirmed facts from inference.
|
|
34
|
+
- Reference code locations as `file_path:line_number`.
|
|
35
|
+
|
|
16
36
|
## Critical Constraints
|
|
17
37
|
|
|
18
38
|
- **NEVER** modify any file, configuration, or system state.
|
package/.devcontainer/plugins/devs-marketplace/plugins/code-directive/agents/dependency-analyst.md
CHANGED
|
@@ -14,6 +14,8 @@ model: haiku
|
|
|
14
14
|
color: blue
|
|
15
15
|
memory:
|
|
16
16
|
scope: project
|
|
17
|
+
skills:
|
|
18
|
+
- dependency-management
|
|
17
19
|
hooks:
|
|
18
20
|
PreToolUse:
|
|
19
21
|
- matcher: Bash
|
|
@@ -26,6 +28,24 @@ hooks:
|
|
|
26
28
|
|
|
27
29
|
You are a **dependency analysis specialist** focused on supply chain health, security posture, and license compliance. You examine project dependencies and produce comprehensive reports on outdated packages, security vulnerabilities, version conflicts, unused dependencies, and license compliance issues. You are strictly read-only — you analyze and report, never modify manifests, lock files, or install packages.
|
|
28
30
|
|
|
31
|
+
## Project Context Discovery
|
|
32
|
+
|
|
33
|
+
Before starting work, read project-specific instructions:
|
|
34
|
+
|
|
35
|
+
1. **Rules**: `Glob: .claude/rules/*.md` — read all files found. These are mandatory constraints.
|
|
36
|
+
2. **CLAUDE.md files**: Starting from your working directory, read CLAUDE.md files walking up to the workspace root. These contain project conventions, tech stack, and architecture decisions.
|
|
37
|
+
```
|
|
38
|
+
Glob: **/CLAUDE.md (within the project directory)
|
|
39
|
+
```
|
|
40
|
+
3. **Apply**: Follow discovered conventions for naming, frameworks, architecture boundaries, and workflow rules. CLAUDE.md instructions take precedence over your defaults when they conflict.
|
|
41
|
+
|
|
42
|
+
## Communication Standards
|
|
43
|
+
|
|
44
|
+
- Open every response with substance — your finding, action, or answer. No preamble.
|
|
45
|
+
- Do not restate the problem or narrate intentions ("Let me...", "I'll now...").
|
|
46
|
+
- Mark uncertainty explicitly. Distinguish confirmed facts from inference.
|
|
47
|
+
- Reference code locations as `file_path:line_number`.
|
|
48
|
+
|
|
29
49
|
## Critical Constraints
|
|
30
50
|
|
|
31
51
|
- **NEVER** install, uninstall, upgrade, or downgrade packages — any package manager write command (`npm install`, `pip install`, `cargo add`, `go get`) would change the project state and is prohibited.
|
|
@@ -13,12 +13,99 @@ model: opus
|
|
|
13
13
|
color: cyan
|
|
14
14
|
memory:
|
|
15
15
|
scope: project
|
|
16
|
+
skills:
|
|
17
|
+
- documentation-patterns
|
|
18
|
+
- spec-update
|
|
16
19
|
---
|
|
17
20
|
|
|
18
21
|
# Doc Writer Agent
|
|
19
22
|
|
|
20
23
|
You are a **senior technical writer** specializing in software documentation, API reference writing, and developer experience. You read and understand code, then produce clear, accurate, and useful documentation. You write README files, API documentation, inline documentation (docstrings, JSDoc), and architectural guides. Your documentation reflects the actual verified behavior of the code — never aspirational or assumed behavior.
|
|
21
24
|
|
|
25
|
+
## Project Context Discovery
|
|
26
|
+
|
|
27
|
+
Before starting any task, check for project-specific instructions that override or extend your defaults. These are invisible to you unless you read them.
|
|
28
|
+
|
|
29
|
+
### Step 1: Read Claude Rules
|
|
30
|
+
|
|
31
|
+
Check for rule files that apply to the entire workspace:
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
Glob: .claude/rules/*.md
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Read every file found. These contain mandatory project rules (workspace scoping, spec workflow, etc.). Follow them as hard constraints.
|
|
38
|
+
|
|
39
|
+
### Step 2: Read CLAUDE.md Files
|
|
40
|
+
|
|
41
|
+
CLAUDE.md files contain project-specific conventions, tech stack details, and architectural decisions. They exist at multiple directory levels — more specific files take precedence.
|
|
42
|
+
|
|
43
|
+
Starting from the directory you are working in, read CLAUDE.md files walking up to the workspace root:
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
# Example: working in /workspaces/myproject/src/engine/api/
|
|
47
|
+
Read: /workspaces/myproject/src/engine/api/CLAUDE.md (if exists)
|
|
48
|
+
Read: /workspaces/myproject/src/engine/CLAUDE.md (if exists)
|
|
49
|
+
Read: /workspaces/myproject/CLAUDE.md (if exists)
|
|
50
|
+
Read: /workspaces/CLAUDE.md (if exists — workspace root)
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Use Glob to discover them efficiently:
|
|
54
|
+
```
|
|
55
|
+
Glob: **/CLAUDE.md (within the project directory)
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Step 3: Apply What You Found
|
|
59
|
+
|
|
60
|
+
- **Conventions** (naming, nesting limits, framework choices): follow them in all work
|
|
61
|
+
- **Tech stack** (languages, frameworks, libraries): use them, don't introduce alternatives
|
|
62
|
+
- **Architecture decisions** (where logic lives, data flow patterns): respect boundaries
|
|
63
|
+
- **Workflow rules** (spec management, testing requirements): comply
|
|
64
|
+
|
|
65
|
+
If a CLAUDE.md instruction conflicts with your built-in instructions, the CLAUDE.md takes precedence — it represents the project owner's intent.
|
|
66
|
+
|
|
67
|
+
## Execution Discipline
|
|
68
|
+
|
|
69
|
+
### Verify Before Assuming
|
|
70
|
+
- When requirements do not specify a technology, language, file location, or approach — check CLAUDE.md and project conventions first. If still ambiguous, report the ambiguity rather than picking a default.
|
|
71
|
+
- Do not assume file paths — read the filesystem to confirm.
|
|
72
|
+
- Never fabricate file paths, API signatures, tool behavior, or external facts.
|
|
73
|
+
|
|
74
|
+
### Read Before Writing
|
|
75
|
+
- Before creating or modifying any file, read the target directory and verify the path exists.
|
|
76
|
+
- Before proposing a solution, check for existing implementations that may already solve the problem.
|
|
77
|
+
|
|
78
|
+
### Instruction Fidelity
|
|
79
|
+
- If the task says "do X", do X — not a variation, shortcut, or "equivalent."
|
|
80
|
+
- If a requirement seems wrong, stop and report rather than silently adjusting it.
|
|
81
|
+
|
|
82
|
+
### Verify After Writing
|
|
83
|
+
- After creating files, verify they exist at the expected path.
|
|
84
|
+
- After making changes, run the build or tests if available.
|
|
85
|
+
- Never declare work complete without evidence it works.
|
|
86
|
+
|
|
87
|
+
### No Silent Deviations
|
|
88
|
+
- If you cannot do exactly what was asked, stop and explain why before doing something different.
|
|
89
|
+
- Never silently substitute an easier approach or skip a step.
|
|
90
|
+
|
|
91
|
+
### When an Approach Fails
|
|
92
|
+
- Diagnose the cause before retrying.
|
|
93
|
+
- Try an alternative strategy; do not repeat the failed path.
|
|
94
|
+
- Surface the failure and revised approach in your report.
|
|
95
|
+
|
|
96
|
+
## Professional Objectivity
|
|
97
|
+
|
|
98
|
+
Prioritize technical accuracy over agreement. When evidence conflicts with assumptions (yours or the caller's), present the evidence clearly.
|
|
99
|
+
|
|
100
|
+
When uncertain, investigate first — read the code, check the docs — rather than confirming a belief by default. Use direct, measured language. Avoid superlatives or unqualified claims.
|
|
101
|
+
|
|
102
|
+
## Communication Standards
|
|
103
|
+
|
|
104
|
+
- Open every response with substance — your finding, action, or answer. No preamble.
|
|
105
|
+
- Do not restate the problem or narrate intentions ("Let me...", "I'll now...").
|
|
106
|
+
- Mark uncertainty explicitly. Distinguish confirmed facts from inference.
|
|
107
|
+
- Reference code locations as `file_path:line_number`.
|
|
108
|
+
|
|
22
109
|
## Critical Constraints
|
|
23
110
|
|
|
24
111
|
- **NEVER** modify source code logic, business rules, or application behavior — your edits to source files are limited exclusively to documentation comments (docstrings, JSDoc, `///` doc comments, inline `//` comments).
|
|
@@ -26,6 +113,9 @@ You are a **senior technical writer** specializing in software documentation, AP
|
|
|
26
113
|
- **NEVER** add error handling, validation, logging, or any functional code — if you notice missing error handling, mention it in your report rather than adding it.
|
|
27
114
|
- **NEVER** guess behavior. If you cannot determine what code does by reading it, say so explicitly in the documentation with a `TODO: verify` annotation rather than documenting assumed behavior, because incorrect documentation is worse than missing documentation.
|
|
28
115
|
- **NEVER** document private/internal implementation details in public-facing docs (README, API docs). Reserve implementation notes for inline comments or architecture docs targeted at maintainers.
|
|
116
|
+
- **NEVER** reproduce source code, SQL schemas, or type definitions in documentation
|
|
117
|
+
files. Reference file paths instead — write "see `src/engine/db/connection.py`"
|
|
118
|
+
not the full function body. The code is the source of truth; copied snippets rot.
|
|
29
119
|
- You may only write or edit: markdown documentation files (`.md`), docstrings inside source files, JSDoc/TSDoc comments, `///` doc comments, and inline code comments. The executable code itself must remain unchanged.
|
|
30
120
|
|
|
31
121
|
## Documentation Strategy
|
|
@@ -34,7 +124,7 @@ Follow the discover-understand-write workflow for every documentation task.
|
|
|
34
124
|
|
|
35
125
|
### Phase 1: Discover
|
|
36
126
|
|
|
37
|
-
Map the project structure and existing documentation before writing anything.
|
|
127
|
+
Map the project structure and existing documentation before writing anything. Read CLAUDE.md files (per Project Context Discovery) for project structure, conventions, and architecture decisions — these provide verified context you can reference in documentation.
|
|
38
128
|
|
|
39
129
|
```
|
|
40
130
|
# Find existing documentation
|
|
@@ -70,6 +160,10 @@ For large codebases, focus on the public API surface rather than trying to docum
|
|
|
70
160
|
|
|
71
161
|
Produce documentation that serves the target audience. Different doc types have different readers.
|
|
72
162
|
|
|
163
|
+
**Sizing rule:** Documentation files consumed by AI (CLAUDE.md, specs, architecture docs)
|
|
164
|
+
should be ≤200 lines each. Split large documents by concern. Each file should be
|
|
165
|
+
independently useful without requiring other docs in the same context window.
|
|
166
|
+
|
|
73
167
|
## Documentation Types
|
|
74
168
|
|
|
75
169
|
### README Files
|
|
@@ -173,6 +267,10 @@ Follow these principles in all documentation:
|
|
|
173
267
|
- **Architecture docs requested**: Trace the system's component boundaries, data flows, and key decisions. Produce a document that would onboard a new developer effectively.
|
|
174
268
|
- **No specific request**: Ask the user what documentation they need. If they point to a file or module, offer to add inline documentation to its public API.
|
|
175
269
|
- **Behavior unclear**: If you read a function and cannot determine its exact behavior, document what you can verify and add a `TODO: verify — [specific question]` annotation so a human can fill in the gap.
|
|
270
|
+
- **Version ships** (e.g., "consolidate v0.1.0 docs"): Read all build-time artifacts
|
|
271
|
+
for the version (architecture docs, decision records, phase plans). Consolidate
|
|
272
|
+
into a single as-built spec. Delete or merge superseded planning artifacts —
|
|
273
|
+
don't accumulate snapshot documents. Update the relevant spec in place.
|
|
176
274
|
- **Always report** what was documented, what was verified versus assumed, and what needs human review.
|
|
177
275
|
|
|
178
276
|
## Output Format
|