@dedesfr/prompter 0.8.12 → 0.8.14
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/CHANGELOG.md +13 -0
- package/dist/cli/index.js +1 -1
- package/dist/commands/init.js +1 -1
- package/dist/commands/init.js.map +1 -1
- package/package.json +1 -1
- package/skills/ai-context-generator/SKILL.md +54 -0
- package/skills/ai-context-generator/references/AGENTS.template.md +83 -0
- package/skills/ai-context-generator/references/CLAUDE.template.md +39 -0
- package/skills/ai-context-generator/references/behavioral-guidelines.md +71 -0
- package/skills/ai-context-generator/references/discovery-checklist.md +40 -0
- package/skills/ai-context-generator/references/examples/AGENTS.good.md +103 -0
- package/skills/ai-context-generator/references/extraction-checklist.md +23 -0
- package/skills/ai-context-generator/references/overlays/laravel.md +44 -0
- package/skills/ui-ux-pro-v2/SKILL.md +41 -40
- package/src/cli/index.ts +1 -1
- package/src/commands/init.ts +1 -1
- package/skills/agents-md-generator/SKILL.md +0 -238
- package/skills/agents-md-generator/assets/agents-md-template.md +0 -81
- package/skills/agents-md-generator/references/best-practices.md +0 -215
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
<!--
|
|
2
|
+
LARAVEL OVERLAY — append verbatim to AGENTS.md when the project is Laravel.
|
|
3
|
+
Detection: `composer.json` includes `laravel/framework`, OR `artisan` exists at repo root.
|
|
4
|
+
Place this block AFTER `## Behavioral guidelines` and BEFORE end of file.
|
|
5
|
+
-->
|
|
6
|
+
|
|
7
|
+
## Laravel safety rules (mandatory)
|
|
8
|
+
|
|
9
|
+
These rules are non-negotiable and override speed/convenience. They exist because destructive DB commands have repeatedly destroyed local and shared data on this project.
|
|
10
|
+
|
|
11
|
+
### Confirmation required before any destructive command
|
|
12
|
+
|
|
13
|
+
Always ask for explicit yes/no confirmation before running any of:
|
|
14
|
+
|
|
15
|
+
- **Schema drops:** `Schema::drop`, `Schema::dropIfExists`, raw `DROP TABLE`, `DROP DATABASE`, `php artisan db:wipe`.
|
|
16
|
+
- **Bulk data deletion:** `Model::truncate()`, `DB::table(...)->truncate()`, `DB::table(...)->delete()` without a `where`, `Model::query()->delete()`, `forceDelete` on collections, mass cleanup jobs/commands.
|
|
17
|
+
- **Fresh rebuild:** `php artisan migrate:fresh`, `php artisan migrate:fresh --seed`, `php artisan migrate:refresh`, `php artisan schema:dump --prune`. (User may call this "migrateg --fresh" — same thing.)
|
|
18
|
+
- **Production-targeted destructive ops:** anything above with `--force`, or `--env=production`, or against a non-local `DB_CONNECTION`.
|
|
19
|
+
- **Seeders that truncate:** any `DatabaseSeeder` or seeder containing `truncate()` / `delete()` calls.
|
|
20
|
+
- **Tinker:** destructive operations via `php artisan tinker` (treat the same as direct execution).
|
|
21
|
+
|
|
22
|
+
### Required confirmation format
|
|
23
|
+
|
|
24
|
+
Before running, state:
|
|
25
|
+
|
|
26
|
+
1. **Command:** the exact invocation (with all flags, env, and target connection).
|
|
27
|
+
2. **Why destructive:** what it deletes/drops.
|
|
28
|
+
3. **Scope:** which DB connection, which env (`APP_ENV`, `DB_CONNECTION`, `DB_DATABASE`), how many rows/tables affected if knowable.
|
|
29
|
+
4. **Safer alternative:** name one (e.g. `php artisan migrate` instead of `migrate:fresh`; a targeted `where()->delete()` instead of `truncate()`).
|
|
30
|
+
|
|
31
|
+
Then ask: *"Run this? (yes/no)"* — wait for an explicit yes. Implicit consent does not count.
|
|
32
|
+
|
|
33
|
+
### Default safe behavior
|
|
34
|
+
|
|
35
|
+
- No confirmation → do not run. Do not retry with a different flag.
|
|
36
|
+
- Prefer non-destructive first: `migrate` over `migrate:fresh`; new migration over editing a merged one; targeted update over truncate-and-reseed.
|
|
37
|
+
- If approved, run **only** the confirmed scope. Do not chain extra commands ("while I'm here, also...").
|
|
38
|
+
- After running, report: command run, rows/tables affected, current migration status.
|
|
39
|
+
|
|
40
|
+
### Hard rules (never, even with confirmation, unless user explicitly names the command)
|
|
41
|
+
|
|
42
|
+
- Never run any destructive command against a connection that isn't `sqlite` in-memory or a database whose name contains `local`, `dev`, or `test` — without the user typing the actual command themselves.
|
|
43
|
+
- Never use `--force` in any environment without an explicit user instruction containing `--force`.
|
|
44
|
+
- Never `DROP DATABASE` or `db:wipe` without the user typing it.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: ui-ux-pro-v2
|
|
3
|
-
description: Design and revise UI/UX like a senior designer. Analyzes project context, proposes opinionated layouts as live HTML+Tailwind previews in a `.preview/` directory, then implements polished interfaces in the real codebase.
|
|
3
|
+
description: Design and revise UI/UX like a senior designer. Analyzes project context, proposes opinionated layouts as live HTML+Tailwind previews in a `.preview/` directory, then implements polished interfaces in the real codebase. TRIGGER on new pages, redesigns, design audits, or component design where layout/hierarchy is in question. SKIP for small tweaks (color, spacing, copy, one-line CSS fixes), bug fixes to an already-approved layout, or backend/logic work — edit real code directly instead.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# UI UX Pro v2
|
|
@@ -11,23 +11,21 @@ Act as a senior UI/UX designer. Make opinionated design decisions based on proje
|
|
|
11
11
|
|
|
12
12
|
## Critical Rules (Read First)
|
|
13
13
|
|
|
14
|
-
|
|
14
|
+
The failure modes to internalize — full context lives in the Workflow section below:
|
|
15
15
|
|
|
16
|
-
1. **Diagnose redesigns yourself** — never ask "what feels wrong?"
|
|
17
|
-
2. **Low-fi before high-fi
|
|
18
|
-
3. **
|
|
19
|
-
4. **
|
|
20
|
-
5. **
|
|
21
|
-
6. **
|
|
22
|
-
7. **
|
|
23
|
-
8. **Don't delete `.preview/`** — user keeps these as reference. Never auto-clean.
|
|
24
|
-
9. **Tell user to verify in browser** — do not attempt to run the dev server yourself.
|
|
16
|
+
1. **Diagnose redesigns yourself** — never ask "what feels wrong?" Surface findings, then yield for the user's reply before building.
|
|
17
|
+
2. **Low-fi before high-fi; preview before real code.** No skipping tiers.
|
|
18
|
+
3. **Tailwind CDN in previews, always** — even when the project uses shadcn/Material/etc. Previews stay disposable.
|
|
19
|
+
4. **Section comments required** — every major HTML block gets `<!-- Section: Name -->` so users can give spatial feedback without reading code.
|
|
20
|
+
5. **Default one variant with a stated recommendation.** Offer alternatives only if asked.
|
|
21
|
+
6. **Never auto-delete `.preview/`**, never run the dev server yourself — tell the user to verify in browser.
|
|
22
|
+
7. **Mobile, tablet, desktop from Pass 1.** A layout that breaks on mobile is not done.
|
|
25
23
|
|
|
26
24
|
---
|
|
27
25
|
|
|
28
26
|
## Workflow
|
|
29
27
|
|
|
30
|
-
`Step 0: Read context → Step 1:
|
|
28
|
+
`Step 0: Read context → Step 1: Decide mock vs. edit → Step 2: Discovery → Step 3: Low-fi → [approval] → Step 4: High-fi → [approval] → Step 5: Implement → Step 6: Iterate`
|
|
31
29
|
|
|
32
30
|
---
|
|
33
31
|
|
|
@@ -42,11 +40,28 @@ Before designing, silently gather — do not ask the user:
|
|
|
42
40
|
|
|
43
41
|
---
|
|
44
42
|
|
|
45
|
-
## Step 1:
|
|
43
|
+
## Step 1: Decide Mock vs. Edit
|
|
44
|
+
|
|
45
|
+
Before discovery, decide the path. **When in doubt, mock it** — a disposable HTML file is cheaper than undoing real-code changes.
|
|
46
|
+
|
|
47
|
+
### Build a preview (continue to Step 2):
|
|
48
|
+
- New page or feature
|
|
49
|
+
- Major redesign
|
|
50
|
+
- Multiple directions are plausible
|
|
51
|
+
- User is non-technical and needs to see before reacting
|
|
52
|
+
|
|
53
|
+
### Edit real code directly (skip to Step 5):
|
|
54
|
+
- Small tweak (color, spacing, copy)
|
|
55
|
+
- Fixing a specific bug the user pointed at
|
|
56
|
+
- Adding one element to an already-approved layout
|
|
57
|
+
- Developer user asking for a specific change
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## Step 2: Discovery
|
|
46
62
|
|
|
47
63
|
### New designs
|
|
48
|
-
|
|
49
|
-
2. Ask one optional: *"Any vibe or reference in mind? (totally optional)"* — proceed regardless
|
|
64
|
+
Ask one combined question: *"What is this for — page/feature, audience, and goal? Any vibe or reference is optional."* Proceed regardless of whether they give a vibe.
|
|
50
65
|
|
|
51
66
|
### Redesigns and audits
|
|
52
67
|
Do NOT ask open-ended questions. Most users cannot articulate design problems.
|
|
@@ -54,14 +69,14 @@ Do NOT ask open-ended questions. Most users cannot articulate design problems.
|
|
|
54
69
|
1. Silently analyze the existing page — read the code or screenshot
|
|
55
70
|
2. Present a short diagnostic (3–4 bullets, plain language):
|
|
56
71
|
```
|
|
57
|
-
Here's what I noticed
|
|
72
|
+
Here's what I noticed:
|
|
58
73
|
- Weak hierarchy — CTA competes with secondary content
|
|
59
74
|
- Inconsistent spacing — no clear scale
|
|
60
75
|
- Low contrast on the action button (likely fails WCAG AA)
|
|
61
76
|
- Font sizes too uniform — headlines don't feel distinct
|
|
62
77
|
```
|
|
63
|
-
3. Ask
|
|
64
|
-
4.
|
|
78
|
+
3. Ask: *"Anything to keep, or a vibe/reference in mind? Say go and I'll start the low-fi."*
|
|
79
|
+
4. **Yield to the user here.** End your turn after the diagnostic + question. Do not continue into preview construction in the same turn.
|
|
65
80
|
|
|
66
81
|
### Never ask:
|
|
67
82
|
- "What feels wrong?" — diagnose it yourself
|
|
@@ -72,7 +87,7 @@ Do NOT ask open-ended questions. Most users cannot articulate design problems.
|
|
|
72
87
|
|
|
73
88
|
---
|
|
74
89
|
|
|
75
|
-
## Step
|
|
90
|
+
## Step 3: Preview (REQUIRED Before Any Real Code)
|
|
76
91
|
|
|
77
92
|
### File structure
|
|
78
93
|
```
|
|
@@ -84,7 +99,7 @@ Do NOT ask open-ended questions. Most users cannot articulate design problems.
|
|
|
84
99
|
```
|
|
85
100
|
|
|
86
101
|
- Files must be standalone, openable with `file://`
|
|
87
|
-
- Add `.preview/` to `.gitignore` if not ignored (ask first if repo tracks it)
|
|
102
|
+
- Add `.preview/` to `.gitignore` if not ignored (ask first if repo tracks it). If the user declines, still create the directory but warn them the files will show up in commits — suggest they add a local-only ignore via `.git/info/exclude`.
|
|
88
103
|
|
|
89
104
|
### CSS in previews
|
|
90
105
|
Always use Tailwind CDN (`<script src="https://cdn.tailwindcss.com"></script>`), even if the project uses shadcn/Material. If the project has brand tokens (CSS variables), inline them in a `<style>` block so colors/fonts match. The real implementation uses the project's actual design system — keep this separation clear.
|
|
@@ -94,6 +109,7 @@ Always use Tailwind CDN (`<script src="https://cdn.tailwindcss.com"></script>`),
|
|
|
94
109
|
- System font only — no custom typography
|
|
95
110
|
- No shadows, gradients, or decorative effects
|
|
96
111
|
- Focus: layout, hierarchy, spacing, content flow
|
|
112
|
+
- **Include basic responsive behavior** — at minimum, the layout must not break on mobile. Use Tailwind responsive prefixes (`sm:`, `md:`, `lg:`) from the start.
|
|
97
113
|
- File: `<feature>-lowfi.html`
|
|
98
114
|
|
|
99
115
|
Present, wait for layout approval before proceeding.
|
|
@@ -103,6 +119,9 @@ Present, wait for layout approval before proceeding.
|
|
|
103
119
|
- Add hover/focus states, responsive breakpoints
|
|
104
120
|
- File: `<feature>-v1.html`
|
|
105
121
|
|
|
122
|
+
### Delegating to `frontend-design` Skill
|
|
123
|
+
If the `frontend-design` skill is available in the session, delegate the actual HTML markup construction to it — pass your layout decisions, section structure, and brand tokens, let it produce the markup. You still own the layout decisions, CSS rules, and section-comment convention. If not available, build the markup yourself.
|
|
124
|
+
|
|
106
125
|
### Variations
|
|
107
126
|
Default to one. Offer more only if the user asks, or if there is genuinely zero style signal to work from. Max 3. When building multiple, create a `variations.html` hub that links or iframes all variants side-by-side. Always mark one as **Recommended ⭐** with a one-line reason.
|
|
108
127
|
|
|
@@ -122,25 +141,7 @@ Does the layout work? I can adjust any section before moving to high-fi.
|
|
|
122
141
|
|
|
123
142
|
---
|
|
124
143
|
|
|
125
|
-
## Step
|
|
126
|
-
|
|
127
|
-
### Build a preview when:
|
|
128
|
-
- New page or feature
|
|
129
|
-
- Major redesign
|
|
130
|
-
- Multiple directions are plausible
|
|
131
|
-
- User is non-technical and needs to see before reacting
|
|
132
|
-
|
|
133
|
-
### Edit real code directly when:
|
|
134
|
-
- Small tweak (color, spacing, copy)
|
|
135
|
-
- Fixing a specific bug the user pointed at
|
|
136
|
-
- Adding one element to an already-approved layout
|
|
137
|
-
- User is a developer who asked for a specific change
|
|
138
|
-
|
|
139
|
-
**When in doubt — mock it.** A disposable HTML file costs little; undoing rejected real-code changes costs more.
|
|
140
|
-
|
|
141
|
-
---
|
|
142
|
-
|
|
143
|
-
## Step 4: Implementation (After Preview Approved)
|
|
144
|
+
## Step 5: Implementation (After Preview Approved)
|
|
144
145
|
|
|
145
146
|
### Order
|
|
146
147
|
1. Layout structure and spacing
|
|
@@ -168,7 +169,7 @@ When done: tell the user to open the page in their browser to verify.
|
|
|
168
169
|
|
|
169
170
|
---
|
|
170
171
|
|
|
171
|
-
## Step
|
|
172
|
+
## Step 6: Iteration
|
|
172
173
|
|
|
173
174
|
| User says | You do |
|
|
174
175
|
|---|---|
|
package/src/cli/index.ts
CHANGED
package/src/commands/init.ts
CHANGED
|
@@ -86,7 +86,7 @@ export class InitCommand {
|
|
|
86
86
|
},
|
|
87
87
|
{
|
|
88
88
|
name: '📝 Documentation',
|
|
89
|
-
skills: ['doc-builder', 'document-translator', '
|
|
89
|
+
skills: ['doc-builder', 'document-translator', 'ai-context-generator', 'meeting-notes']
|
|
90
90
|
},
|
|
91
91
|
{
|
|
92
92
|
name: '✨ Content & Productivity',
|
|
@@ -1,238 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: agents-md-generator
|
|
3
|
-
description: Generate or update an AGENTS.md file in any project's root directory. Creates a comprehensive, well-structured AGENTS.md following industry best practices from analysis of 2,500+ repositories. Works from existing project docs (README, package.json, config files), codebase analysis, or direct user input. Use this skill whenever the user wants to create an AGENTS.md, update an existing one, improve AI agent instructions for a project, or mentions setting up agent context for any codebase. Also trigger when users mention wanting better AI coding assistant results, agent configuration, or project onboarding for AI tools.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# AGENTS.md Generator
|
|
7
|
-
|
|
8
|
-
Generate or update a project's AGENTS.md file — the standard open-format file that gives AI coding agents the context they need to work effectively in a codebase.
|
|
9
|
-
|
|
10
|
-
## Why AGENTS.md matters
|
|
11
|
-
|
|
12
|
-
AGENTS.md is the "README for AI agents." Unlike README files written for humans, AGENTS.md provides the specific, structured context that AI coding agents need: exact commands with flags, concrete code examples, clear boundaries on what to never touch, and project-specific conventions that aren't obvious from the code alone. A well-written AGENTS.md dramatically improves the quality of AI-generated code by reducing hallucinated endpoints, mismatched coding styles, and violations of project constraints.
|
|
13
|
-
|
|
14
|
-
## Step 0: Determine Mode
|
|
15
|
-
|
|
16
|
-
Present these options to the user:
|
|
17
|
-
|
|
18
|
-
**What would you like to do?**
|
|
19
|
-
|
|
20
|
-
1. **Generate new AGENTS.md** — Create from scratch by analyzing the project
|
|
21
|
-
2. **Update existing AGENTS.md** — Improve or add sections to an existing file
|
|
22
|
-
3. **Generate from docs** — Build AGENTS.md from existing documentation (README, wiki, docs/)
|
|
23
|
-
|
|
24
|
-
Wait for the user's selection before proceeding.
|
|
25
|
-
|
|
26
|
-
## Step 1: Gather Project Context
|
|
27
|
-
|
|
28
|
-
The quality of the AGENTS.md depends entirely on understanding the project. Collect context from these sources, in priority order:
|
|
29
|
-
|
|
30
|
-
### 1.1 Automatic Discovery (always do this)
|
|
31
|
-
|
|
32
|
-
Scan the project root for context signals:
|
|
33
|
-
|
|
34
|
-
- **Package manifest**: `package.json`, `Cargo.toml`, `pyproject.toml`, `go.mod`, `composer.json`, `Gemfile`, `pom.xml`, `build.gradle`
|
|
35
|
-
- **Config files**: `tsconfig.json`, `.eslintrc*`, `.prettierrc*`, `tailwind.config.*`, `vite.config.*`, `webpack.config.*`, `docker-compose.yml`
|
|
36
|
-
- **CI/CD**: `.github/workflows/`, `.gitlab-ci.yml`, `Jenkinsfile`
|
|
37
|
-
- **Existing docs**: `README.md`, `CONTRIBUTING.md`, `docs/`, `wiki/`
|
|
38
|
-
- **Existing AI config**: `CLAUDE.md`, `.cursorrules`, `.github/copilot-instructions.md`, `.windsurfrules`
|
|
39
|
-
- **Test setup**: test directories, test config files, test scripts in package manifest
|
|
40
|
-
- **Git history**: recent commit patterns, active contributors
|
|
41
|
-
|
|
42
|
-
Read these files to extract:
|
|
43
|
-
- Tech stack and versions
|
|
44
|
-
- Build/test/lint commands
|
|
45
|
-
- Project structure patterns
|
|
46
|
-
- Coding conventions
|
|
47
|
-
- Architecture decisions
|
|
48
|
-
|
|
49
|
-
### 1.2 User-Provided Docs (if mode is "Generate from docs")
|
|
50
|
-
|
|
51
|
-
Ask the user to point to their documentation:
|
|
52
|
-
- "Which docs should I use as source material? (paths, URLs, or paste content directly)"
|
|
53
|
-
|
|
54
|
-
Read and synthesize the provided documentation into AGENTS.md sections.
|
|
55
|
-
|
|
56
|
-
### 1.3 Interactive Interview (fill gaps)
|
|
57
|
-
|
|
58
|
-
After automatic discovery, identify what's still missing and ask the user targeted questions. Don't ask about things you already know from the codebase. Focus on:
|
|
59
|
-
|
|
60
|
-
- **Project purpose**: What does this project do? (if not clear from README)
|
|
61
|
-
- **Architecture decisions**: Any non-obvious patterns or constraints?
|
|
62
|
-
- **Boundaries**: What should AI agents never touch? (secrets, vendor dirs, generated files, production configs)
|
|
63
|
-
- **Domain vocabulary**: Any project-specific terms agents need to know?
|
|
64
|
-
- **Common pitfalls**: What mistakes do new contributors (or AI agents) commonly make?
|
|
65
|
-
- **Testing requirements**: Any specific testing patterns or requirements?
|
|
66
|
-
|
|
67
|
-
Keep the interview short — 3-5 questions max, focused on what you genuinely couldn't determine from the code.
|
|
68
|
-
|
|
69
|
-
## Step 2: Structure the AGENTS.md
|
|
70
|
-
|
|
71
|
-
Use the template at `assets/agents-md-template.md` as a starting point. The template has 18 sections — not all are required for every project. Include a section only if you have substantive content for it. An empty or placeholder section ("Not specified") is worse than omitting it entirely.
|
|
72
|
-
|
|
73
|
-
### Section Priority
|
|
74
|
-
|
|
75
|
-
**Always include** (these are the highest-value sections based on empirical analysis):
|
|
76
|
-
1. **Project Summary** — What this project does, in 2-3 sentences
|
|
77
|
-
2. **Tech Stack** — Languages, frameworks, runtime versions
|
|
78
|
-
3. **Commands** — Build, test, lint, deploy commands with exact flags
|
|
79
|
-
4. **Folder Structure** — Key directories and their purposes
|
|
80
|
-
5. **Coding Conventions** — Real code examples, not verbal descriptions
|
|
81
|
-
6. **Development Rules for AI Agents** — Boundaries and constraints
|
|
82
|
-
|
|
83
|
-
**Include when relevant:**
|
|
84
|
-
7. **Architecture Overview** — Module structure, data flow
|
|
85
|
-
8. **Core Business Logic** — Domain rules that aren't obvious from code
|
|
86
|
-
9. **Data Models** — Key entities and relationships
|
|
87
|
-
10. **Domain Vocabulary** — Project-specific terms
|
|
88
|
-
11. **Security/Privacy Rules** — Auth flows, sensitive data handling
|
|
89
|
-
12. **Testing Strategy** — Frameworks, patterns, coverage expectations
|
|
90
|
-
13. **Integration Map** — External services, APIs, third-party tools
|
|
91
|
-
|
|
92
|
-
**Include only if substantive:**
|
|
93
|
-
14. **Target Users** — Who uses this and how
|
|
94
|
-
15. **UI/UX Principles** — Design patterns and constraints
|
|
95
|
-
16. **Roadmap** — Active initiatives
|
|
96
|
-
17. **Known Issues** — Current limitations
|
|
97
|
-
18. **Troubleshooting** — Common problems and fixes
|
|
98
|
-
19. **Ownership Map** — Who owns what
|
|
99
|
-
|
|
100
|
-
### Writing Guidelines
|
|
101
|
-
|
|
102
|
-
Follow these principles — they come from analysis of what actually makes AGENTS.md effective:
|
|
103
|
-
|
|
104
|
-
**Be specific, not vague.**
|
|
105
|
-
```markdown
|
|
106
|
-
# Bad
|
|
107
|
-
- Use TypeScript
|
|
108
|
-
- Follow best practices
|
|
109
|
-
|
|
110
|
-
# Good
|
|
111
|
-
- TypeScript 5.4 with strict mode enabled
|
|
112
|
-
- ESM imports with explicit `.js` extensions in compiled output
|
|
113
|
-
- Prefer `interface` over `type` for object shapes
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
**Lead with executable commands.**
|
|
117
|
-
```markdown
|
|
118
|
-
# Commands
|
|
119
|
-
npm run build # Compile TypeScript to dist/
|
|
120
|
-
npm test # Run vitest test suite
|
|
121
|
-
npm run lint # ESLint with --fix
|
|
122
|
-
npm run typecheck # tsc --noEmit
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
**Show code examples for conventions.**
|
|
126
|
-
```markdown
|
|
127
|
-
# Component pattern
|
|
128
|
-
export function UserCard({ user }: { user: User }) {
|
|
129
|
-
// Components use named exports, PascalCase
|
|
130
|
-
// Props defined inline for simple cases
|
|
131
|
-
}
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
**Use three-tier boundaries.**
|
|
135
|
-
```markdown
|
|
136
|
-
## Development Rules for AI Agents
|
|
137
|
-
### Always do:
|
|
138
|
-
- Run `npm run typecheck` before committing
|
|
139
|
-
- Use existing utility functions from `src/utils/`
|
|
140
|
-
|
|
141
|
-
### Ask first:
|
|
142
|
-
- Adding new dependencies
|
|
143
|
-
- Modifying database schemas
|
|
144
|
-
- Changes to CI/CD pipelines
|
|
145
|
-
|
|
146
|
-
### Never do:
|
|
147
|
-
- Commit `.env` files or secrets
|
|
148
|
-
- Modify `vendor/` or generated files
|
|
149
|
-
- Run destructive database commands
|
|
150
|
-
- Invent API endpoints that don't exist
|
|
151
|
-
```
|
|
152
|
-
|
|
153
|
-
**Include file-scoped commands** for common per-file operations:
|
|
154
|
-
```markdown
|
|
155
|
-
# File-scoped commands
|
|
156
|
-
npx vitest run src/utils/parse.test.ts # Run single test file
|
|
157
|
-
npx eslint --fix src/components/Card.tsx # Lint single file
|
|
158
|
-
npx tsc --noEmit src/types.ts # Type-check single file
|
|
159
|
-
```
|
|
160
|
-
|
|
161
|
-
## Step 3: Generate or Update
|
|
162
|
-
|
|
163
|
-
### For new AGENTS.md (Mode 1 or 3)
|
|
164
|
-
|
|
165
|
-
1. Read the template from `assets/agents-md-template.md`
|
|
166
|
-
2. Fill in each section with discovered and user-provided content
|
|
167
|
-
3. Remove sections that have no substantive content
|
|
168
|
-
4. Write to `AGENTS.md` in the project root
|
|
169
|
-
|
|
170
|
-
### For updating existing AGENTS.md (Mode 2)
|
|
171
|
-
|
|
172
|
-
1. Read the existing `AGENTS.md`
|
|
173
|
-
2. Identify which sections exist and their quality
|
|
174
|
-
3. Ask the user what they want to improve:
|
|
175
|
-
- "Add missing sections"
|
|
176
|
-
- "Update outdated information"
|
|
177
|
-
- "Improve specific sections" (let them pick)
|
|
178
|
-
- "Full refresh" (regenerate while preserving custom content)
|
|
179
|
-
4. Make targeted updates, preserving any custom content the user has added
|
|
180
|
-
5. If the file has managed markers (like `<!-- PROMPTER:START -->`), preserve those sections untouched
|
|
181
|
-
|
|
182
|
-
### Monorepo Support
|
|
183
|
-
|
|
184
|
-
For monorepos or multi-package projects, offer to create nested AGENTS.md files:
|
|
185
|
-
|
|
186
|
-
```
|
|
187
|
-
project-root/
|
|
188
|
-
├── AGENTS.md # Project-wide context
|
|
189
|
-
├── packages/
|
|
190
|
-
│ ├── frontend/
|
|
191
|
-
│ │ └── AGENTS.md # Frontend-specific context
|
|
192
|
-
│ └── backend/
|
|
193
|
-
│ └── AGENTS.md # Backend-specific context
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
The root AGENTS.md should reference subdirectory files and provide shared context. Subdirectory files should focus on package-specific details.
|
|
197
|
-
|
|
198
|
-
## Step 4: Validate and Review
|
|
199
|
-
|
|
200
|
-
Before finalizing, check:
|
|
201
|
-
|
|
202
|
-
- [ ] No placeholder text remains ("Not specified", "TODO", "TBD")
|
|
203
|
-
- [ ] Commands are accurate and runnable
|
|
204
|
-
- [ ] File paths referenced actually exist in the project
|
|
205
|
-
- [ ] Tech stack versions match what's in config files
|
|
206
|
-
- [ ] No sensitive information included (API keys, internal URLs, credentials)
|
|
207
|
-
- [ ] Sections are ordered by value (most useful first)
|
|
208
|
-
- [ ] Code examples match the project's actual coding style
|
|
209
|
-
|
|
210
|
-
Present a summary to the user:
|
|
211
|
-
- Which sections were generated
|
|
212
|
-
- Any sections skipped (and why)
|
|
213
|
-
- Suggestions for sections they could add later
|
|
214
|
-
|
|
215
|
-
## Step 5: Save
|
|
216
|
-
|
|
217
|
-
Save the AGENTS.md to the project root path (or the path the user specifies).
|
|
218
|
-
|
|
219
|
-
Print a summary:
|
|
220
|
-
```
|
|
221
|
-
AGENTS.md generated at <path>
|
|
222
|
-
Sections: <count> of 18
|
|
223
|
-
Sources used: <list of files analyzed>
|
|
224
|
-
Suggested improvements: <any sections that could be enhanced with more info>
|
|
225
|
-
```
|
|
226
|
-
|
|
227
|
-
## Edge Cases
|
|
228
|
-
|
|
229
|
-
- **No package manifest found**: Ask the user about the tech stack directly
|
|
230
|
-
- **Multiple languages**: Create sections for each, clearly labeled
|
|
231
|
-
- **Existing CLAUDE.md / .cursorrules**: Offer to consolidate into AGENTS.md (which is the cross-tool standard) or keep both
|
|
232
|
-
- **Very large project**: Focus on the most important directories and patterns rather than trying to document everything
|
|
233
|
-
- **No README**: The interview step becomes more important — ask more questions
|
|
234
|
-
|
|
235
|
-
## Resources
|
|
236
|
-
|
|
237
|
-
- Template: `assets/agents-md-template.md`
|
|
238
|
-
- Best practices reference: `references/best-practices.md`
|
|
@@ -1,81 +0,0 @@
|
|
|
1
|
-
# AGENTS — Project Knowledge Base
|
|
2
|
-
|
|
3
|
-
## 1. Project Summary
|
|
4
|
-
{{PROJECT_SUMMARY}}
|
|
5
|
-
|
|
6
|
-
## 2. Tech Stack
|
|
7
|
-
{{TECH_STACK}}
|
|
8
|
-
|
|
9
|
-
## 3. Architecture Overview
|
|
10
|
-
{{ARCHITECTURE_OVERVIEW}}
|
|
11
|
-
|
|
12
|
-
## 4. Folder Structure & Important Files
|
|
13
|
-
{{FOLDER_STRUCTURE}}
|
|
14
|
-
|
|
15
|
-
## 5. Commands
|
|
16
|
-
```bash
|
|
17
|
-
# Build
|
|
18
|
-
{{BUILD_COMMAND}}
|
|
19
|
-
|
|
20
|
-
# Test
|
|
21
|
-
{{TEST_COMMAND}}
|
|
22
|
-
|
|
23
|
-
# Lint / Format
|
|
24
|
-
{{LINT_COMMAND}}
|
|
25
|
-
|
|
26
|
-
# Type check
|
|
27
|
-
{{TYPECHECK_COMMAND}}
|
|
28
|
-
|
|
29
|
-
# File-scoped commands
|
|
30
|
-
{{FILE_SCOPED_COMMANDS}}
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
## 6. Core Business Logic & Domain Rules
|
|
34
|
-
{{BUSINESS_LOGIC}}
|
|
35
|
-
|
|
36
|
-
## 7. Data Models / Entities
|
|
37
|
-
{{DATA_MODELS}}
|
|
38
|
-
|
|
39
|
-
## 8. Domain Vocabulary / Glossary
|
|
40
|
-
{{DOMAIN_VOCABULARY}}
|
|
41
|
-
|
|
42
|
-
## 9. Target Users & Personas
|
|
43
|
-
{{TARGET_USERS}}
|
|
44
|
-
|
|
45
|
-
## 10. UI/UX Principles
|
|
46
|
-
{{UI_UX_PRINCIPLES}}
|
|
47
|
-
|
|
48
|
-
## 11. Security / Privacy Rules
|
|
49
|
-
{{SECURITY_RULES}}
|
|
50
|
-
|
|
51
|
-
## 12. Coding Conventions & Standards
|
|
52
|
-
{{CODING_CONVENTIONS}}
|
|
53
|
-
|
|
54
|
-
## 13. Development Rules for AI Agents
|
|
55
|
-
|
|
56
|
-
### Always do:
|
|
57
|
-
{{ALWAYS_DO_RULES}}
|
|
58
|
-
|
|
59
|
-
### Ask first:
|
|
60
|
-
{{ASK_FIRST_RULES}}
|
|
61
|
-
|
|
62
|
-
### Never do:
|
|
63
|
-
{{NEVER_DO_RULES}}
|
|
64
|
-
|
|
65
|
-
## 14. Integration Map
|
|
66
|
-
{{INTEGRATION_MAP}}
|
|
67
|
-
|
|
68
|
-
## 15. Testing Strategy
|
|
69
|
-
{{TESTING_STRATEGY}}
|
|
70
|
-
|
|
71
|
-
## 16. Roadmap & Future Plans
|
|
72
|
-
{{ROADMAP}}
|
|
73
|
-
|
|
74
|
-
## 17. Known Issues / Limitations
|
|
75
|
-
{{KNOWN_ISSUES}}
|
|
76
|
-
|
|
77
|
-
## 18. Troubleshooting Guide
|
|
78
|
-
{{TROUBLESHOOTING}}
|
|
79
|
-
|
|
80
|
-
## 19. Ownership / Responsibility Map
|
|
81
|
-
{{OWNERSHIP_MAP}}
|