class-ai-agent 1.2.3 → 1.3.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/.agent/README.md +33 -0
- package/.agent/SESSION.md +54 -0
- package/.agent/SESSION.template.md +46 -0
- package/.claude/CLAUDE.md +21 -6
- package/.claude/commands/build.md +5 -4
- package/.claude/commands/debug.md +2 -1
- package/.claude/commands/handoff.md +94 -0
- package/.claude/commands/plan.md +1 -0
- package/.claude/commands/publish-npm.md +119 -0
- package/.claude/commands/resume.md +107 -0
- package/.claude/commands/spec.md +2 -1
- package/.claude/references/agent-continuity.md +42 -0
- package/.claude/references/codegraph.md +50 -0
- package/.claude/rules/agent-continuity.md +39 -0
- package/.claude/skills/agent-continuity/SKILL.md +70 -0
- package/.cursor/CURSOR.md +37 -5
- package/.cursor/commands/build.md +5 -4
- package/.cursor/commands/debug.md +2 -1
- package/.cursor/commands/handoff.md +94 -0
- package/.cursor/commands/plan.md +1 -0
- package/.cursor/commands/publish-npm.md +119 -0
- package/.cursor/commands/resume.md +107 -0
- package/.cursor/commands/spec.md +2 -1
- package/.cursor/mcp.json +15 -0
- package/.cursor/references/agent-continuity.md +42 -0
- package/.cursor/references/codegraph.md +87 -0
- package/.cursor/rules/agent-continuity.mdc +44 -0
- package/.cursor/rules/codegraph.mdc +47 -0
- package/.cursor/rules/cursor-overview.mdc +10 -3
- package/.cursor/skills/agent-continuity/SKILL.md +70 -0
- package/.kiro/KIRO.md +146 -0
- package/.kiro/agents/backend.md +395 -0
- package/.kiro/agents/code-reviewer.md +110 -0
- package/.kiro/agents/copywriter-seo.md +236 -0
- package/.kiro/agents/frontend.md +384 -0
- package/.kiro/agents/project-manager.md +201 -0
- package/.kiro/agents/qa.md +221 -0
- package/.kiro/agents/security-auditor.md +143 -0
- package/.kiro/agents/systems-architect.md +211 -0
- package/.kiro/agents/test-engineer.md +123 -0
- package/.kiro/agents/ui-ux-designer.md +210 -0
- package/.kiro/commands/build.md +133 -0
- package/.kiro/commands/debug.md +243 -0
- package/.kiro/commands/deploy.md +40 -0
- package/.kiro/commands/fix-issue.md +42 -0
- package/.kiro/commands/handoff.md +94 -0
- package/.kiro/commands/plan.md +126 -0
- package/.kiro/commands/publish-npm.md +119 -0
- package/.kiro/commands/resume.md +107 -0
- package/.kiro/commands/review.md +50 -0
- package/.kiro/commands/simplify.md +222 -0
- package/.kiro/commands/spec.md +96 -0
- package/.kiro/commands/test.md +214 -0
- package/.kiro/references/accessibility-checklist.md +174 -0
- package/.kiro/references/agent-continuity.md +42 -0
- package/.kiro/references/codegraph.md +86 -0
- package/.kiro/references/performance-checklist.md +150 -0
- package/.kiro/references/security-checklist.md +94 -0
- package/.kiro/references/testing-patterns.md +183 -0
- package/.kiro/settings/mcp.json +15 -0
- package/.kiro/settings.json +8 -0
- package/.kiro/skills/agent-continuity/SKILL.md +70 -0
- package/.kiro/skills/code-review/SKILL.md +208 -0
- package/.kiro/skills/deploy/SKILL.md +68 -0
- package/.kiro/skills/deploy/deploy.md +735 -0
- package/.kiro/skills/incremental-implementation/SKILL.md +210 -0
- package/.kiro/skills/security-review/SKILL.md +71 -0
- package/.kiro/skills/tdd/SKILL.md +217 -0
- package/.kiro/skills/ui-ux-pro-max/SKILL.md +288 -0
- package/.kiro/skills/ui-ux-pro-max/data/charts.csv +26 -0
- package/.kiro/skills/ui-ux-pro-max/data/colors.csv +97 -0
- package/.kiro/skills/ui-ux-pro-max/data/icons.csv +101 -0
- package/.kiro/skills/ui-ux-pro-max/data/landing.csv +31 -0
- package/.kiro/skills/ui-ux-pro-max/data/products.csv +97 -0
- package/.kiro/skills/ui-ux-pro-max/data/react-performance.csv +45 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/astro.csv +54 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/flutter.csv +53 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/nextjs.csv +53 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/react-native.csv +52 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/react.csv +54 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/shadcn.csv +61 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/svelte.csv +54 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/swiftui.csv +51 -0
- package/.kiro/skills/ui-ux-pro-max/data/stacks/vue.csv +50 -0
- package/.kiro/skills/ui-ux-pro-max/data/styles.csv +68 -0
- package/.kiro/skills/ui-ux-pro-max/data/typography.csv +58 -0
- package/.kiro/skills/ui-ux-pro-max/data/ui-reasoning.csv +101 -0
- package/.kiro/skills/ui-ux-pro-max/data/ux-guidelines.csv +100 -0
- package/.kiro/skills/ui-ux-pro-max/data/web-interface.csv +31 -0
- package/.kiro/skills/ui-ux-pro-max/scripts/core.py +253 -0
- package/.kiro/skills/ui-ux-pro-max/scripts/design_system.py +1067 -0
- package/.kiro/skills/ui-ux-pro-max/scripts/search.py +114 -0
- package/.kiro/steering/agent-continuity.md +44 -0
- package/.kiro/steering/api-conventions.md +85 -0
- package/.kiro/steering/clean-code.md +211 -0
- package/.kiro/steering/code-style.md +92 -0
- package/.kiro/steering/codegraph.md +47 -0
- package/.kiro/steering/database.md +66 -0
- package/.kiro/steering/error-handling.md +98 -0
- package/.kiro/steering/git-workflow.md +83 -0
- package/.kiro/steering/kiro-overview.md +38 -0
- package/.kiro/steering/monitoring.md +317 -0
- package/.kiro/steering/naming-conventions.md +266 -0
- package/.kiro/steering/project-structure.md +71 -0
- package/.kiro/steering/security.md +95 -0
- package/.kiro/steering/system-design.md +168 -0
- package/.kiro/steering/tech-stack.md +462 -0
- package/.kiro/steering/testing.md +110 -0
- package/AGENTS.md +13 -7
- package/README.md +122 -18
- package/bin/class-ai-agent.cjs +165 -11
- package/package.json +10 -4
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# CodeGraph reference
|
|
2
|
+
|
|
3
|
+
[CodeGraph](https://github.com/colbymchenry/codegraph) is a local, tree-sitter–parsed knowledge graph exposed to agents via MCP. **class-ai-agent** installs Cursor and Kiro MCP wiring plus usage rules, and runs `codegraph init -i` after scaffolding.
|
|
4
|
+
|
|
5
|
+
## Cursor (included with class-ai-agent)
|
|
6
|
+
|
|
7
|
+
| Item | Path |
|
|
8
|
+
|------|------|
|
|
9
|
+
| MCP config | `.cursor/mcp.json` |
|
|
10
|
+
| Usage rules | `.cursor/rules/codegraph.mdc` |
|
|
11
|
+
| Index (generated) | `.codegraph/` (gitignored) |
|
|
12
|
+
|
|
13
|
+
1. Reload the Cursor window after install so MCP connects.
|
|
14
|
+
2. Confirm **CodeGraph** appears under MCP in Cursor settings.
|
|
15
|
+
3. Use `codegraph_*` tools for structural questions; grep/read for literal text.
|
|
16
|
+
|
|
17
|
+
**Manual index:** `npx @colbymchenry/codegraph init -i`
|
|
18
|
+
|
|
19
|
+
**Skip auto-index on install:** `CODEGRAPH_SKIP_INIT=1 npx class-ai-agent`
|
|
20
|
+
|
|
21
|
+
## Kiro (included with class-ai-agent)
|
|
22
|
+
|
|
23
|
+
| Item | Path |
|
|
24
|
+
|------|------|
|
|
25
|
+
| MCP config | `.kiro/settings/mcp.json` |
|
|
26
|
+
| Usage rules | `.kiro/steering/codegraph.md` |
|
|
27
|
+
| Index (generated) | `.codegraph/` (gitignored) |
|
|
28
|
+
|
|
29
|
+
1. Restart Kiro after install so MCP connects.
|
|
30
|
+
2. Confirm **CodeGraph** under MCP in Kiro IDE or CLI settings.
|
|
31
|
+
3. Use `codegraph_*` tools for structural questions.
|
|
32
|
+
|
|
33
|
+
See `.kiro/references/codegraph.md` for full notes.
|
|
34
|
+
|
|
35
|
+
## Claude Code
|
|
36
|
+
|
|
37
|
+
Project scaffolding does **not** add Claude MCP config. Install CodeGraph globally for Claude Code:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npx @colbymchenry/codegraph
|
|
41
|
+
# or: npm i -g @colbymchenry/codegraph
|
|
42
|
+
codegraph install --target=claude --yes
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Then in each project: `codegraph init -i` (or rely on class-ai-agent’s post-install init for the shared `.codegraph/` index).
|
|
46
|
+
|
|
47
|
+
See the [CodeGraph README](https://github.com/colbymchenry/codegraph) for tools, troubleshooting, and benchmarks.
|
|
48
|
+
|
|
49
|
+
## Requirements
|
|
50
|
+
|
|
51
|
+
- **Node 20+** recommended for CodeGraph (class-ai-agent CLI itself supports Node 16.7+).
|
|
52
|
+
- First index can take a minute on large repos; progress prints during `npx class-ai-agent` install.
|
|
53
|
+
|
|
54
|
+
## Tool parameters
|
|
55
|
+
|
|
56
|
+
| Tool | Pass | Not |
|
|
57
|
+
|------|------|-----|
|
|
58
|
+
| `codegraph_search` | `query`, optional `limit` | — |
|
|
59
|
+
| `codegraph_context` | **`task`** (natural-language area), optional **`maxNodes`** | `query`, `limit` |
|
|
60
|
+
|
|
61
|
+
Example — wrong (search-style args on context):
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{ "query": "auth flow", "limit": 15 }
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
→ `Error: task must be a non-empty string`
|
|
68
|
+
|
|
69
|
+
Example — correct:
|
|
70
|
+
|
|
71
|
+
```json
|
|
72
|
+
{ "task": "how authentication flow works", "maxNodes": 15 }
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
**Session handoff** (`/resume`, `.agent/SESSION.md`) is not a CodeGraph call — read those files with the editor Read tool.
|
|
76
|
+
|
|
77
|
+
## Troubleshooting
|
|
78
|
+
|
|
79
|
+
| Issue | Action |
|
|
80
|
+
|-------|--------|
|
|
81
|
+
| `task must be a non-empty string` | Use `task` (not `query`) on `codegraph_context`; use `maxNodes` (not `limit`). For `/resume`, read `.agent/SESSION.md` instead. |
|
|
82
|
+
| MCP “not initialized” | Run `npx @colbymchenry/codegraph init -i` in project root |
|
|
83
|
+
| MCP not connecting | Reload Cursor; verify `.cursor/mcp.json`; test `npx @colbymchenry/codegraph serve --mcp` |
|
|
84
|
+
| Stale symbols after edit | Wait ~2s for watcher sync, or check staleness banner in tool output |
|
|
85
|
+
| Init failed during install | Run `npx @colbymchenry/codegraph init -i` manually |
|
|
86
|
+
|
|
87
|
+
Upstream: [colbymchenry/codegraph](https://github.com/colbymchenry/codegraph)
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Agent session continuity — cross-tool handoff via .agent/SESSION.md"
|
|
3
|
+
alwaysApply: true
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Agent continuity
|
|
7
|
+
|
|
8
|
+
Cross-tool handoff lives in **`.agent/SESSION.md`** (committed). Cursor, Claude Code, and Kiro agents share this file.
|
|
9
|
+
|
|
10
|
+
## Session start
|
|
11
|
+
|
|
12
|
+
1. If **`.agent/SESSION.md`** exists, read it **before** planning or editing code.
|
|
13
|
+
2. When the user says **continue**, **resume**, or **pick up**, use **`.cursor/commands/resume.md`** (or equivalent in `.claude/` / `.kiro/`).
|
|
14
|
+
3. Then read **`tasks/todo.md`** and linked **SPEC** paths from SESSION **Pointers**.
|
|
15
|
+
|
|
16
|
+
**Do not** call `codegraph_context` with `query` / `limit` for session resume — that tool requires **`task`** and is for code symbols, not handoff state. For continuity, **Read** `.agent/SESSION.md` (and `tasks/todo.md`); use `codegraph_context` only when you need structural code context for the work described in SESSION.
|
|
17
|
+
|
|
18
|
+
## Session end and phase changes
|
|
19
|
+
|
|
20
|
+
1. Update **`.agent/SESSION.md`** before ending a session or switching tools — use **`.cursor/commands/handoff.md`** when possible.
|
|
21
|
+
2. Keep **Done**, **In progress**, and **Next** accurate; do not leave stale **In progress** items.
|
|
22
|
+
3. Sync **`tasks/todo.md`** checkboxes when tasks change.
|
|
23
|
+
|
|
24
|
+
## Security (SESSION.md)
|
|
25
|
+
|
|
26
|
+
**Never** store in `.agent/SESSION.md`:
|
|
27
|
+
|
|
28
|
+
- API keys, passwords, tokens, credentials
|
|
29
|
+
- PII or customer data
|
|
30
|
+
|
|
31
|
+
Use issue links, commit SHAs, and file paths instead.
|
|
32
|
+
|
|
33
|
+
## Workflow integration
|
|
34
|
+
|
|
35
|
+
| Phase | SESSION `phase` value |
|
|
36
|
+
|-------|------------------------|
|
|
37
|
+
| Spec | `spec` |
|
|
38
|
+
| Plan | `plan` |
|
|
39
|
+
| Build | `build` |
|
|
40
|
+
| Test | `test` |
|
|
41
|
+
| Review | `review` |
|
|
42
|
+
| Debug | `debug` |
|
|
43
|
+
|
|
44
|
+
Set **Meta → Tool** to `cursor`, `claude`, or `kiro` as appropriate.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: CodeGraph MCP usage guide — when to use which tool
|
|
3
|
+
alwaysApply: true
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
## CodeGraph
|
|
7
|
+
|
|
8
|
+
This project has a CodeGraph MCP server (`codegraph_*` tools) configured. CodeGraph is a tree-sitter-parsed knowledge graph of every symbol, edge, and file. Reads are sub-millisecond and return structural information grep cannot.
|
|
9
|
+
|
|
10
|
+
### When to prefer codegraph over native search
|
|
11
|
+
|
|
12
|
+
Use codegraph for **structural** questions — what calls what, what would break, where is X defined, what is X's signature. Use native grep/read only for **literal text** queries (string contents, comments, log messages) or after you already have a specific file open.
|
|
13
|
+
|
|
14
|
+
| Question | Tool |
|
|
15
|
+
|---|---|
|
|
16
|
+
| "Where is X defined?" / "Find symbol named X" | `codegraph_search` |
|
|
17
|
+
| "What calls function Y?" | `codegraph_callers` |
|
|
18
|
+
| "What does Y call?" | `codegraph_callees` |
|
|
19
|
+
| "How does X reach/become Y? / trace the flow from X to Y" | `codegraph_trace` (one call = the whole path, incl. callback/React/JSX dynamic hops) |
|
|
20
|
+
| "What would break if I changed Z?" | `codegraph_impact` |
|
|
21
|
+
| "Show me Y's signature / source / docstring" | `codegraph_node` |
|
|
22
|
+
| "Give me focused context for a task/area" | `codegraph_context` |
|
|
23
|
+
| "See several related symbols' source at once" | `codegraph_explore` |
|
|
24
|
+
| "What files exist under path/" | `codegraph_files` |
|
|
25
|
+
| "Is the index healthy?" | `codegraph_status` |
|
|
26
|
+
|
|
27
|
+
### Tool parameters (do not mix)
|
|
28
|
+
|
|
29
|
+
| Tool | Required arg | Optional cap | Wrong args → error |
|
|
30
|
+
|------|--------------|--------------|-------------------|
|
|
31
|
+
| `codegraph_search` | **`query`** (symbol name) | `limit` (default 10) | — |
|
|
32
|
+
| `codegraph_context` | **`task`** (feature/bug description) | `maxNodes` (default 20) | `query` / `limit` → **`task must be a non-empty string`** |
|
|
33
|
+
|
|
34
|
+
`codegraph_context` is for **code structure** around a task — not for loading **`.agent/SESSION.md`** or `/resume` handoff (use **Read** + `.cursor/commands/resume.md`).
|
|
35
|
+
|
|
36
|
+
### Rules of thumb
|
|
37
|
+
|
|
38
|
+
- **Answer directly — don't delegate exploration.** For "how does X work" / architecture questions, answer with 2-3 codegraph calls: `codegraph_context` first, then ONE `codegraph_explore` for the source of the symbols it surfaces. For a specific **flow** ("how does X reach Y") start with `codegraph_trace` from→to — one call returns the whole path with dynamic hops bridged — then ONE `codegraph_explore` for the bodies; don't rebuild the path with `codegraph_search` + `codegraph_callers`. Codegraph IS the pre-built index, so spawning a separate file-reading sub-task/agent — or running a grep + read loop — repeats work codegraph already did and costs more for the same answer.
|
|
39
|
+
- **Trust codegraph results.** They come from a full AST parse. Do NOT re-verify them with grep — that's slower, less accurate, and wastes context.
|
|
40
|
+
- **Don't grep first** when looking up a symbol by name. `codegraph_search` is faster and returns kind + location + signature in one call.
|
|
41
|
+
- **Don't chain `codegraph_search` + `codegraph_node`** when you just want context — `codegraph_context` is one call.
|
|
42
|
+
- **Don't loop `codegraph_node` over many symbols** — one `codegraph_explore` call returns several symbols' source grouped in a single capped call, while each separate node/Read call re-reads the whole context and costs far more.
|
|
43
|
+
- **Index lag — check the staleness banner, don't guess a wait.** When a codegraph response starts with "⚠️ Some files referenced below were edited since the last index sync…", the listed files are pending re-index — Read those specific files for accurate content. Files NOT in that banner are fresh and codegraph is authoritative for them. `codegraph_status` also lists pending files under "Pending sync".
|
|
44
|
+
|
|
45
|
+
### If `.codegraph/` doesn't exist
|
|
46
|
+
|
|
47
|
+
The MCP server returns "not initialized." Ask the user: *"I notice this project doesn't have CodeGraph initialized. Want me to run `codegraph init -i` to build the index?"*
|
|
@@ -18,18 +18,25 @@ Use the same phase order as in `.cursor/CURSOR.md`:
|
|
|
18
18
|
5. **Review** — `.cursor/commands/review.md` (five-axis: `.cursor/skills/code-review/`)
|
|
19
19
|
6. **Ship** — `.cursor/commands/deploy.md`
|
|
20
20
|
|
|
21
|
-
Supporting prompts: `debug`, `simplify`, `fix-issue` in `.cursor/commands/`.
|
|
21
|
+
Supporting prompts: `debug`, `simplify`, `fix-issue`, `handoff`, `resume` in `.cursor/commands/`. Maintainers: `publish-npm` (say **push to npm repo** to draft README release notes and publish).
|
|
22
|
+
|
|
23
|
+
**Agent continuity:** committed **`.agent/SESSION.md`** — read at session start (`/resume`), update at end (`/handoff`). See **`.cursor/rules/agent-continuity.mdc`**.
|
|
22
24
|
|
|
23
25
|
## Mandatory standards
|
|
24
26
|
|
|
25
27
|
- Follow **`.cursor/rules/`** (`.mdc`). **`security.mdc`** is always applied; other rule files apply when matching globs are in scope (see each file’s frontmatter).
|
|
26
28
|
- Prefer **tests first** and **small vertical slices** (see `.cursor/skills/incremental-implementation/`).
|
|
27
29
|
- Use **`.cursor/references/`** for checklists (security, testing, performance, accessibility).
|
|
30
|
+
- For **structural** code questions (symbols, callers, callees, traces, impact), prefer **CodeGraph** MCP tools (`codegraph_*`) per **`.cursor/rules/codegraph.mdc`** instead of grep/read exploration loops.
|
|
28
31
|
|
|
29
32
|
## Agents (personas)
|
|
30
33
|
|
|
31
34
|
Specialized instructions live in **`.cursor/agents/`**. In Cursor, **@ mention** the file you want (e.g. `@.cursor/agents/code-reviewer.md`) when you need that role.
|
|
32
35
|
|
|
33
|
-
## Relation to `.claude/`
|
|
36
|
+
## Relation to `.claude/` and `.kiro/`
|
|
37
|
+
|
|
38
|
+
- **`.claude/`** — Claude Code
|
|
39
|
+
- **`.cursor/`** — Cursor
|
|
40
|
+
- **`.kiro/`** — Kiro (steering + MCP; sync from `.cursor/` via `npm run sync:kiro`)
|
|
34
41
|
|
|
35
|
-
|
|
42
|
+
Keep all three aligned when you change workflows or standards.
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Agent Continuity
|
|
3
|
+
description: Cross-tool session handoff and resume via .agent/SESSION.md
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Agent Continuity Skill
|
|
7
|
+
|
|
8
|
+
## Purpose
|
|
9
|
+
|
|
10
|
+
Keep **Cursor**, **Claude Code**, and **Kiro** aligned on the same in-flight work using committed **`.agent/SESSION.md`**.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## When to apply
|
|
15
|
+
|
|
16
|
+
| Situation | Action |
|
|
17
|
+
|-----------|--------|
|
|
18
|
+
| New chat, same feature | **Resume** — read SESSION first |
|
|
19
|
+
| End of session | **Handoff** — update SESSION |
|
|
20
|
+
| Switch IDE/tool | **Handoff** then **Resume** in new tool |
|
|
21
|
+
| Switch persona | Update Meta `persona`; handoff notes for next role |
|
|
22
|
+
| Phase change (plan → build) | Update Meta `phase` |
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
## Handoff checklist
|
|
27
|
+
|
|
28
|
+
- [ ] Meta: date, phase, tool, persona
|
|
29
|
+
- [ ] Goal still accurate (one paragraph)
|
|
30
|
+
- [ ] Done: bullets with paths/commits
|
|
31
|
+
- [ ] In progress + blockers
|
|
32
|
+
- [ ] Next: numbered for next agent
|
|
33
|
+
- [ ] Decisions: non-obvious choices
|
|
34
|
+
- [ ] Gotchas: failures, test commands, env
|
|
35
|
+
- [ ] Pointers: spec, tasks, branch, key files
|
|
36
|
+
- [ ] `tasks/todo.md` synced
|
|
37
|
+
- [ ] No secrets or PII in SESSION
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Resume checklist
|
|
42
|
+
|
|
43
|
+
- [ ] Read `.agent/SESSION.md`
|
|
44
|
+
- [ ] Read `tasks/todo.md` if linked
|
|
45
|
+
- [ ] Read SPEC if linked
|
|
46
|
+
- [ ] `git status` vs SESSION expectations
|
|
47
|
+
- [ ] Run sanity build/test if Gotchas say so
|
|
48
|
+
- [ ] Post resumption summary to user
|
|
49
|
+
- [ ] Execute first **Next** step via workflow command
|
|
50
|
+
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
## SESSION schema
|
|
54
|
+
|
|
55
|
+
See **`.agent/SESSION.template.md`** for the canonical sections.
|
|
56
|
+
|
|
57
|
+
---
|
|
58
|
+
|
|
59
|
+
## Commands
|
|
60
|
+
|
|
61
|
+
| Command | File |
|
|
62
|
+
|---------|------|
|
|
63
|
+
| `/handoff` | `.cursor/commands/handoff.md` (`.claude/`, `.kiro/`) |
|
|
64
|
+
| `/resume` | `.cursor/commands/resume.md` |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Optional history
|
|
69
|
+
|
|
70
|
+
Copy SESSION to `.agent/history/YYYY-MM-DD-slug.md` at milestones; commit for audit trail.
|
package/.kiro/KIRO.md
ADDED
|
@@ -0,0 +1,146 @@
|
|
|
1
|
+
# Kiro AI agent configuration
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This project uses **Kiro** with the same structured workflows, specialized agent personas, and coding standards as **`.claude/`** and **`.cursor/`**. Kiro-specific files live under **`.kiro/`**.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Development workflow
|
|
10
|
+
|
|
11
|
+
Follow this workflow for feature development:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
/spec → /plan → /build → /test → /review → Ship
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
| Phase | Prompt source | Purpose |
|
|
18
|
+
|-------|----------------|--------|
|
|
19
|
+
| **Define** | `.kiro/commands/spec.md` | PRD: objectives, scope, boundaries |
|
|
20
|
+
| **Plan** | `.kiro/commands/plan.md` | Vertical slices, acceptance criteria |
|
|
21
|
+
| **Build** | `.kiro/commands/build.md` | Incremental implementation, TDD |
|
|
22
|
+
| **Verify** | `.kiro/commands/test.md` | Tests and verification |
|
|
23
|
+
| **Review** | `.kiro/commands/review.md` | Five-axis review before merge |
|
|
24
|
+
| **Ship** | `.kiro/commands/deploy.md` | Build, test, deploy |
|
|
25
|
+
|
|
26
|
+
### Supporting prompts
|
|
27
|
+
|
|
28
|
+
| File | Purpose |
|
|
29
|
+
|------|---------|
|
|
30
|
+
| `commands/debug.md` | Systematic diagnosis |
|
|
31
|
+
| `commands/simplify.md` | Reduce complexity, same behavior |
|
|
32
|
+
| `commands/fix-issue.md` | Analyze and fix reported issues |
|
|
33
|
+
| `commands/handoff.md` | End session — update `.agent/SESSION.md` for cross-tool continuity |
|
|
34
|
+
| `commands/resume.md` | Start session — load `.agent/SESSION.md` and continue prior work |
|
|
35
|
+
| `commands/publish-npm.md` | **Maintainers:** draft release notes, bump version, update README, publish to npm |
|
|
36
|
+
|
|
37
|
+
**How to use:** Open the markdown file, copy the section you need, or **#steering reference or paste from** the file in Chat/Composer so the model loads it.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## Core principles
|
|
42
|
+
|
|
43
|
+
- **TDD** — Failing tests first, then implementation (`.kiro/skills/tdd/`)
|
|
44
|
+
- **Incremental implementation** — Small vertical slices (`.kiro/skills/incremental-implementation/`)
|
|
45
|
+
- **Five-axis review** — Correctness, readability, architecture, security, performance (`.kiro/skills/code-review/`)
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
## Mandatory standards (steering)
|
|
50
|
+
|
|
51
|
+
Project standards are **`.kiro/steering/*.md`**. They use YAML frontmatter:
|
|
52
|
+
|
|
53
|
+
- **`inclusion: always`** — Loaded every session (`kiro-overview.md`, `security.md`, `codegraph.md`, `agent-continuity.md`)
|
|
54
|
+
- **`inclusion: fileMatch`** — Loaded when edited files match `fileMatchPattern`
|
|
55
|
+
- **`inclusion: manual`** — Reference with `#filename` in chat or `/` slash commands
|
|
56
|
+
|
|
57
|
+
| Topic | Rule file |
|
|
58
|
+
|-------|-----------|
|
|
59
|
+
| Clean code, style, errors | `clean-code`, `code-style`, `error-handling` |
|
|
60
|
+
| Stack, structure, APIs | `tech-stack`, `project-structure`, `api-conventions` |
|
|
61
|
+
| Data & naming | `naming-conventions`, `database` |
|
|
62
|
+
| Ops & quality | `security`, `monitoring`, `testing`, `git-workflow`, `system-design` |
|
|
63
|
+
| Code intelligence | `codegraph` (MCP usage; see below) |
|
|
64
|
+
| Agent continuity | `agent-continuity` (`.agent/SESSION.md` handoff) |
|
|
65
|
+
|
|
66
|
+
---
|
|
67
|
+
|
|
68
|
+
## Agent continuity
|
|
69
|
+
|
|
70
|
+
Cross-tool handoff lives in **`.agent/SESSION.md`** (committed). Use **`/resume`** at session start and **`/handoff`** at session end when switching chats or tools. See **`.kiro/references/agent-continuity.md`** and **`.kiro/steering/agent-continuity.md`**.
|
|
71
|
+
|
|
72
|
+
---
|
|
73
|
+
|
|
74
|
+
## Code intelligence (CodeGraph)
|
|
75
|
+
|
|
76
|
+
This project includes **[CodeGraph](https://github.com/colbymchenry/codegraph)** for local, structural code search via MCP.
|
|
77
|
+
|
|
78
|
+
| Item | Location |
|
|
79
|
+
|------|----------|
|
|
80
|
+
| MCP server config | `.kiro/settings/mcp.json` |
|
|
81
|
+
| Usage rules | `.kiro/steering/codegraph.md` |
|
|
82
|
+
| Symbol index (generated) | `.codegraph/` (gitignored) |
|
|
83
|
+
| Setup reference | `.kiro/references/codegraph.md` |
|
|
84
|
+
|
|
85
|
+
After installing scaffolding, **restart Kiro** so the CodeGraph MCP server connects. Use `codegraph_*` tools for structural questions (callers, callees, traces, impact); use grep/read for literal text in comments or strings.
|
|
86
|
+
|
|
87
|
+
If the index is missing, run `npx @colbymchenry/codegraph init -i` in the project root.
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Agent personas
|
|
92
|
+
|
|
93
|
+
Instructions live in **`.kiro/agents/`**. Invoke by **referencing** the file (e.g. `@.kiro/agents/backend.md`).
|
|
94
|
+
|
|
95
|
+
| Area | File |
|
|
96
|
+
|------|------|
|
|
97
|
+
| Frontend, backend, architecture | `frontend.md`, `backend.md`, `systems-architect.md` |
|
|
98
|
+
| Quality | `code-reviewer.md`, `test-engineer.md`, `qa.md`, `security-auditor.md` |
|
|
99
|
+
| Product & content | `project-manager.md`, `ui-ux-designer.md`, `copywriter-seo.md` |
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## Skills
|
|
104
|
+
|
|
105
|
+
Reusable playbooks: **`.kiro/skills/*/SKILL.md`** (and related `.md` files where present).
|
|
106
|
+
|
|
107
|
+
| Skill | Use for |
|
|
108
|
+
|-------|---------|
|
|
109
|
+
| `tdd` | Red–green–refactor |
|
|
110
|
+
| `code-review` | Five-axis review |
|
|
111
|
+
| `incremental-implementation` | Vertical slices |
|
|
112
|
+
| `deploy` | Deployment pipeline |
|
|
113
|
+
| `security-review` | Security audit |
|
|
114
|
+
| `agent-continuity` | Cross-tool session handoff via `.agent/SESSION.md` |
|
|
115
|
+
|
|
116
|
+
---
|
|
117
|
+
|
|
118
|
+
## Reference checklists
|
|
119
|
+
|
|
120
|
+
**`.kiro/references/`**
|
|
121
|
+
|
|
122
|
+
| File | Use for |
|
|
123
|
+
|------|---------|
|
|
124
|
+
| `security-checklist.md` | Pre-deploy security |
|
|
125
|
+
| `testing-patterns.md` | Test structure |
|
|
126
|
+
| `performance-checklist.md` | Performance |
|
|
127
|
+
| `accessibility-checklist.md` | WCAG-oriented checks |
|
|
128
|
+
| `codegraph.md` | CodeGraph setup (Kiro, Cursor, Claude Code) |
|
|
129
|
+
| `agent-continuity.md` | Session handoff and `/resume` / `/handoff` |
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Config parity
|
|
134
|
+
|
|
135
|
+
**`.kiro/settings.json`** lists directories (mirrors `.cursor/settings.json`). Kiro loads **`.kiro/steering/*.md`**, root **`AGENTS.md`**, and **`.kiro/settings/mcp.json`**.
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
## Agent behavior
|
|
140
|
+
|
|
141
|
+
1. Follow the workflow and use the command prompts when starting a phase.
|
|
142
|
+
2. If **`.agent/SESSION.md`** exists, read it before planning or coding; run **`/resume`** when continuing prior work.
|
|
143
|
+
3. Apply **`.kiro/steering/`**; treat **`security.md`** as non-negotiable.
|
|
144
|
+
4. Prefer tests first and small, buildable changes.
|
|
145
|
+
5. **#steering reference or paste from** the right **`.kiro/agents/`** file when the task matches that role.
|
|
146
|
+
6. Update **`.agent/SESSION.md`** (or **`/handoff`**) before ending a session.
|