harness-everything 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +2 -0
- package/BENCHMARK_SOP.md +62 -0
- package/CHANGELOG.md +107 -0
- package/Dockerfile +18 -0
- package/LICENSE +201 -0
- package/README.md +197 -0
- package/VERIFICATION.md +347 -0
- package/bin/cli.js +97 -0
- package/build-multi-agent-system/AGENTS.md +50 -0
- package/build-multi-agent-system/README.md +63 -0
- package/build-multi-agent-system/SKILL.md +68 -0
- package/create-agent-launcher/SKILL.md +48 -0
- package/create-agent-launcher/examples/csharp-monorepo.md +123 -0
- package/create-agent-launcher/examples/typescript-cli.md +126 -0
- package/create-agent-launcher/guidelines/platform-claude.md +77 -0
- package/create-agent-launcher/guidelines/platform-codex.md +146 -0
- package/create-agent-launcher/guidelines/platform-copilot.md +74 -0
- package/create-agent-launcher/guidelines/platform-gemini.md +101 -0
- package/create-agent-launcher/guidelines/role-capabilities.md +108 -0
- package/create-agent-launcher/templates/README.md +17 -0
- package/create-agent-launcher/templates/agent-launcher.md +68 -0
- package/create-agent-launcher/templates/backend-developer-csharp.md +56 -0
- package/create-agent-launcher/templates/backend-developer-polyglot.md +62 -0
- package/create-agent-launcher/templates/backend-developer-ts.md +57 -0
- package/create-agent-launcher/templates/memory-keeper.md +37 -0
- package/create-agent-launcher/templates/requirement-analyzer.md +66 -0
- package/create-agent-launcher/templates/specialist-agent.md +34 -0
- package/create-agent-launcher/templates/task-verifier.md +56 -0
- package/create-agent-launcher/templates/tool-maker.md +33 -0
- package/create-agent-launcher/workflows/01-init.md +22 -0
- package/create-agent-launcher/workflows/02-analysis.md +26 -0
- package/create-agent-launcher/workflows/03-generation.md +29 -0
- package/create-agent-launcher/workflows/04-launcher.md +20 -0
- package/docker-verify.sh +266 -0
- package/docs/architecture.md +95 -0
- package/docs/philosophy.md +45 -0
- package/docs/reflection.md +34 -0
- package/docs/routing.md +45 -0
- package/docs/workflows/build-multi-agent-system.md +62 -0
- package/docs/workflows/create-agent-launcher.md +62 -0
- package/docs/workflows/environment-detection.md +63 -0
- package/docs/workflows/eval-harness.md +57 -0
- package/docs/workflows/fable-discipline.md +59 -0
- package/docs/workflows/fable-mode.md +32 -0
- package/docs/workflows/git-commit.md +62 -0
- package/docs/workflows/grill-me.md +62 -0
- package/docs/workflows/grill-with-docs.md +62 -0
- package/docs/workflows/harness-everything.md +92 -0
- package/docs/workflows/improve-codebase-architecture.md +60 -0
- package/docs/workflows/install-cognitive-os.md +60 -0
- package/docs/workflows/repo-docs.md +59 -0
- package/docs/workflows/rewrite-commits.md +60 -0
- package/docs/workflows/security-review.md +58 -0
- package/docs/workflows/self-evolve.md +59 -0
- package/docs/workflows/skill-creator.md +75 -0
- package/docs/workflows/skill-style.md +64 -0
- package/docs/workflows/tdd.md +39 -0
- package/docs/workflows/todo-driven-workflow.md +36 -0
- package/docs/workflows/using-git-worktrees.md +63 -0
- package/docs/workflows/verification-loop.md +69 -0
- package/docs/workflows/verify-before-claim.md +60 -0
- package/docs/workflows/zoom-out.md +62 -0
- package/environment-detection/SKILL.md +77 -0
- package/environment-detection/scripts/preflight.js +93 -0
- package/eval-framework/behavioral-test.js +105 -0
- package/eval-framework/cases/case1.json +5 -0
- package/eval-framework/cases/case2.json +5 -0
- package/eval-framework/cases/case3.json +5 -0
- package/eval-framework/cases/case4-zh-tier2.json +5 -0
- package/eval-framework/cases/case5-zh-tier3.json +5 -0
- package/eval-framework/mechanism-test.js +251 -0
- package/eval-framework/runner.js +56 -0
- package/eval-harness/SKILL.md +59 -0
- package/eval-harness/scripts/evaluate.js +61 -0
- package/fable-discipline/SKILL.md +38 -0
- package/fable-mode/CONTRACT-FORMAT.md +51 -0
- package/fable-mode/SKILL.md +51 -0
- package/fable-mode/agents/fable-orchestrator.md +92 -0
- package/fable-mode/agents/fable-verifier.md +32 -0
- package/fable-mode/agents/fable-worker-haiku.md +48 -0
- package/fable-mode/agents/fable-worker-sonnet.md +49 -0
- package/fable-mode/execution-guardrails/SKILL.md +87 -0
- package/fable-mode/fable-haiku/SKILL.md +48 -0
- package/git-commit/SKILL.md +55 -0
- package/git-commit/guides/ANGULAR_STYLE.md +61 -0
- package/git-commit/guides/COMMIT_GENERATION.md +24 -0
- package/git-commit/guides/LANGUAGE_DETECTION.md +16 -0
- package/git-commit/guides/MAIN_REPO.md +15 -0
- package/git-commit/guides/SUBMODULES.md +27 -0
- package/grill-me/SKILL.md +36 -0
- package/grill-with-docs/ADR-FORMAT.md +47 -0
- package/grill-with-docs/CONTEXT-FORMAT.md +63 -0
- package/grill-with-docs/SKILL.md +99 -0
- package/harness-everything/SKILL.md +141 -0
- package/harness-everything/examples/README.md +9 -0
- package/harness-everything/examples/todo-workflow.md +22 -0
- package/harness-everything/scripts/bootstrap.js +140 -0
- package/harness-everything/scripts/self-heal.js +189 -0
- package/harness-everything/scripts/tier-router.js +219 -0
- package/harness-everything/scripts/todo-cli.js +157 -0
- package/harness-everything/scripts/verify-gate.js +31 -0
- package/hooks/hooks.json +155 -0
- package/hooks/scripts/atomic-commit-check.js +68 -0
- package/hooks/scripts/boundary-guard.js +55 -0
- package/hooks/scripts/context-compact.js +114 -0
- package/hooks/scripts/contract-test.js +79 -0
- package/hooks/scripts/depth-guard.js +65 -0
- package/hooks/scripts/lib/harness-state.js +202 -0
- package/hooks/scripts/lib/platforms/claude.js +42 -0
- package/hooks/scripts/lib/platforms/codex.js +46 -0
- package/hooks/scripts/lib/platforms/continue.js +41 -0
- package/hooks/scripts/lib/platforms/copilot.js +41 -0
- package/hooks/scripts/lib/platforms/cursor.js +41 -0
- package/hooks/scripts/lib/platforms/hermes.js +32 -0
- package/hooks/scripts/lib/platforms/index.js +17 -0
- package/hooks/scripts/lib/platforms/worktrees.js +20 -0
- package/hooks/scripts/reset-circuit-breaker.js +30 -0
- package/hooks/scripts/rule-of-3-tracker.js +91 -0
- package/hooks/scripts/rule-of-3.js +176 -0
- package/hooks/scripts/state-persist.js +99 -0
- package/hooks/scripts/stop-gate.js +80 -0
- package/hooks/scripts/subagent-scope-guard.js +88 -0
- package/improve-codebase-architecture/SKILL.md +44 -0
- package/improve-codebase-architecture/guides/DEEPENING.md +37 -0
- package/improve-codebase-architecture/guides/HTML-REPORT.md +123 -0
- package/improve-codebase-architecture/guides/INTERFACE-DESIGN.md +44 -0
- package/improve-codebase-architecture/guides/LANGUAGE.md +53 -0
- package/install-cognitive-os/SKILL.md +95 -0
- package/package.json +22 -0
- package/repo-docs/SKILL.md +45 -0
- package/repo-docs/templates/agents-template.md +264 -0
- package/repo-docs/templates/knowledge-agents-template.md +50 -0
- package/repo-docs/templates/knowledge-readme-template.md +83 -0
- package/repo-docs/templates/manual-recon.md +117 -0
- package/repo-docs/templates/multi-skills-readme-template.md +72 -0
- package/repo-docs/templates/product-agents-template.md +78 -0
- package/repo-docs/templates/product-readme-template.md +95 -0
- package/repo-docs/templates/readme-template.md +136 -0
- package/repo-docs/templates/single-skill-readme-template.md +70 -0
- package/repo-docs/templates/skills-agents-template.md +60 -0
- package/rewrite-commits/SKILL.md +32 -0
- package/scripts/installer.js +649 -0
- package/scripts/lib/advisory-text.js +163 -0
- package/scripts/lib/claude-hooks.js +71 -0
- package/scripts/lib/gitignore.js +58 -0
- package/scripts/lib/manifest.js +82 -0
- package/scripts/lib/prompts.js +241 -0
- package/scripts/lib/skills.js +172 -0
- package/scripts/lib/workspace.js +28 -0
- package/security-review/SKILL.md +511 -0
- package/self-evolve/SKILL.md +54 -0
- package/self-evolve/scripts/persist-memory.js +40 -0
- package/self-evolve/scripts/self-regression.js +113 -0
- package/skill-creator/SKILL.md +91 -0
- package/skill-creator/references/quality-principles.md +81 -0
- package/skill-creator/references/testing-workflow.md +32 -0
- package/skill-style/SKILL.md +48 -0
- package/skill-style/STYLE.md +37 -0
- package/tdd/SKILL.md +53 -0
- package/tdd/guides/deep-modules.md +33 -0
- package/tdd/guides/interface-design.md +31 -0
- package/tdd/guides/mocking.md +59 -0
- package/tdd/guides/refactoring.md +10 -0
- package/tdd/guides/tests.md +61 -0
- package/todo-driven-workflow/SKILL.md +54 -0
- package/using-git-worktrees/SKILL.md +161 -0
- package/verification-loop/SKILL.md +138 -0
- package/verify-before-claim/SKILL.md +86 -0
- package/zoom-out/SKILL.md +90 -0
|
@@ -0,0 +1,264 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "agents-template"
|
|
3
|
+
description: "Canonical AGENTS.md template with archetype-aware section selection."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# AGENTS.md Template
|
|
7
|
+
|
|
8
|
+
Terse, directive. Every section should be machine-readable.
|
|
9
|
+
No filler. No prose padding. Commands must be exact and copy-pasteable.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Archetype-Aware Structure
|
|
14
|
+
|
|
15
|
+
The sections to include depend on the repository archetype (from Step 0 of the skill
|
|
16
|
+
workflow). For `code` repos, use the full template below. For other archetypes, replace
|
|
17
|
+
the **Commands** block with **Workflows & Commands** and use the relevant non-code
|
|
18
|
+
template at the end of this file.
|
|
19
|
+
|
|
20
|
+
| Archetype | Commands block | Extra sections |
|
|
21
|
+
|---|---|---|
|
|
22
|
+
| **`code`** | Full `## Commands` with setup/dev/test/lint/build | Architecture, Conventions, Do Not Edit, Gotchas |
|
|
23
|
+
| **`product`** | `## Development Commands` (Setup, Dev, Test, Build) | Tech Stack, Domain Knowledge Mapping, System Boundaries |
|
|
24
|
+
| **`single-skill`**| `## Commands` (Testing, Linting) | See [`skills-agents-template.md`](skills-agents-template.md) (Taxonomy, Extension Rules, Schema) |
|
|
25
|
+
| **`multi-skills`**| `## Commands` (Authoring, Linking, Linting) | See [`skills-agents-template.md`](skills-agents-template.md) (Taxonomy, Extension Rules, Schema) |
|
|
26
|
+
| **`docs/courseware`**| `## Editing Rules & Formatting` | See [`knowledge-agents-template.md`](knowledge-agents-template.md) (Agentic Workflows, Task States) |
|
|
27
|
+
| **`docs`** | `## Workflows & Commands` (build, preview, publish) | Page Tree, Authoring Rules, Style Conventions |
|
|
28
|
+
| **`hybrid`** | Combine applicable blocks | Combine relevant extra sections |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## Code Archetype Template
|
|
33
|
+
|
|
34
|
+
```markdown
|
|
35
|
+
# {project_name}
|
|
36
|
+
|
|
37
|
+
{One tight paragraph: what it is, primary language/framework, notable architecture
|
|
38
|
+
decisions. No marketing language.}
|
|
39
|
+
|
|
40
|
+
## Commands
|
|
41
|
+
|
|
42
|
+
### Setup
|
|
43
|
+
```bash
|
|
44
|
+
{install command} # first-time setup
|
|
45
|
+
{env setup command} # e.g., cp .env.example .env
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Development
|
|
49
|
+
```bash
|
|
50
|
+
{dev server command} # starts local dev environment
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Testing
|
|
54
|
+
```bash
|
|
55
|
+
{run all tests}
|
|
56
|
+
{run single test file} # e.g., pnpm test src/foo.test.ts
|
|
57
|
+
{run with coverage}
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### Lint & Format
|
|
61
|
+
```bash
|
|
62
|
+
{lint command}
|
|
63
|
+
{format command} # auto-fix
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Build
|
|
67
|
+
```bash
|
|
68
|
+
{build command}
|
|
69
|
+
{build output location} # e.g., outputs to dist/
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Architecture
|
|
73
|
+
|
|
74
|
+
```
|
|
75
|
+
{key directories only}
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
| Directory | Purpose |
|
|
79
|
+
|---|---|
|
|
80
|
+
| `src/` | {description} |
|
|
81
|
+
| `tests/` | {description} |
|
|
82
|
+
| `scripts/` | {description} |
|
|
83
|
+
| ... | ... |
|
|
84
|
+
|
|
85
|
+
{2–3 sentences on any non-obvious architecture decisions an AI should know about.}
|
|
86
|
+
|
|
87
|
+
## Conventions
|
|
88
|
+
|
|
89
|
+
- **Language/runtime**: {e.g., TypeScript strict mode, Python 3.11+}
|
|
90
|
+
- **Imports**: {e.g., absolute imports from `src/`, no relative `../..`}
|
|
91
|
+
- **Naming**: {e.g., camelCase functions, PascalCase components, kebab-case files}
|
|
92
|
+
- **Style**: {link to or summarize eslint/ruff/prettier config highlights}
|
|
93
|
+
- **Tests**: {e.g., co-located `.test.ts` files, fixtures in `tests/fixtures/`}
|
|
94
|
+
- **Env vars**: {list required env vars and where to get them}
|
|
95
|
+
|
|
96
|
+
## Do Not Edit
|
|
97
|
+
|
|
98
|
+
- `{generated file or dir}` — auto-generated, do not edit manually
|
|
99
|
+
- `{lock file}` — managed by {tool}
|
|
100
|
+
- `{vendor or build dir}` — output only
|
|
101
|
+
|
|
102
|
+
## Gotchas
|
|
103
|
+
|
|
104
|
+
- {Any non-obvious behaviour that would trip up an AI agent}
|
|
105
|
+
- {e.g., "pnpm only — npm and yarn will break workspace resolution"}
|
|
106
|
+
- {e.g., "Tests require a running Postgres instance on port 5432"}
|
|
107
|
+
- {e.g., "The `src/generated/` directory is committed but auto-generated by `pnpm codegen`"}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Non-Code Archetype Templates
|
|
113
|
+
|
|
114
|
+
Use the relevant block below as a starting point for non-`code` repos.
|
|
115
|
+
|
|
116
|
+
### Skills Library
|
|
117
|
+
|
|
118
|
+
```markdown
|
|
119
|
+
# {project_name}
|
|
120
|
+
|
|
121
|
+
{One tight paragraph: what this collection is, how many skills it contains, and which
|
|
122
|
+
AI platforms it targets.}
|
|
123
|
+
|
|
124
|
+
## Workflows & Commands
|
|
125
|
+
|
|
126
|
+
### Add a skill
|
|
127
|
+
```bash
|
|
128
|
+
# Create a new SKILL.md at the correct path
|
|
129
|
+
mkdir -p skills/{category}/{skill-name}
|
|
130
|
+
# Then create skills/{category}/{skill-name}/SKILL.md with required frontmatter
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Link skills (if applicable)
|
|
134
|
+
```bash
|
|
135
|
+
{link command, e.g., bash scripts/link-skills.sh}
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### Validate frontmatter
|
|
139
|
+
```bash
|
|
140
|
+
{lint command, or: manually verify name, description fields are present}
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
## Skills Inventory
|
|
144
|
+
|
|
145
|
+
| Category | Skill | Description |
|
|
146
|
+
|---|---|---|
|
|
147
|
+
| `{category}` | `{name}` | {description} |
|
|
148
|
+
|
|
149
|
+
## Authoring Rules
|
|
150
|
+
|
|
151
|
+
- **Frontmatter**: Every `SKILL.md` must have `name` and `description` fields.
|
|
152
|
+
- **Trigger phrases**: Write `description` to match how a user would ask for the skill.
|
|
153
|
+
- **File placement**: `skills/{category}/{skill-name}/SKILL.md`
|
|
154
|
+
- **Naming**: `{skill-name}` is kebab-case; `{category}` is kebab-case.
|
|
155
|
+
|
|
156
|
+
## Do Not Edit
|
|
157
|
+
|
|
158
|
+
- {generated index files, if any}
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
---
|
|
162
|
+
|
|
163
|
+
### Courseware
|
|
164
|
+
|
|
165
|
+
```markdown
|
|
166
|
+
# {project_name}
|
|
167
|
+
|
|
168
|
+
{One tight paragraph: what this course teaches, primary audience, and tech stack.}
|
|
169
|
+
|
|
170
|
+
## Workflows & Commands
|
|
171
|
+
|
|
172
|
+
### Scaffold a new exercise
|
|
173
|
+
```bash
|
|
174
|
+
mkdir -p exercises/{XX}-{section-name}/{XX}.{YY}-{exercise-name}/{explainer,problem,solution}
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
### Lint exercises
|
|
178
|
+
```bash
|
|
179
|
+
{lint command, e.g., pnpm ai-hero-cli internal lint}
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
### Commit with history preservation
|
|
183
|
+
```bash
|
|
184
|
+
git mv exercises/{old-path} exercises/{new-path} # use git mv, never plain mv
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
## Exercise Structure
|
|
188
|
+
|
|
189
|
+
```
|
|
190
|
+
exercises/
|
|
191
|
+
{XX}-{section-name}/
|
|
192
|
+
{XX}.{YY}-{exercise-name}/
|
|
193
|
+
explainer/ # conceptual material — no TODOs
|
|
194
|
+
problem/ # student workspace with TODOs
|
|
195
|
+
solution/ # reference implementation
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
## Naming Conventions
|
|
199
|
+
|
|
200
|
+
- Sections: `XX-section-name/` (two-digit zero-padded prefix, dash-case)
|
|
201
|
+
- Exercises: `XX.YY-exercise-name/` (section.exercise prefix, dash-case)
|
|
202
|
+
- Each subfolder must contain a non-empty `readme.md`
|
|
203
|
+
|
|
204
|
+
## Lint Rules Summary
|
|
205
|
+
|
|
206
|
+
- Each exercise needs at least one of `problem/`, `explainer/`, or `solution/`
|
|
207
|
+
- `readme.md` must exist and be non-empty in each subfolder
|
|
208
|
+
- No `.gitkeep` files; no broken links in readmes
|
|
209
|
+
|
|
210
|
+
## Do Not Edit
|
|
211
|
+
|
|
212
|
+
- {generated files, if any}
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
---
|
|
216
|
+
|
|
217
|
+
### Documentation Site
|
|
218
|
+
|
|
219
|
+
```markdown
|
|
220
|
+
# {project_name}
|
|
221
|
+
|
|
222
|
+
{One tight paragraph: what this docs site covers, the tool used (GitBook, MkDocs, etc.),
|
|
223
|
+
and where the live site is published.}
|
|
224
|
+
|
|
225
|
+
## Workflows & Commands
|
|
226
|
+
|
|
227
|
+
### Preview locally
|
|
228
|
+
```bash
|
|
229
|
+
{preview command, e.g., gitbook serve, mkdocs serve}
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Build / publish
|
|
233
|
+
```bash
|
|
234
|
+
{build or deploy command}
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
## Documentation Structure
|
|
238
|
+
|
|
239
|
+
```
|
|
240
|
+
{abbreviated page tree}
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
## Authoring Rules
|
|
244
|
+
|
|
245
|
+
- {naming conventions for .md files}
|
|
246
|
+
- {where to place images/assets}
|
|
247
|
+
- {required frontmatter, if any}
|
|
248
|
+
- {style guide highlights}
|
|
249
|
+
|
|
250
|
+
## Do Not Edit
|
|
251
|
+
|
|
252
|
+
- {generated nav files, build output dirs}
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## Style rules for AGENTS.md
|
|
258
|
+
|
|
259
|
+
- **Imperative** sentences: "Run X to do Y" not "You can run X..."
|
|
260
|
+
- **No intros or sign-offs** — agents don't need greetings
|
|
261
|
+
- All commands must be runnable as-is in a terminal (no pseudocode)
|
|
262
|
+
- If a command varies by OS, show both: `# macOS / Linux` and `# Windows`
|
|
263
|
+
- Be explicit about what NOT to do — agents benefit from guardrails
|
|
264
|
+
- List env vars agents will need; never embed secrets
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "knowledge-agents-template"
|
|
3
|
+
description: "Dynamic AGENTS.md template for documentation, knowledge bases, and courseware. Uses conditional {{IF feature}} blocks based on detected capabilities to provide either basic editing rules or strict agentic workflows."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# {Project Name} - AI Authoring & Operations Guide
|
|
7
|
+
|
|
8
|
+
> This document serves as the machine-readable instruction manual for AI agents operating within this documentation/knowledge repository.
|
|
9
|
+
|
|
10
|
+
## Editing Rules & Formatting
|
|
11
|
+
|
|
12
|
+
When tasked with generating or modifying content in this repository, strictly adhere to the following rules:
|
|
13
|
+
|
|
14
|
+
- **Style conventions**: {e.g., Use H2 and H3 for sub-sections. Do not use H1 except for the main title.}
|
|
15
|
+
- **Language & Tone**: {e.g., Professional and academic. If the repo is multi-lingual, ensure you modify the correct file.}
|
|
16
|
+
- **Structural Integrity**: This repository relies on a specific sequence (e.g., numbered prefixes like `01-`, `02-`). **Do not rename or reorder files** unless explicitly instructed to reorganize the curriculum.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
{{IF is_agentic_workspace}}
|
|
21
|
+
## Agentic Operations & Workflows
|
|
22
|
+
|
|
23
|
+
This repository is an active Agentic Workspace. You must interact with the established agent ecosystem correctly.
|
|
24
|
+
|
|
25
|
+
### Workflow & Task Management
|
|
26
|
+
- **Task Intake**: New tasks are generally found in `tasks/backlog.json` or as markdown specs in `tasks/specs/`.
|
|
27
|
+
- **State Management**: When beginning a task, move it or track its state in the `tasks/active/` directory. Upon completion, log the result in `tasks/completed/`.
|
|
28
|
+
- **Logging**: All major generation runs must be documented. Create a timestamped folder in `logs/runs/{timestamp}/` detailing the input prompt, token usage, and output summary.
|
|
29
|
+
|
|
30
|
+
### Inter-Agent Collaboration
|
|
31
|
+
Do not attempt to perform tasks assigned to resident sub-agents.
|
|
32
|
+
- If content needs verification, defer to the existing `quality-validator.agent.md` or `fact-check-scout.agent.md`.
|
|
33
|
+
- Review the `.github/agents/` folder to understand your peers' capabilities before executing complex multi-step generations.
|
|
34
|
+
{{ENDIF}}
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
{{IF has_task_tracking}}
|
|
39
|
+
## Status Updates
|
|
40
|
+
|
|
41
|
+
If you make significant additions to the knowledge base:
|
|
42
|
+
- You **MUST** update `STATUS.md` or the corresponding `backlog` file to reflect the completion of the topic.
|
|
43
|
+
{{ENDIF}}
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Do Not Edit
|
|
48
|
+
|
|
49
|
+
- `{Generated index files, e.g., _sidebar.md}` (Managed by {tool, e.g., Docsify})
|
|
50
|
+
- `logs/runs/` (Append-only. Never modify historical logs.)
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "knowledge-readme-template"
|
|
3
|
+
description: "Dynamic README template for documentation, knowledge bases, and courseware. Uses conditional {{IF feature}} blocks based on detected repository capabilities (e.g., learning paths, agentic workspaces)."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# {Project Name}
|
|
7
|
+
|
|
8
|
+
> {One-line description summarizing the core subject or purpose of this knowledge base.}
|
|
9
|
+
|
|
10
|
+
<!-- Optional: badges for version, license, or status -->
|
|
11
|
+
[](LICENSE)
|
|
12
|
+
|
|
13
|
+
## Overview & Scope
|
|
14
|
+
|
|
15
|
+
{2–4 sentences explaining what this repository covers, who it is for, and how the information is structured. Be specific about the domain (e.g., "This repository contains the architectural analysis of OpenClaw...").}
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
{{IF has_learning_path}}
|
|
20
|
+
## Start Here / Learning Path
|
|
21
|
+
|
|
22
|
+
{Provide a brief guide on how a reader should navigate this repository based on the detected `roadmap.md`, `study-guide.md`, or sequential file naming.}
|
|
23
|
+
|
|
24
|
+
- **[Step 1 Title](./path/to/file.md)**: {Brief description}
|
|
25
|
+
- **[Step 2 Title](./path/to/file.md)**: {Brief description}
|
|
26
|
+
{{ENDIF}}
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## Knowledge Directory
|
|
31
|
+
|
|
32
|
+
{Organize the discovered markdown directories into thematic groups. Do not just print a raw file tree. Group them logically.}
|
|
33
|
+
|
|
34
|
+
### 📂 {Thematic Group 1: e.g., Core Subsystems}
|
|
35
|
+
{1 sentence describing what's in this group.}
|
|
36
|
+
- [`{dir_name}/`](./path/) - {Brief description based on contents}
|
|
37
|
+
- [`{dir_name}/`](./path/) - {Brief description based on contents}
|
|
38
|
+
|
|
39
|
+
### 📚 {Thematic Group 2: e.g., Reference Materials}
|
|
40
|
+
{1 sentence describing what's in this group.}
|
|
41
|
+
- [`{dir_name}/`](./path/) - {Brief description}
|
|
42
|
+
|
|
43
|
+
---
|
|
44
|
+
|
|
45
|
+
{{IF is_agentic_workspace}}
|
|
46
|
+
## AI Agent Workspace
|
|
47
|
+
|
|
48
|
+
This repository is an **Agentic Workspace**. It is actively managed and interacted with by AI agents, not just human readers.
|
|
49
|
+
|
|
50
|
+
### Active Agents
|
|
51
|
+
{List the detected agents from `.github/agents/` or `AGENTS.md`.}
|
|
52
|
+
- **`{Agent Name}`**: {Briefly describe what this agent does based on its file name/content.}
|
|
53
|
+
|
|
54
|
+
### Agent Workflows
|
|
55
|
+
{Briefly explain how humans interact with the agents in this repo. E.g., "Add a task to `tasks/backlog.json` and the Orchestrator will assign it to a sub-agent. Check `logs/` for execution results."}
|
|
56
|
+
{{ENDIF}}
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
{{IF has_task_tracking}}
|
|
61
|
+
## Project Status & Tasks
|
|
62
|
+
|
|
63
|
+
{Describe how progress is tracked in this repository based on `STATUS.md`, `tasks/`, or backlog files.}
|
|
64
|
+
|
|
65
|
+
- **Current Status**: {Extract key point from STATUS.md if available, else omit}
|
|
66
|
+
- **Task Board**: Found in [`tasks/`](./tasks/).
|
|
67
|
+
{{ENDIF}}
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
|
|
71
|
+
{{PRESERVED_HUMAN_CONTENT}}
|
|
72
|
+
<!-- AI AGENT INSTRUCTION: If the original README contained domain-specific teaching materials, tutorials, long-form explanations, or extensive deep-dive sections (e.g., "Performance vs Scalability", "System Architecture", etc.), they MUST be preserved here. Do not discard instructional prose! -->
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## Contributing
|
|
77
|
+
|
|
78
|
+
Want to contribute to this knowledge base?
|
|
79
|
+
{If `is_agentic_workspace` is true, remind users to check `AGENTS.md` before making massive structural changes. If false, just provide a standard PR message.}
|
|
80
|
+
|
|
81
|
+
## License
|
|
82
|
+
|
|
83
|
+
{License name} — see [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "manual-recon"
|
|
3
|
+
description: "Bash commands for manual repository reconnaissance when python scripts are unavailable."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Manual Recon Steps
|
|
7
|
+
|
|
8
|
+
Use these bash commands when `recon.py` is not available.
|
|
9
|
+
Run each block and collect the output before generating docs.
|
|
10
|
+
|
|
11
|
+
## 1. Directory tree
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# macOS / Linux (depth 3, ignoring noise)
|
|
15
|
+
find . -maxdepth 3 \
|
|
16
|
+
-not -path '*/node_modules/*' \
|
|
17
|
+
-not -path '*/.git/*' \
|
|
18
|
+
-not -path '*/__pycache__/*' \
|
|
19
|
+
-not -path '*/.venv/*' \
|
|
20
|
+
-not -path '*/dist/*' \
|
|
21
|
+
-not -path '*/build/*' \
|
|
22
|
+
-not -path '*/.next/*' \
|
|
23
|
+
-not -path '*/target/*' \
|
|
24
|
+
| sort
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## 2. Project identity
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
# Node
|
|
31
|
+
cat package.json | python3 -c "
|
|
32
|
+
import json,sys; d=json.load(sys.stdin)
|
|
33
|
+
print('name:', d.get('name'))
|
|
34
|
+
print('description:', d.get('description'))
|
|
35
|
+
print('version:', d.get('version'))
|
|
36
|
+
print('license:', d.get('license'))
|
|
37
|
+
print('scripts:', list(d.get('scripts',{}).keys()))
|
|
38
|
+
print('engines:', d.get('engines'))
|
|
39
|
+
"
|
|
40
|
+
|
|
41
|
+
# Python
|
|
42
|
+
cat pyproject.toml 2>/dev/null || cat setup.py 2>/dev/null
|
|
43
|
+
|
|
44
|
+
# Rust
|
|
45
|
+
cat Cargo.toml 2>/dev/null
|
|
46
|
+
|
|
47
|
+
# Go
|
|
48
|
+
cat go.mod 2>/dev/null
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## 3. Package manager
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
ls package-lock.json yarn.lock pnpm-lock.yaml bun.lockb 2>/dev/null
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## 4. Scripts / Makefile
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
# Node scripts
|
|
61
|
+
cat package.json | python3 -c "
|
|
62
|
+
import json,sys; d=json.load(sys.stdin)
|
|
63
|
+
for k,v in d.get('scripts',{}).items(): print(f' {k}: {v}')
|
|
64
|
+
"
|
|
65
|
+
|
|
66
|
+
# Makefile targets
|
|
67
|
+
grep -E '^[a-zA-Z_-]+:' Makefile 2>/dev/null | head -30
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## 5. Runtime versions
|
|
71
|
+
|
|
72
|
+
```bash
|
|
73
|
+
cat .nvmrc 2>/dev/null
|
|
74
|
+
cat .node-version 2>/dev/null
|
|
75
|
+
cat .python-version 2>/dev/null
|
|
76
|
+
cat .tool-versions 2>/dev/null
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## 6. CI commands
|
|
80
|
+
|
|
81
|
+
```bash
|
|
82
|
+
grep -h "run:" .github/workflows/*.yml 2>/dev/null | head -30
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## 7. Existing docs
|
|
86
|
+
|
|
87
|
+
```bash
|
|
88
|
+
cat README.md 2>/dev/null
|
|
89
|
+
cat AGENTS.md 2>/dev/null
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
## 8. Key config files (check presence)
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
ls \
|
|
96
|
+
jest.config.* vitest.config.* \
|
|
97
|
+
.eslintrc* eslint.config.* \
|
|
98
|
+
.prettierrc* prettier.config.* \
|
|
99
|
+
ruff.toml .ruff.toml \
|
|
100
|
+
turbo.json nx.json pnpm-workspace.yaml \
|
|
101
|
+
Dockerfile docker-compose.yml \
|
|
102
|
+
2>/dev/null
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
## 9. Dependency hints (detect framework)
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
# Node — check for common frameworks
|
|
109
|
+
cat package.json | python3 -c "
|
|
110
|
+
import json,sys; d=json.load(sys.stdin)
|
|
111
|
+
all_deps = {**d.get('dependencies',{}), **d.get('devDependencies',{})}
|
|
112
|
+
frameworks = ['next','nuxt','remix','astro','vite','express','fastify','nestjs',
|
|
113
|
+
'react','vue','svelte','solid','angular','electron','tauri']
|
|
114
|
+
found = [f for f in frameworks if f in all_deps or f+'js' in all_deps]
|
|
115
|
+
print('detected frameworks:', found)
|
|
116
|
+
"
|
|
117
|
+
```
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "multi-skills-readme-template"
|
|
3
|
+
description: "README template for a repository hosting a collection of AI skills. Focuses on design philosophy, quickstart, and categorized skills with workflow dependencies."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# {Project Name / Skill Collection}
|
|
7
|
+
|
|
8
|
+
> {One-line pitch: E.g., A collection of composable, engineering-focused AI skills.}
|
|
9
|
+
|
|
10
|
+
<!-- Optional: Badges for version, license, status -->
|
|
11
|
+
[](LICENSE)
|
|
12
|
+
|
|
13
|
+
## Overview & Philosophy
|
|
14
|
+
|
|
15
|
+
{2–3 paragraphs explaining *why* this collection exists. What common AI coding failures (e.g., verbosity, architectural rot, misalignment) does this pack solve? Explain the design principles behind these skills.}
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## Quickstart
|
|
20
|
+
|
|
21
|
+
{How to install or activate the entire pack of skills in the user's environment. E.g., `npx skills@latest add ...` or cloning the repo.}
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
{installation command}
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## Core Problem Statements & Solutions
|
|
30
|
+
|
|
31
|
+
{Identify 2-3 common failure modes when working with AI, and highlight which skills in this repository solve them.}
|
|
32
|
+
|
|
33
|
+
### Problem: {e.g., The Agent Didn't Do What I Want}
|
|
34
|
+
**The Fix**: Use `/{skill-name}` to {briefly describe the solution workflow}.
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Skills Directory
|
|
39
|
+
|
|
40
|
+
{List the skills grouped by their categories. For each category, emphasize workflow dependencies or sequential requirements.}
|
|
41
|
+
|
|
42
|
+
### {Category 1: e.g., Engineering}
|
|
43
|
+
|
|
44
|
+
{1-2 sentences summarizing what this category of skills does.}
|
|
45
|
+
|
|
46
|
+
> **Workflow & Dependencies**:
|
|
47
|
+
> - **Required Setup**: {e.g., Run `/setup-project` before using any other skills in this category.}
|
|
48
|
+
> - **Suggested Flow**: {e.g., Use `/to-prd` to design -> `/to-issues` to split tasks -> `/tdd` to implement.}
|
|
49
|
+
|
|
50
|
+
| Skill | Description | Link |
|
|
51
|
+
|---|---|---|
|
|
52
|
+
| `{skill-name}` | {Description from YAML frontmatter} | [View Skill](./skills/category/{skill-name}/SKILL.md) |
|
|
53
|
+
| `{skill-name-2}` | {Description from YAML frontmatter} | [View Skill](./skills/category/{skill-name-2}/SKILL.md) |
|
|
54
|
+
|
|
55
|
+
### {Category 2: e.g., Productivity}
|
|
56
|
+
|
|
57
|
+
{1-2 sentences summarizing what this category of skills does.}
|
|
58
|
+
|
|
59
|
+
| Skill | Description | Link |
|
|
60
|
+
|---|---|---|
|
|
61
|
+
| `{skill-name}` | {Description from YAML frontmatter} | [View Skill](./skills/category/{skill-name}/SKILL.md) |
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## Contributing & Authoring
|
|
66
|
+
|
|
67
|
+
Want to add a new skill to this repository?
|
|
68
|
+
{Provide brief instructions or link to a `/write-a-skill` guideline.}
|
|
69
|
+
|
|
70
|
+
## License
|
|
71
|
+
|
|
72
|
+
Apache 2.0 — see [LICENSE](LICENSE) for details.
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "product-agents-template"
|
|
3
|
+
description: "AGENTS.md template for end-user products (Full-stack apps, CLI tools, SaaS platforms). Provides AI agents with precise architecture, commands, conventions, and domain knowledge."
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# {Product Name} - AI Developer Guide
|
|
7
|
+
|
|
8
|
+
> {One tight paragraph: technical summary of the product. E.g., "A full-stack React/Node.js application using PostgreSQL and MCP for agentic queries. Monorepo structure managed by pnpm." No marketing language.}
|
|
9
|
+
|
|
10
|
+
## Tech Stack & Architecture
|
|
11
|
+
|
|
12
|
+
- **Frontend**: {Framework, styling, state management. e.g., Next.js App Router, Tailwind, Zustand}
|
|
13
|
+
- **Backend**: {Language, framework. e.g., Node.js, Express/Hono}
|
|
14
|
+
- **Database**: {Database type and ORM. e.g., PostgreSQL via Prisma}
|
|
15
|
+
|
|
16
|
+
```
|
|
17
|
+
{abbreviated tree — key directories only}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
| Directory | Purpose |
|
|
21
|
+
|---|---|
|
|
22
|
+
| `apps/frontend/` | {description} |
|
|
23
|
+
| `apps/api/` | {description} |
|
|
24
|
+
| `packages/core/` | {description} |
|
|
25
|
+
|
|
26
|
+
## Development Commands
|
|
27
|
+
|
|
28
|
+
All commands are executed from the repository root unless otherwise noted.
|
|
29
|
+
|
|
30
|
+
### Setup & Database
|
|
31
|
+
```bash
|
|
32
|
+
{install command e.g., pnpm install}
|
|
33
|
+
{env setup e.g., cp .env.example .env}
|
|
34
|
+
{database migration e.g., pnpm db:push}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Local Development
|
|
38
|
+
```bash
|
|
39
|
+
{dev server command e.g., pnpm run dev}
|
|
40
|
+
```
|
|
41
|
+
- Frontend runs on: `http://localhost:{port}`
|
|
42
|
+
- API runs on: `http://localhost:{port}`
|
|
43
|
+
|
|
44
|
+
### Testing & Linting
|
|
45
|
+
```bash
|
|
46
|
+
{test command e.g., pnpm test}
|
|
47
|
+
{lint command e.g., pnpm lint}
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Build
|
|
51
|
+
```bash
|
|
52
|
+
{build command e.g., pnpm build}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Conventions
|
|
56
|
+
|
|
57
|
+
- **Package Manager**: {e.g., Strictly use `pnpm`. `npm` and `yarn` will break resolution.}
|
|
58
|
+
- **Imports**: {e.g., Use absolute imports from `@/` in the frontend.}
|
|
59
|
+
- **Naming**: {e.g., PascalCase for React components, kebab-case for file names.}
|
|
60
|
+
- **State**: {e.g., Use Zustand for global state, avoid React Context unless necessary.}
|
|
61
|
+
|
|
62
|
+
## Product Domain Knowledge
|
|
63
|
+
|
|
64
|
+
{Briefly map product terminology to code concepts to help AI understand the business logic.}
|
|
65
|
+
- **{Domain Term 1}**: Handled entirely in `packages/core/src/term-1.ts`.
|
|
66
|
+
- **{Domain Term 2}**: Corresponds to the `Term2` database model in the Prisma schema.
|
|
67
|
+
|
|
68
|
+
## Do Not Edit
|
|
69
|
+
|
|
70
|
+
- `{generated file or dir}` — Auto-generated, do not edit manually.
|
|
71
|
+
- `{lock file}` — Managed by {tool} (e.g., `pnpm-lock.yaml`).
|
|
72
|
+
- `{build output dir}` — Ephemeral output.
|
|
73
|
+
|
|
74
|
+
## System Boundaries & Gotchas
|
|
75
|
+
|
|
76
|
+
- {Constraint 1: e.g., "The API server strictly requires the `DATABASE_URL` environment variable to start."}
|
|
77
|
+
- {Constraint 2: e.g., "Do not modify the `lib/generated/` folder; it is built on the fly during `pnpm dev`."}
|
|
78
|
+
- {Constraint 3: e.g., "If adding a new database table, you must run `pnpm db:generate` before testing."}
|