thachvd-kit 1.0.19 → 1.0.20
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/docs/architecture.md +3 -2
- package/.agent/docs/conventions.md +1 -1
- package/.agent/docs/tooling.md +5 -8
- package/.agent/skills/project-onboarding/SKILL.md +1 -1
- package/.agent/skills/using-git-worktrees/SKILL.md +2 -3
- package/.agent/skills/writing-skills/SKILL.md +170 -110
- package/.agent/workflows/review.md +125 -0
- package/.agent/workflows/spec.md +140 -0
- package/README.md +45 -44
- package/bin/cli.js +323 -311
- package/kit/README.md +2 -1
- package/package.json +1 -1
- package/skills/code-review-checklist/SKILL.md +142 -109
- package/skills/project-onboarding/SKILL.md +1 -1
- package/skills/tdd-workflow/SKILL.md +25 -1
- package/skills/using-git-worktrees/SKILL.md +2 -3
- package/skills/verification-before-completion/SKILL.md +24 -10
- package/skills/writing-skills/SKILL.md +170 -110
package/README.md
CHANGED
|
@@ -19,45 +19,46 @@ thachvd-kit
|
|
|
19
19
|
```
|
|
20
20
|
|
|
21
21
|
By default, `thachvd-kit` scans the current project, generates shared AI-agent files, installs/configures Codegraph when needed, and configures Context7, Codegraph, and Playwright MCP for local AI clients. Use `--no-setup-mcp` to skip machine-level MCP setup.
|
|
22
|
-
|
|
23
|
-
## What `init` Generates
|
|
24
|
-
|
|
25
|
-
- `AGENTS.md`: shared entry instructions for Codex, Antigravity,
|
|
26
|
-
- `CLAUDE.md`: Claude Code entry file that imports `AGENTS.md`.
|
|
27
|
-
- `GEMINI.md`: Antigravity entry file that points to `AGENTS.md`.
|
|
28
|
-
- `.
|
|
22
|
+
|
|
23
|
+
## What `init` Generates
|
|
24
|
+
|
|
25
|
+
- `AGENTS.md`: shared entry instructions for Codex, Antigravity, Claude Code, and Cursor.
|
|
26
|
+
- `CLAUDE.md`: Claude Code entry file that imports `AGENTS.md`.
|
|
27
|
+
- `GEMINI.md`: Antigravity entry file that points to `AGENTS.md`.
|
|
28
|
+
- `.cursorrules`: Cursor entry file that points to `AGENTS.md`.
|
|
29
|
+
- `.agent/docs/project.md`: stack, commands, routing, and scan evidence.
|
|
29
30
|
- `.agent/docs/architecture.md`: architecture map and maintenance rule.
|
|
30
31
|
- `.agent/docs/conventions.md`: coding and verification conventions.
|
|
31
32
|
- `.agent/docs/workflow.md`: repeatable task flow for future AI work.
|
|
32
33
|
- `.agent/docs/tooling.md`: setup hints for Playwright, codegraph, and native Codex/Claude skill folders.
|
|
33
34
|
- `.agent/agents`, `.agent/skills`, `.agent/workflows`, `.agent/rules`.
|
|
34
|
-
-
|
|
35
|
+
- `~/.codex/skills/`: selected Codex skills copied to the global user dir.
|
|
35
36
|
- `.claude/skills`: selected Claude Code project skills copied from the kit.
|
|
36
|
-
|
|
37
|
-
## Why Docs Live Under `.agent/docs`
|
|
38
|
-
|
|
39
|
-
Root instruction files are loaded often, so they should stay short and stable. Project-specific details belong in `.agent/docs/`:
|
|
40
|
-
|
|
41
|
-
- update `project.md` when stack, scripts, or tooling changes;
|
|
42
|
-
- update `architecture.md` when structure or boundaries change;
|
|
43
|
-
- update `conventions.md` when repeated patterns become clear;
|
|
44
|
-
- update `workflow.md` when the repo needs special task steps.
|
|
45
|
-
|
|
46
|
-
`AGENTS.md` tells every AI agent to read these docs before coding. If a doc contains `TODO: refine`, the agent should scan the repository and update the doc before product code changes.
|
|
47
|
-
|
|
37
|
+
|
|
38
|
+
## Why Docs Live Under `.agent/docs`
|
|
39
|
+
|
|
40
|
+
Root instruction files are loaded often, so they should stay short and stable. Project-specific details belong in `.agent/docs/`:
|
|
41
|
+
|
|
42
|
+
- update `project.md` when stack, scripts, or tooling changes;
|
|
43
|
+
- update `architecture.md` when structure or boundaries change;
|
|
44
|
+
- update `conventions.md` when repeated patterns become clear;
|
|
45
|
+
- update `workflow.md` when the repo needs special task steps.
|
|
46
|
+
|
|
47
|
+
`AGENTS.md` tells every AI agent to read these docs before coding. If a doc contains `TODO: refine`, the agent should scan the repository and update the doc before product code changes.
|
|
48
|
+
|
|
48
49
|
## Platform Notes
|
|
49
50
|
|
|
50
51
|
- Codex reads `AGENTS.md`.
|
|
51
52
|
- Claude Code reads `CLAUDE.md`; this kit uses `@AGENTS.md` inside `CLAUDE.md` so Claude shares the same rules.
|
|
52
53
|
- Antigravity can use `GEMINI.md`; this kit points it back to the shared `AGENTS.md`.
|
|
53
|
-
- `.agent/skills` is committed shared knowledge. `thachvd-kit` also copies selected native skills into
|
|
54
|
+
- `.agent/skills` is committed shared knowledge. `thachvd-kit` also copies selected native skills into `~/.codex/skills/` for Codex and `.claude/skills` for Claude Code.
|
|
54
55
|
|
|
55
56
|
## Skill Usage Best Practice
|
|
56
57
|
|
|
57
58
|
Skills work best through progressive disclosure: the agent should first see skill names and descriptions, then read only the matching `SKILL.md` body.
|
|
58
59
|
|
|
59
60
|
- Keep `.agent/skills` as the complete shared source from the kit.
|
|
60
|
-
- Let `thachvd-kit` copy selected skills to
|
|
61
|
+
- Let `thachvd-kit` copy selected skills to `~/.codex/skills/` for Codex and `.claude/skills` for Claude Code.
|
|
61
62
|
- Make every `SKILL.md` frontmatter `description` specific: include when to use it, trigger phrases, and boundaries.
|
|
62
63
|
- Run `thachvd-kit --help` to see a compact workflow guide without adding that guidance to every agent context. It recommends when to use `/brainstorm`, `/plan`, `/create`, `/enhance`, `/debug`, `/test`, `/preview`, `/deploy`, `/status`, and `/orchestrate`.
|
|
63
64
|
- Use explicit prompts when implicit matching misses, for example `Use $webapp-testing to verify this UI` or `Use $clean-code before refactoring`.
|
|
@@ -73,37 +74,37 @@ Skills work best through progressive disclosure: the agent should first see skil
|
|
|
73
74
|
- Gemini/Antigravity MCP: uses `mcp_config.json` with a top-level `mcpServers` object. The generated config includes `codegraph`, `context7`, and `playwright`.
|
|
74
75
|
- Claude Code MCP: uses `~/.claude.json` with a top-level `mcpServers` object.
|
|
75
76
|
- Codegraph indexes: `.codegraph/` is local state and should not be committed.
|
|
76
|
-
- Native skills: Codex
|
|
77
|
-
|
|
78
|
-
## Directory Layout
|
|
79
|
-
|
|
80
|
-
```text
|
|
81
|
-
.agent/
|
|
82
|
-
├── agents/
|
|
83
|
-
├── docs/
|
|
77
|
+
- Native skills: Codex global skills live in `~/.codex/skills/`, Claude Code project skills live in `.claude/skills/`, and the full shared source remains in `.agent/skills/`.
|
|
78
|
+
|
|
79
|
+
## Directory Layout
|
|
80
|
+
|
|
81
|
+
```text
|
|
82
|
+
.agent/
|
|
83
|
+
├── agents/
|
|
84
|
+
├── docs/
|
|
84
85
|
│ ├── architecture.md
|
|
85
86
|
│ ├── conventions.md
|
|
86
87
|
│ ├── project.md
|
|
87
88
|
│ ├── tooling.md
|
|
88
89
|
│ └── workflow.md
|
|
89
|
-
├── rules/
|
|
90
|
-
├── skills/
|
|
90
|
+
├── rules/
|
|
91
|
+
├── skills/
|
|
91
92
|
└── workflows/
|
|
92
93
|
```
|
|
93
94
|
|
|
94
|
-
The generated project
|
|
95
|
+
The generated project copies selected native skills to global user folder and project folder:
|
|
95
96
|
|
|
96
97
|
```text
|
|
97
|
-
|
|
98
|
+
~/.codex/skills/
|
|
98
99
|
.claude/skills/
|
|
99
100
|
```
|
|
100
|
-
|
|
101
|
-
## Development
|
|
102
|
-
|
|
103
|
-
```bash
|
|
104
|
-
npm install
|
|
105
|
-
npm test
|
|
106
|
-
npm pack --dry-run
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
The npm package page updates only after `npm publish`.
|
|
101
|
+
|
|
102
|
+
## Development
|
|
103
|
+
|
|
104
|
+
```bash
|
|
105
|
+
npm install
|
|
106
|
+
npm test
|
|
107
|
+
npm pack --dry-run
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
The npm package page updates only after `npm publish`.
|