maxsimcli 5.0.7 → 5.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +101 -99
- package/dist/assets/CHANGELOG.md +7 -0
- package/dist/assets/hooks/maxsim-capture-learnings.cjs +128 -0
- package/dist/assets/hooks/maxsim-capture-learnings.cjs.map +1 -0
- package/dist/assets/hooks/maxsim-check-update.cjs +126 -88
- package/dist/assets/hooks/maxsim-check-update.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-notification-sound.cjs +87 -43
- package/dist/assets/hooks/maxsim-notification-sound.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-statusline.cjs +45 -171
- package/dist/assets/hooks/maxsim-statusline.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-stop-sound.cjs +86 -43
- package/dist/assets/hooks/maxsim-stop-sound.cjs.map +1 -1
- package/dist/assets/hooks/maxsim-sync-reminder.cjs +72 -21
- package/dist/assets/hooks/maxsim-sync-reminder.cjs.map +1 -1
- package/dist/assets/templates/agents/AGENTS.md +62 -51
- package/dist/assets/templates/agents/executor.md +44 -59
- package/dist/assets/templates/agents/planner.md +36 -31
- package/dist/assets/templates/agents/researcher.md +35 -43
- package/dist/assets/templates/agents/verifier.md +29 -31
- package/dist/assets/templates/commands/maxsim/debug.md +20 -154
- package/dist/assets/templates/commands/maxsim/execute.md +19 -33
- package/dist/assets/templates/commands/maxsim/go.md +21 -20
- package/dist/assets/templates/commands/maxsim/help.md +5 -14
- package/dist/assets/templates/commands/maxsim/init.md +18 -40
- package/dist/assets/templates/commands/maxsim/plan.md +22 -37
- package/dist/assets/templates/commands/maxsim/progress.md +15 -16
- package/dist/assets/templates/commands/maxsim/quick.md +18 -29
- package/dist/assets/templates/commands/maxsim/settings.md +18 -26
- package/dist/assets/templates/references/continuation-format.md +2 -4
- package/dist/assets/templates/references/model-profiles.md +2 -2
- package/dist/assets/templates/references/planning-config.md +10 -11
- package/dist/assets/templates/references/self-improvement.md +120 -0
- package/dist/assets/templates/rules/conventions.md +1 -1
- package/dist/assets/templates/rules/verification-protocol.md +1 -1
- package/dist/assets/templates/skills/brainstorming/SKILL.md +35 -26
- package/dist/assets/templates/skills/code-review/SKILL.md +78 -55
- package/dist/assets/templates/skills/commit-conventions/SKILL.md +70 -36
- package/dist/assets/templates/skills/github-operations/SKILL.md +142 -0
- package/dist/assets/templates/skills/handoff-contract/SKILL.md +62 -28
- package/dist/assets/templates/skills/maxsim-batch/SKILL.md +68 -42
- package/dist/assets/templates/skills/maxsim-simplify/SKILL.md +65 -40
- package/dist/assets/templates/skills/project-memory/SKILL.md +121 -0
- package/dist/assets/templates/skills/research/SKILL.md +126 -0
- package/dist/assets/templates/skills/roadmap-writing/SKILL.md +71 -68
- package/dist/assets/templates/skills/systematic-debugging/SKILL.md +37 -25
- package/dist/assets/templates/skills/tdd/SKILL.md +36 -39
- package/dist/assets/templates/skills/using-maxsim/SKILL.md +69 -55
- package/dist/assets/templates/skills/verification/SKILL.md +167 -0
- package/dist/assets/templates/workflows/batch.md +249 -268
- package/dist/assets/templates/workflows/diagnose-issues.md +225 -151
- package/dist/assets/templates/workflows/execute-plan.md +191 -981
- package/dist/assets/templates/workflows/execute.md +350 -309
- package/dist/assets/templates/workflows/go.md +119 -138
- package/dist/assets/templates/workflows/health.md +71 -114
- package/dist/assets/templates/workflows/help.md +85 -147
- package/dist/assets/templates/workflows/init-existing.md +180 -1373
- package/dist/assets/templates/workflows/init.md +53 -165
- package/dist/assets/templates/workflows/new-milestone.md +91 -334
- package/dist/assets/templates/workflows/new-project.md +165 -1384
- package/dist/assets/templates/workflows/plan-create.md +182 -73
- package/dist/assets/templates/workflows/plan-discuss.md +89 -82
- package/dist/assets/templates/workflows/plan-research.md +191 -85
- package/dist/assets/templates/workflows/plan.md +122 -58
- package/dist/assets/templates/workflows/progress.md +76 -310
- package/dist/assets/templates/workflows/quick.md +70 -495
- package/dist/assets/templates/workflows/sdd.md +231 -221
- package/dist/assets/templates/workflows/settings.md +90 -120
- package/dist/assets/templates/workflows/verify-phase.md +296 -258
- package/dist/cli.cjs +17 -23465
- package/dist/cli.cjs.map +1 -1
- package/dist/install.cjs +356 -8358
- package/dist/install.cjs.map +1 -1
- package/package.json +16 -22
- package/dist/assets/templates/skills/agent-system-map/SKILL.md +0 -92
- package/dist/assets/templates/skills/evidence-collection/SKILL.md +0 -87
- package/dist/assets/templates/skills/github-artifact-protocol/SKILL.md +0 -67
- package/dist/assets/templates/skills/github-tools-guide/SKILL.md +0 -89
- package/dist/assets/templates/skills/input-validation/SKILL.md +0 -51
- package/dist/assets/templates/skills/memory-management/SKILL.md +0 -75
- package/dist/assets/templates/skills/research-methodology/SKILL.md +0 -137
- package/dist/assets/templates/skills/sdd/SKILL.md +0 -91
- package/dist/assets/templates/skills/tool-priority-guide/SKILL.md +0 -80
- package/dist/assets/templates/skills/verification-before-completion/SKILL.md +0 -71
- package/dist/assets/templates/skills/verification-gates/SKILL.md +0 -169
- package/dist/assets/templates/workflows/discuss-phase.md +0 -683
- package/dist/assets/templates/workflows/research-phase.md +0 -73
- package/dist/assets/templates/workflows/verify-work.md +0 -572
- package/dist/core-D5zUr9cb.cjs +0 -4305
- package/dist/core-D5zUr9cb.cjs.map +0 -1
- package/dist/skills-CjFWZIGM.cjs +0 -6824
- package/dist/skills-CjFWZIGM.cjs.map +0 -1
package/package.json
CHANGED
|
@@ -1,13 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "maxsimcli",
|
|
3
|
-
"version": "5.0
|
|
3
|
+
"version": "5.1.0",
|
|
4
4
|
"private": false,
|
|
5
|
-
"description": "A meta-prompting, context engineering and spec-driven development system for Claude Code
|
|
5
|
+
"description": "A meta-prompting, context engineering and spec-driven development system for Claude Code by MayStudios.",
|
|
6
6
|
"bin": {
|
|
7
7
|
"maxsimcli": "dist/install.cjs"
|
|
8
8
|
},
|
|
9
9
|
"main": "./dist/cli.cjs",
|
|
10
|
-
"types": "./dist/cli.d.cts",
|
|
11
10
|
"files": [
|
|
12
11
|
"dist",
|
|
13
12
|
"README.md"
|
|
@@ -24,11 +23,7 @@
|
|
|
24
23
|
"ai",
|
|
25
24
|
"meta-prompting",
|
|
26
25
|
"context-engineering",
|
|
27
|
-
"spec-driven-development"
|
|
28
|
-
"gemini",
|
|
29
|
-
"gemini-cli",
|
|
30
|
-
"codex",
|
|
31
|
-
"codex-cli"
|
|
26
|
+
"spec-driven-development"
|
|
32
27
|
],
|
|
33
28
|
"author": "MayStudios",
|
|
34
29
|
"license": "MIT",
|
|
@@ -40,29 +35,28 @@
|
|
|
40
35
|
"bugs": {
|
|
41
36
|
"url": "https://github.com/maystudios/maxsimcli/issues"
|
|
42
37
|
},
|
|
43
|
-
"
|
|
38
|
+
"dependencies": {
|
|
44
39
|
"@inquirer/prompts": "^8.3.0",
|
|
45
|
-
"@
|
|
46
|
-
"@
|
|
47
|
-
"@
|
|
48
|
-
"@types/node": "^25.3.0",
|
|
40
|
+
"@octokit/plugin-retry": "^8.1.0",
|
|
41
|
+
"@octokit/plugin-throttling": "^11.0.3",
|
|
42
|
+
"@octokit/rest": "^22.0.1",
|
|
49
43
|
"chalk": "^5.6.2",
|
|
50
|
-
"esbuild": "^0.24.0",
|
|
51
44
|
"escape-string-regexp": "^5.0.0",
|
|
45
|
+
"figlet": "^1.10.0",
|
|
52
46
|
"fs-extra": "^11.3.3",
|
|
53
47
|
"minimist": "^1.2.8",
|
|
54
48
|
"ora": "^9.3.0",
|
|
55
49
|
"simple-git": "^3.32.2",
|
|
56
50
|
"slugify": "^1.6.6",
|
|
57
|
-
"tsdown": "^0.20.3",
|
|
58
|
-
"typescript": "^5.9.3",
|
|
59
|
-
"vitest": "^4.0.18",
|
|
60
51
|
"yaml": "^2.8.2"
|
|
61
52
|
},
|
|
62
|
-
"
|
|
63
|
-
"@
|
|
64
|
-
"@
|
|
65
|
-
"@
|
|
66
|
-
"
|
|
53
|
+
"devDependencies": {
|
|
54
|
+
"@types/figlet": "^1.7.0",
|
|
55
|
+
"@types/fs-extra": "^11.0.4",
|
|
56
|
+
"@types/minimist": "^1.2.5",
|
|
57
|
+
"@types/node": "^25.3.0",
|
|
58
|
+
"tsdown": "^0.20.3",
|
|
59
|
+
"typescript": "^5.9.3",
|
|
60
|
+
"vitest": "^4.0.18"
|
|
67
61
|
}
|
|
68
62
|
}
|
|
@@ -1,92 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: agent-system-map
|
|
3
|
-
description: >-
|
|
4
|
-
Registry of MAXSIM's 4 agent types with their roles, base tools, preloaded
|
|
5
|
-
skills, and typical tasks. Documents the orchestrator-mediated communication
|
|
6
|
-
pattern where agents return results to the orchestrator for pipeline routing.
|
|
7
|
-
Use when spawning agents, understanding agent capabilities, or designing
|
|
8
|
-
agent interactions.
|
|
9
|
-
user-invocable: false
|
|
10
|
-
---
|
|
11
|
-
|
|
12
|
-
# Agent System Map
|
|
13
|
-
|
|
14
|
-
MAXSIM uses 4 generic agent types. Specialization comes from orchestrator instructions and skills, not from separate agent definitions.
|
|
15
|
-
|
|
16
|
-
## Agent Registry
|
|
17
|
-
|
|
18
|
-
| Agent | Role | Base Tools | Preloaded Skills |
|
|
19
|
-
|-------|------|-----------|-----------------|
|
|
20
|
-
| **executor** | Implements plans with atomic commits and verified completion | Read, Write, Edit, Bash, Grep, Glob | handoff-contract, evidence-collection, commit-conventions |
|
|
21
|
-
| **planner** | Creates structured PLAN.md files from requirements and research | Read, Bash, Grep, Glob | handoff-contract |
|
|
22
|
-
| **researcher** | Investigates technical domains and produces structured findings | Read, Bash, Grep, Glob, WebFetch | research-methodology, handoff-contract |
|
|
23
|
-
| **verifier** | Verifies work quality, spec compliance, and goal achievement | Read, Bash, Grep, Glob | verification-gates, evidence-collection, handoff-contract |
|
|
24
|
-
|
|
25
|
-
## Specialization via Orchestrator
|
|
26
|
-
|
|
27
|
-
The orchestrator provides task-specific context in the spawn prompt. The same `verifier` agent handles code review, spec review, debugging, and integration checking based on what the orchestrator asks:
|
|
28
|
-
|
|
29
|
-
| Task | Orchestrator Instruction |
|
|
30
|
-
|------|------------------------|
|
|
31
|
-
| Code review | "Review these files for code quality, security, and conventions" |
|
|
32
|
-
| Spec review | "Check these files against the plan's must_haves and done criteria" |
|
|
33
|
-
| Debugging | "Investigate this failing test using systematic hypothesis testing" |
|
|
34
|
-
| Integration check | "Validate cross-component integration for these changed files" |
|
|
35
|
-
|
|
36
|
-
## Communication Pattern: Orchestrator-Mediated
|
|
37
|
-
|
|
38
|
-
**Subagents CANNOT spawn other subagents.** This is a Claude Code platform constraint. All agent-to-agent communication routes through the orchestrator.
|
|
39
|
-
|
|
40
|
-
```
|
|
41
|
-
Orchestrator
|
|
42
|
-
|-- spawns --> Researcher (returns findings)
|
|
43
|
-
|-- spawns --> Planner (returns PLAN.md)
|
|
44
|
-
|-- spawns --> Executor (returns SUMMARY.md)
|
|
45
|
-
|-- spawns --> Verifier (returns verification report)
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
**Flow:**
|
|
49
|
-
1. Orchestrator spawns Agent A with task + context
|
|
50
|
-
2. Agent A executes, produces results using handoff contract
|
|
51
|
-
3. Agent A returns to orchestrator
|
|
52
|
-
4. Orchestrator reads results, decides next step
|
|
53
|
-
5. Orchestrator spawns Agent B with Agent A's results as context
|
|
54
|
-
|
|
55
|
-
Agents never call each other directly. The orchestrator is the single routing point.
|
|
56
|
-
|
|
57
|
-
## Spawn Prompt Format
|
|
58
|
-
|
|
59
|
-
When spawning an agent, use natural language with markdown sections:
|
|
60
|
-
|
|
61
|
-
```markdown
|
|
62
|
-
## Task
|
|
63
|
-
[What the agent should do -- specific, actionable]
|
|
64
|
-
|
|
65
|
-
## Context
|
|
66
|
-
[Phase, plan, prior results, relevant decisions]
|
|
67
|
-
|
|
68
|
-
## Files to Read
|
|
69
|
-
- [file paths the agent should read at startup]
|
|
70
|
-
|
|
71
|
-
## Suggested Skills
|
|
72
|
-
- [skills that may be helpful for this task]
|
|
73
|
-
|
|
74
|
-
## Success Criteria
|
|
75
|
-
- [measurable outcomes the orchestrator will check]
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
The orchestrator carries the specialization context. Agents are generic -- the spawn prompt makes them specific.
|
|
79
|
-
|
|
80
|
-
## Model Selection
|
|
81
|
-
|
|
82
|
-
Each agent type has a default model from the config profile:
|
|
83
|
-
|
|
84
|
-
| Profile | Executor | Planner | Researcher | Verifier |
|
|
85
|
-
|---------|----------|---------|------------|----------|
|
|
86
|
-
| quality | opus | opus | opus | sonnet |
|
|
87
|
-
| balanced | sonnet | sonnet | sonnet | sonnet |
|
|
88
|
-
| budget | sonnet | haiku | haiku | haiku |
|
|
89
|
-
|
|
90
|
-
The orchestrator can override per-spawn for complex tasks (e.g., force opus for critical research).
|
|
91
|
-
|
|
92
|
-
Agents use `model: inherit` in their frontmatter -- the orchestrator or CLI resolves the actual model at spawn time based on the config profile.
|
|
@@ -1,87 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: evidence-collection
|
|
3
|
-
description: >-
|
|
4
|
-
Systematic evidence gathering using tool output before making claims. Covers
|
|
5
|
-
what counts as evidence, the collection process, and common pitfalls that lead
|
|
6
|
-
to false claims. Use when verifying work completion, checking test results,
|
|
7
|
-
validating build success, or before any completion gate.
|
|
8
|
-
user-invocable: false
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
# Evidence Collection
|
|
12
|
-
|
|
13
|
-
Gather fresh evidence using tool output before making any claim. Evidence must come from THIS turn -- not prior turns, not cached knowledge, not reasoning.
|
|
14
|
-
|
|
15
|
-
## Collection Process
|
|
16
|
-
|
|
17
|
-
For each claim you need to support:
|
|
18
|
-
|
|
19
|
-
1. **IDENTIFY** -- What command proves this claim?
|
|
20
|
-
- Pick the most direct verification (e.g., `npm test` for "tests pass", not "I wrote the test")
|
|
21
|
-
- If no single command exists, identify all required checks
|
|
22
|
-
|
|
23
|
-
2. **RUN** -- Execute the command fresh in THIS turn
|
|
24
|
-
- Do not reuse output from a previous turn
|
|
25
|
-
- Do not rely on output from a different command
|
|
26
|
-
- Run the full command, not a partial check
|
|
27
|
-
|
|
28
|
-
3. **READ** -- Read the complete output
|
|
29
|
-
- Check the exit code (0 = success, non-zero = failure)
|
|
30
|
-
- Read all output, not just the summary line
|
|
31
|
-
- Look for warnings or partial failures hidden in verbose output
|
|
32
|
-
|
|
33
|
-
4. **CHECK** -- Does the output actually confirm the claim?
|
|
34
|
-
- Match output against specific expected values
|
|
35
|
-
- A passing build does not mean passing tests
|
|
36
|
-
- A created file does not mean correct file contents
|
|
37
|
-
|
|
38
|
-
5. **CITE** -- Include the evidence in your response
|
|
39
|
-
- Use the evidence block format
|
|
40
|
-
- Quote specific output lines, not paraphrased summaries
|
|
41
|
-
|
|
42
|
-
## What Counts as Evidence
|
|
43
|
-
|
|
44
|
-
| Claim | Requires | Not Sufficient |
|
|
45
|
-
|-------|----------|----------------|
|
|
46
|
-
| "Tests pass" | Test command output showing 0 failures | Previous run, "should pass", partial run |
|
|
47
|
-
| "Build succeeds" | Build command with exit code 0 | Linter passing, "logs look clean" |
|
|
48
|
-
| "Bug is fixed" | Original failing test now passes | "Code changed, assumed fixed" |
|
|
49
|
-
| "Task complete" | All done criteria checked with evidence | "I implemented everything in the plan" |
|
|
50
|
-
| "No regressions" | Full test suite passing | "I only changed one file" |
|
|
51
|
-
| "File created" | Read tool or `test -f` output | "I ran the Write tool" (verify it wrote) |
|
|
52
|
-
| "Content correct" | Read tool showing expected content | "I wrote the correct content" |
|
|
53
|
-
| "API responds" | curl/fetch output with status code | "Server is running" without calling it |
|
|
54
|
-
|
|
55
|
-
## Evidence Block Format
|
|
56
|
-
|
|
57
|
-
```
|
|
58
|
-
CLAIM: [what you are claiming]
|
|
59
|
-
EVIDENCE: [exact command run in THIS turn]
|
|
60
|
-
OUTPUT: [relevant excerpt of actual output]
|
|
61
|
-
VERDICT: PASS | FAIL
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## Common Pitfalls
|
|
65
|
-
|
|
66
|
-
| Excuse | Why It Fails |
|
|
67
|
-
|--------|-------------|
|
|
68
|
-
| "Should work now" | "Should" is not evidence. Run the command. |
|
|
69
|
-
| "I'm confident in the logic" | Confidence is not evidence. Run it. |
|
|
70
|
-
| "The linter passed" | Linter passing does not mean tests pass or build succeeds. |
|
|
71
|
-
| "I only changed one line" | One line can break everything. Verify. |
|
|
72
|
-
| "The subagent reported success" | Trust test output and VCS diffs, not agent reports. |
|
|
73
|
-
| "I already checked this" | In a previous turn. Evidence expires each turn. Run it again. |
|
|
74
|
-
| "The error was in a different file" | Side effects cross files. Run the full suite. |
|
|
75
|
-
| "It compiled, so it works" | Compilation checks types, not logic. Run tests. |
|
|
76
|
-
|
|
77
|
-
## Key Rules
|
|
78
|
-
|
|
79
|
-
- **THIS-turn only**: Evidence from prior turns is stale. Always re-run.
|
|
80
|
-
- **Tool output only**: Your reasoning, analysis, and confidence are not evidence.
|
|
81
|
-
- **Full output**: Read the complete output, not just the first or last line.
|
|
82
|
-
- **Specific citations**: Quote the output. "It passed" is not a citation.
|
|
83
|
-
- **One block per claim**: Each distinct claim needs its own evidence or an explicit grouping note.
|
|
84
|
-
|
|
85
|
-
## See Also
|
|
86
|
-
|
|
87
|
-
The `verification-gates` skill defines the gate framework where evidence collection is applied. The always-loaded `verification-protocol` rule provides the enforcement language.
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
# Skill: GitHub Artifact Protocol
|
|
2
|
-
|
|
3
|
-
## Trigger
|
|
4
|
-
When reading from or writing to GitHub Issues for MAXSIM artifacts.
|
|
5
|
-
|
|
6
|
-
## Protocol
|
|
7
|
-
|
|
8
|
-
### Artifact Types and Comment Conventions
|
|
9
|
-
|
|
10
|
-
All MAXSIM artifacts are stored as GitHub Issue comments with type metadata:
|
|
11
|
-
|
|
12
|
-
| Artifact | Comment Type | Tool | Format |
|
|
13
|
-
|----------|-------------|------|--------|
|
|
14
|
-
| Context decisions | `context` | `github post-comment --type context` | `<!-- maxsim:type=context -->` header |
|
|
15
|
-
| Research findings | `research` | `github post-comment --type research` | `<!-- maxsim:type=research -->` header |
|
|
16
|
-
| Plan content | (plan header) | `github post-plan-comment` | `<!-- maxsim:type=plan -->` header |
|
|
17
|
-
| Summary | `summary` | `github post-comment --type summary` | `<!-- maxsim:type=summary -->` header |
|
|
18
|
-
| Verification | `verification` | `github post-comment --type verification` | `<!-- maxsim:type=verification -->` header |
|
|
19
|
-
| UAT | `uat` | `github post-comment --type uat` | `<!-- maxsim:type=uat -->` header |
|
|
20
|
-
| Completion | (structured) | `github post-completion` | Commit SHA + files |
|
|
21
|
-
|
|
22
|
-
### Issue Lifecycle State Machine
|
|
23
|
-
|
|
24
|
-
**Phase Issues:**
|
|
25
|
-
```
|
|
26
|
-
To Do --> In Progress --> In Review --> Done
|
|
27
|
-
(created) (plan done) (PR created) (PR merged + verified)
|
|
28
|
-
```
|
|
29
|
-
|
|
30
|
-
**Task Sub-Issues:**
|
|
31
|
-
```
|
|
32
|
-
To Do --> In Progress --> Done
|
|
33
|
-
(created) (started) (completed + review passed)
|
|
34
|
-
Done --> In Progress (review failed, reopened)
|
|
35
|
-
```
|
|
36
|
-
|
|
37
|
-
### Write Order (WIRE-01)
|
|
38
|
-
|
|
39
|
-
1. Build content in memory
|
|
40
|
-
2. POST to GitHub via CLI command
|
|
41
|
-
3. If successful, operation succeeds
|
|
42
|
-
4. If failed, operation aborts entirely -- no partial state
|
|
43
|
-
|
|
44
|
-
### Rollback Pattern (WIRE-07)
|
|
45
|
-
|
|
46
|
-
On partial failure during batch operations:
|
|
47
|
-
1. Close partially-created issues with `state_reason: 'not_planned'`
|
|
48
|
-
2. Post `[MAXSIM-ROLLBACK]` comment explaining why
|
|
49
|
-
3. Report what succeeded and what failed
|
|
50
|
-
4. Offer targeted retry
|
|
51
|
-
|
|
52
|
-
### External Edit Detection (WIRE-06)
|
|
53
|
-
|
|
54
|
-
- Body hash (SHA-256) stored in `github-issues.json` mapping after each write
|
|
55
|
-
- On read, compare live body hash against stored hash
|
|
56
|
-
- If different, warn user about external modification
|
|
57
|
-
- Do not auto-incorporate -- user decides
|
|
58
|
-
|
|
59
|
-
### What Stays Local
|
|
60
|
-
|
|
61
|
-
- `config.json` -- project settings
|
|
62
|
-
- `PROJECT.md` -- project vision
|
|
63
|
-
- `REQUIREMENTS.md` -- requirements
|
|
64
|
-
- `ROADMAP.md` -- phase structure
|
|
65
|
-
- `STATE.md` -- decisions, blockers, metrics
|
|
66
|
-
- `github-issues.json` -- mapping cache (rebuildable)
|
|
67
|
-
- `codebase/` -- stack, architecture, conventions
|
|
@@ -1,89 +0,0 @@
|
|
|
1
|
-
# Skill: GitHub Tools Guide
|
|
2
|
-
|
|
3
|
-
## Trigger
|
|
4
|
-
When interacting with GitHub Issues, project boards, or progress tracking in MAXSIM.
|
|
5
|
-
|
|
6
|
-
## CLI Invocation
|
|
7
|
-
|
|
8
|
-
All GitHub operations use the MAXSIM CLI tools router:
|
|
9
|
-
|
|
10
|
-
```bash
|
|
11
|
-
node ~/.claude/maxsim/bin/maxsim-tools.cjs github <command> [--flag value] [--raw]
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
Add `--raw` to get machine-readable JSON output (no formatting).
|
|
15
|
-
|
|
16
|
-
## Command Reference
|
|
17
|
-
|
|
18
|
-
### Setup
|
|
19
|
-
| Command | Description |
|
|
20
|
-
|---------|-------------|
|
|
21
|
-
| `github setup [--milestone-title "T"]` | Set up GitHub integration: board, labels, milestone, templates |
|
|
22
|
-
|
|
23
|
-
### Phase Lifecycle
|
|
24
|
-
| Command | Description |
|
|
25
|
-
|---------|-------------|
|
|
26
|
-
| `github create-phase --phase-number "01" --phase-name "Name" --goal "Goal" [--requirements "R1,R2"] [--success-criteria "SC1,SC2"]` | Create phase issue + add to board + set "To Do" |
|
|
27
|
-
| `github create-task --phase-number "01" --task-id "T1" --title "Title" --body "Body" --parent-issue-number N` | Create task sub-issue |
|
|
28
|
-
| `github batch-create-tasks --phase-number "01" --parent-issue-number N --tasks '[{"task_id":"1.1","title":"Title","body":"Body"}, ...]'` | Batch create tasks with rollback |
|
|
29
|
-
| `github post-plan-comment --phase-issue-number N --plan-number "01" --plan-content "..." [--plan-content-file F]` | Post plan comment on phase issue |
|
|
30
|
-
|
|
31
|
-
### Comments
|
|
32
|
-
| Command | Description |
|
|
33
|
-
|---------|-------------|
|
|
34
|
-
| `github post-comment --issue-number N --body "..." [--body-file F] [--type TYPE]` | Post comment (types: research, context, summary, verification, uat, general) |
|
|
35
|
-
| `github post-completion --issue-number N --commit-sha "SHA" --files-changed "a.ts,b.ts"` | Post completion comment |
|
|
36
|
-
|
|
37
|
-
### Issue Operations
|
|
38
|
-
| Command | Description |
|
|
39
|
-
|---------|-------------|
|
|
40
|
-
| `github get-issue --issue-number N [--include-comments]` | Get issue details (with optional comments) |
|
|
41
|
-
| `github list-sub-issues --phase-issue-number N` | List sub-issues of a phase issue |
|
|
42
|
-
| `github close-issue --issue-number N [--reason "..."] [--state-reason completed\|not_planned]` | Close issue |
|
|
43
|
-
| `github reopen-issue --issue-number N` | Reopen closed issue |
|
|
44
|
-
| `github bounce-issue --issue-number N --reason "feedback"` | Bounce to In Progress with feedback |
|
|
45
|
-
| `github move-issue --issue-number N --status "STATUS"` | Move to board column (To Do, In Progress, In Review, Done) |
|
|
46
|
-
| `github detect-external-edits --phase-number "01"` | Check body hash mismatch |
|
|
47
|
-
|
|
48
|
-
### Board Operations
|
|
49
|
-
| Command | Description |
|
|
50
|
-
|---------|-------------|
|
|
51
|
-
| `github query-board --project-number N [--status "STATUS"] [--phase "01"]` | Query board items |
|
|
52
|
-
| `github add-to-board --project-number N --issue-number M` | Add issue to board |
|
|
53
|
-
| `github search-issues [--labels "L1,L2"] [--state open\|closed\|all] [--query "text"]` | Search issues |
|
|
54
|
-
| `github sync-check` | Verify local mapping matches GitHub state |
|
|
55
|
-
|
|
56
|
-
### Progress
|
|
57
|
-
| Command | Description |
|
|
58
|
-
|---------|-------------|
|
|
59
|
-
| `github phase-progress --phase-issue-number N` | Phase progress from sub-issues |
|
|
60
|
-
| `github all-progress` | All phases progress overview |
|
|
61
|
-
| `github detect-interrupted --phase-issue-number N` | Detect interrupted phase |
|
|
62
|
-
|
|
63
|
-
### Convenience
|
|
64
|
-
| Command | Description |
|
|
65
|
-
|---------|-------------|
|
|
66
|
-
| `github status` | Combined progress + interrupted + board overview |
|
|
67
|
-
| `github sync` | Sync check + repair actions |
|
|
68
|
-
| `github overview` | Board summary grouped by column |
|
|
69
|
-
|
|
70
|
-
## Text Arguments
|
|
71
|
-
|
|
72
|
-
For large text (body, plan-content), write to a tmpfile and use `--*-file`:
|
|
73
|
-
|
|
74
|
-
```bash
|
|
75
|
-
TMPFILE=$(mktemp)
|
|
76
|
-
cat > "$TMPFILE" << 'EOF'
|
|
77
|
-
Multi-line content here...
|
|
78
|
-
EOF
|
|
79
|
-
node ~/.claude/maxsim/bin/maxsim-tools.cjs github post-comment --issue-number 42 --body-file "$TMPFILE" --type summary
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
## Output Format
|
|
83
|
-
|
|
84
|
-
All commands return JSON when `--raw` is passed:
|
|
85
|
-
```json
|
|
86
|
-
{"ok": true, "result": "...", "rawValue": {...}}
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
Without `--raw`, returns human-readable formatted output.
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: input-validation
|
|
3
|
-
description: >-
|
|
4
|
-
Validates required inputs exist before agent work begins. Checks file paths,
|
|
5
|
-
environment variables, and CLI arguments at startup. Use at agent startup to
|
|
6
|
-
fail fast with structured error instead of proceeding with missing context.
|
|
7
|
-
user-invocable: false
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# Input Validation
|
|
11
|
-
|
|
12
|
-
Validate all required inputs before doing any work. Fail fast with a structured error -- never attempt partial work with missing context.
|
|
13
|
-
|
|
14
|
-
## Process
|
|
15
|
-
|
|
16
|
-
At agent startup, before any implementation:
|
|
17
|
-
|
|
18
|
-
1. **List required inputs** -- files, env vars, CLI args, state files
|
|
19
|
-
2. **Check each input exists** -- use tool calls, not assumptions
|
|
20
|
-
3. **Collect all missing inputs** -- do not stop at the first missing item
|
|
21
|
-
4. **If any missing: return structured error immediately**
|
|
22
|
-
|
|
23
|
-
## Structured Error Format
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
AGENT RESULT: INPUT VALIDATION FAILED
|
|
27
|
-
|
|
28
|
-
Missing:
|
|
29
|
-
- [input 1] -- [what it is, where it should come from]
|
|
30
|
-
- [input 2] -- [what it is, where it should come from]
|
|
31
|
-
|
|
32
|
-
Expected from: [source -- orchestrator spawn prompt, user environment, prior agent output]
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
## Validation Checks by Type
|
|
36
|
-
|
|
37
|
-
| Input Type | How to Check | Example |
|
|
38
|
-
|-----------|-------------|---------|
|
|
39
|
-
| File path | `test -f "path"` or Read tool | PLAN.md, STATE.md, config.json |
|
|
40
|
-
| Directory | `test -d "path"` | .planning/, templates/ |
|
|
41
|
-
| Env variable | `echo "$VAR"` or `test -n "$VAR"` | GITHUB_TOKEN, NODE_ENV |
|
|
42
|
-
| CLI argument | Check prompt context for required fields | Phase number, plan number |
|
|
43
|
-
| Prior output | Check expected file or git commit exists | SUMMARY.md from previous plan |
|
|
44
|
-
|
|
45
|
-
## Rules
|
|
46
|
-
|
|
47
|
-
- **Check ALL inputs before reporting** -- collect the complete list of missing items
|
|
48
|
-
- **Do NOT attempt partial work** -- if inputs are missing, the output will be wrong
|
|
49
|
-
- **Do NOT guess missing values** -- return the error and let the orchestrator fix it
|
|
50
|
-
- **Include the source** -- tell the user where the missing input should come from
|
|
51
|
-
- **This is a hard gate** -- no workarounds, no "I'll proceed without it"
|
|
@@ -1,75 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: memory-management
|
|
3
|
-
description: >-
|
|
4
|
-
Pattern and error persistence across sessions. Defines what to persist, where
|
|
5
|
-
to store it, and when to capture. Use when encountering recurring patterns,
|
|
6
|
-
solving non-trivial problems, making architectural decisions, or discovering
|
|
7
|
-
environment-specific behaviors.
|
|
8
|
-
---
|
|
9
|
-
|
|
10
|
-
# Memory Management
|
|
11
|
-
|
|
12
|
-
Context dies with each session. Patterns discovered but not saved are patterns lost.
|
|
13
|
-
|
|
14
|
-
## What to Persist
|
|
15
|
-
|
|
16
|
-
| Trigger | Threshold | What to Save |
|
|
17
|
-
|---------|-----------|-------------|
|
|
18
|
-
| Same error encountered | 2+ occurrences | Error pattern, root cause, fix |
|
|
19
|
-
| Same debugging path followed | 2+ times | The shortcut or solution |
|
|
20
|
-
| Architectural decision made | Once (if significant) | Decision, rationale, alternatives rejected |
|
|
21
|
-
| Non-obvious convention discovered | Once | The convention and where it applies |
|
|
22
|
-
| Workaround for tooling/framework quirk | Once | The quirk and the workaround |
|
|
23
|
-
| Project-specific pattern confirmed | 2+ uses | The pattern and when to apply it |
|
|
24
|
-
|
|
25
|
-
**Do NOT save:** Session-specific context, information already in CLAUDE.md, speculative conclusions, temporary workarounds, or obvious patterns.
|
|
26
|
-
|
|
27
|
-
## Where to Store
|
|
28
|
-
|
|
29
|
-
| Location | Content | When Loaded |
|
|
30
|
-
|----------|---------|-------------|
|
|
31
|
-
| STATE.md | Project-level decisions, blockers, metrics | Every MAXSIM session |
|
|
32
|
-
| CLAUDE.md | Project conventions, build commands, architecture | Every Claude Code session |
|
|
33
|
-
| LESSONS.md | Cross-session codebase-specific lessons | MAXSIM execution startup |
|
|
34
|
-
|
|
35
|
-
### Entry Format
|
|
36
|
-
|
|
37
|
-
```markdown
|
|
38
|
-
- [YYYY-MM-DD] [{phase}-{plan}] {actionable lesson}
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
For LESSONS.md entries. For STATE.md decisions, use the `state add-decision` tool.
|
|
42
|
-
|
|
43
|
-
## When to Persist
|
|
44
|
-
|
|
45
|
-
Persist at natural breakpoints:
|
|
46
|
-
|
|
47
|
-
- After resolving a non-trivial bug (save error pattern + fix)
|
|
48
|
-
- After making an architectural decision (save decision + rationale)
|
|
49
|
-
- After discovering a recurring pattern (save pattern + when to apply)
|
|
50
|
-
- At checkpoints (save current understanding before context resets)
|
|
51
|
-
- At session end (review what was learned, save anything missed)
|
|
52
|
-
|
|
53
|
-
## Error Escalation
|
|
54
|
-
|
|
55
|
-
```
|
|
56
|
-
Error seen once -- Note it, move on
|
|
57
|
-
Error seen twice -- Save to LESSONS.md with pattern and fix
|
|
58
|
-
Error seen 3+ times -- Save AND add to CLAUDE.md for immediate visibility
|
|
59
|
-
```
|
|
60
|
-
|
|
61
|
-
## Process
|
|
62
|
-
|
|
63
|
-
1. **DETECT** -- Recognize a save trigger from the table above
|
|
64
|
-
2. **CHECK** -- Read existing memory files before writing to avoid duplicates
|
|
65
|
-
3. **WRITE** -- Add the entry to the appropriate file
|
|
66
|
-
4. **VERIFY** -- Re-read the file to confirm the entry was written correctly and is actionable
|
|
67
|
-
|
|
68
|
-
## Common Pitfalls
|
|
69
|
-
|
|
70
|
-
- Encountering the same error a second time without saving it
|
|
71
|
-
- Making the same architectural decision you made in a previous session
|
|
72
|
-
- Debugging a problem you already solved before
|
|
73
|
-
- Leaving a session without updating memory for patterns discovered
|
|
74
|
-
|
|
75
|
-
If any of these occur: stop, write the memory entry now, then continue.
|
|
@@ -1,137 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: research-methodology
|
|
3
|
-
description: >-
|
|
4
|
-
Research process with tool priorities, confidence levels, and source evaluation.
|
|
5
|
-
Defines how to investigate technical domains, evaluate sources, and structure
|
|
6
|
-
findings with confidence tags. Use when researching libraries, APIs, architecture
|
|
7
|
-
patterns, or any domain requiring external knowledge gathering.
|
|
8
|
-
user-invocable: false
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
# Research Methodology
|
|
12
|
-
|
|
13
|
-
Systematic process for investigating technical domains and producing structured findings with confidence levels.
|
|
14
|
-
|
|
15
|
-
## Research Process
|
|
16
|
-
|
|
17
|
-
### 1. Define Questions
|
|
18
|
-
|
|
19
|
-
Before researching, write explicit questions:
|
|
20
|
-
|
|
21
|
-
- What specific information do I need?
|
|
22
|
-
- What decisions will this research inform?
|
|
23
|
-
- What would change my approach if I learned X vs Y?
|
|
24
|
-
|
|
25
|
-
Avoid open-ended exploration. Each question should have a clear "answered" state.
|
|
26
|
-
|
|
27
|
-
### 2. Identify Sources
|
|
28
|
-
|
|
29
|
-
Use this priority order for source selection:
|
|
30
|
-
|
|
31
|
-
| Priority | Source Type | Tool | Best For |
|
|
32
|
-
|----------|-----------|------|----------|
|
|
33
|
-
| 1 | Official documentation | WebFetch | API specs, config options, platform features |
|
|
34
|
-
| 2 | Codebase (existing code) | Grep, Glob, Read | Current patterns, conventions, dependencies |
|
|
35
|
-
| 3 | CLI tool help | Bash (`--help`, `--version`) | Tool capabilities, available flags |
|
|
36
|
-
| 4 | Package registries | WebFetch (npm, PyPI) | Version info, dependency trees |
|
|
37
|
-
| 5 | Reputable technical blogs | WebFetch | Architecture patterns, best practices |
|
|
38
|
-
| 6 | Community forums | WebFetch | Edge cases, workarounds, known issues |
|
|
39
|
-
|
|
40
|
-
### 3. Evaluate Sources
|
|
41
|
-
|
|
42
|
-
Not all sources are equal. Tag each finding with a confidence level:
|
|
43
|
-
|
|
44
|
-
| Level | Criteria | Examples |
|
|
45
|
-
|-------|----------|---------|
|
|
46
|
-
| **HIGH** | Official docs, verified by tool output, multiple primary sources agree | Platform docs, API reference, confirmed by running code |
|
|
47
|
-
| **MEDIUM** | Reputable blogs, community consensus, single primary source | Well-known tech blogs, Stack Overflow accepted answers, conference talks |
|
|
48
|
-
| **LOW** | Single non-official source, outdated (>1 year), unverified claims | Personal blogs, forum posts, AI-generated content without verification |
|
|
49
|
-
|
|
50
|
-
**Source evaluation checklist:**
|
|
51
|
-
- Is this a primary source (official docs) or secondary (blog post)?
|
|
52
|
-
- When was it published or last updated?
|
|
53
|
-
- Does it match what I see in the actual codebase/tool?
|
|
54
|
-
- Do multiple independent sources agree?
|
|
55
|
-
|
|
56
|
-
### 4. Cross-Reference Claims
|
|
57
|
-
|
|
58
|
-
For any finding that influences architecture or design:
|
|
59
|
-
|
|
60
|
-
- Find at least 2 independent sources
|
|
61
|
-
- Verify against actual tool behavior (run a command, read a config)
|
|
62
|
-
- Note when sources disagree and which you trust more
|
|
63
|
-
- Mark single-source findings as LOW confidence
|
|
64
|
-
|
|
65
|
-
### 5. Structure Output
|
|
66
|
-
|
|
67
|
-
Research findings follow this format:
|
|
68
|
-
|
|
69
|
-
```markdown
|
|
70
|
-
## Finding: [Title]
|
|
71
|
-
|
|
72
|
-
**Confidence:** HIGH | MEDIUM | LOW
|
|
73
|
-
**Sources:** [list of sources with links]
|
|
74
|
-
|
|
75
|
-
[Finding description -- what was learned]
|
|
76
|
-
|
|
77
|
-
**Implications:** [How this affects our decisions]
|
|
78
|
-
**Open questions:** [What remains unclear]
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
## Research Output Template
|
|
82
|
-
|
|
83
|
-
```markdown
|
|
84
|
-
# [Domain] Research
|
|
85
|
-
|
|
86
|
-
**Researched:** [date]
|
|
87
|
-
**Confidence:** [overall confidence level]
|
|
88
|
-
|
|
89
|
-
## Key Findings
|
|
90
|
-
- [Finding 1] (HIGH confidence)
|
|
91
|
-
- [Finding 2] (MEDIUM confidence)
|
|
92
|
-
|
|
93
|
-
## Standard Stack
|
|
94
|
-
| Component | Choice | Why |
|
|
95
|
-
|-----------|--------|-----|
|
|
96
|
-
| [area] | [choice] | [reason] |
|
|
97
|
-
|
|
98
|
-
## Don't Hand-Roll
|
|
99
|
-
| Problem | Don't Build | Use Instead |
|
|
100
|
-
|---------|-------------|-------------|
|
|
101
|
-
| [problem] | [custom solution] | [existing solution] |
|
|
102
|
-
|
|
103
|
-
## Common Pitfalls
|
|
104
|
-
### Pitfall 1: [name]
|
|
105
|
-
**What goes wrong:** [description]
|
|
106
|
-
**How to avoid:** [recommendation]
|
|
107
|
-
|
|
108
|
-
## Open Questions
|
|
109
|
-
- [Unanswered questions for future investigation]
|
|
110
|
-
|
|
111
|
-
## Sources
|
|
112
|
-
### Primary (HIGH confidence)
|
|
113
|
-
- [source with link]
|
|
114
|
-
### Secondary (MEDIUM confidence)
|
|
115
|
-
- [source with link]
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
## Common Research Mistakes
|
|
119
|
-
|
|
120
|
-
| Mistake | Why It's Wrong | Do Instead |
|
|
121
|
-
|---------|---------------|------------|
|
|
122
|
-
| Using only AI knowledge | May be outdated or hallucinated | Fetch actual docs with WebFetch |
|
|
123
|
-
| Trusting a single blog post | Could be wrong, outdated, or opinionated | Cross-reference with official docs |
|
|
124
|
-
| Skipping version checks | APIs change between versions | Verify against the actual version in use |
|
|
125
|
-
| Assuming current codebase is correct | Code may have bugs or outdated patterns | Verify patterns against official docs |
|
|
126
|
-
| Not recording sources | Cannot verify or update findings later | Always include links and dates |
|
|
127
|
-
| Research without questions | Leads to unfocused exploration | Define questions first, research to answer them |
|
|
128
|
-
|
|
129
|
-
## Time Boxing
|
|
130
|
-
|
|
131
|
-
Research is a means to an end, not the end itself:
|
|
132
|
-
|
|
133
|
-
- **Quick lookup** (5 min): Single question, check official docs, done
|
|
134
|
-
- **Standard research** (30 min): Multiple questions, cross-reference, structured output
|
|
135
|
-
- **Deep investigation** (60 min): Architecture decision, multiple domains, full template
|
|
136
|
-
|
|
137
|
-
If you cannot answer a question within the time box, document it as an open question and move on.
|