ai-engineering-kit 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/NOTICE +33 -0
- package/README.md +65 -0
- package/dist/cli.js +675 -0
- package/package.json +56 -0
- package/template/agents/claude-code.CLAUDE.md +88 -0
- package/template/agents/codex.AGENTS.md +82 -0
- package/template/ai-workspace/brainstorms/.gitkeep +0 -0
- package/template/ai-workspace/plans/.gitkeep +0 -0
- package/template/ai-workspace/prds/.gitkeep +0 -0
- package/template/ai-workspace/research/.gitkeep +0 -0
- package/template/ai-workspace/reviews/.gitkeep +0 -0
- package/template/ai-workspace/runbooks/.gitkeep +0 -0
- package/template/ai-workspace/templates/.gitkeep +0 -0
- package/template/docs/foundations/product-vision.md +21 -0
- package/template/docs/foundations/project-guidelines.md +19 -0
- package/template/docs/foundations/technical-decisions.md +50 -0
- package/template/docs/foundations/testing-principles.md +13 -0
- package/template/skills/core-workflow/audit-architecture/REFERENCE.md +78 -0
- package/template/skills/core-workflow/audit-architecture/SKILL.md +76 -0
- package/template/skills/core-workflow/explore-design/SKILL.md +94 -0
- package/template/skills/core-workflow/implement/SKILL.md +107 -0
- package/template/skills/core-workflow/implement/deep-modules.md +33 -0
- package/template/skills/core-workflow/implement/interface-design.md +31 -0
- package/template/skills/core-workflow/implement/mocking.md +59 -0
- package/template/skills/core-workflow/implement/refactoring.md +10 -0
- package/template/skills/core-workflow/implement/tests.md +61 -0
- package/template/skills/core-workflow/investigate-bug/SKILL.md +104 -0
- package/template/skills/core-workflow/kickoff/SKILL.md +10 -0
- package/template/skills/core-workflow/load-context/SKILL.md +26 -0
- package/template/skills/core-workflow/plan-feature/SKILL.md +107 -0
- package/template/skills/core-workflow/plan-refactor/SKILL.md +68 -0
- package/template/skills/core-workflow/review/SKILL.md +127 -0
- package/template/skills/core-workflow/setup-foundations/SKILL.md +58 -0
- package/template/skills/core-workflow/verify-completion/SKILL.md +20 -0
- package/template/skills/core-workflow/write-prd/SKILL.md +74 -0
- package/template/skills/core-workflow/write-skill/SKILL.md +117 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Ebert Mota
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/NOTICE
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
ai-engineering-kit
|
|
2
|
+
Copyright (c) 2026 Ebert Mota
|
|
3
|
+
|
|
4
|
+
This product includes skills derived from "Skills For Real Engineers"
|
|
5
|
+
(mattpocock/skills): https://github.com/mattpocock/skills
|
|
6
|
+
|
|
7
|
+
The skill buckets under the engineering/, productivity/, and misc/ categories
|
|
8
|
+
are forked from, or inspired by, that project. Those skills are distributed
|
|
9
|
+
under the following license and remain the copyright of their original author.
|
|
10
|
+
|
|
11
|
+
-------------------------------------------------------------------------------
|
|
12
|
+
MIT License
|
|
13
|
+
|
|
14
|
+
Copyright (c) 2026 Matt Pocock
|
|
15
|
+
|
|
16
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
17
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
18
|
+
in the Software without restriction, including without limitation the rights
|
|
19
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
20
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
21
|
+
furnished to do so, subject to the following conditions:
|
|
22
|
+
|
|
23
|
+
The above copyright notice and this permission notice shall be included in all
|
|
24
|
+
copies or substantial portions of the Software.
|
|
25
|
+
|
|
26
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
27
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
28
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
29
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
30
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
31
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
32
|
+
SOFTWARE.
|
|
33
|
+
-------------------------------------------------------------------------------
|
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# ai-engineering-kit
|
|
2
|
+
|
|
3
|
+
> An opinionated, agent-agnostic AI-development kit — disciplined skills plus a structured workspace — installed and updated through one `npx` command.
|
|
4
|
+
|
|
5
|
+
## What it is
|
|
6
|
+
|
|
7
|
+
`ai-engineering-kit` scaffolds a repeatable workflow for building software with AI coding agents:
|
|
8
|
+
|
|
9
|
+
- **Skills** — Markdown playbooks for each step: kickoff → foundations → PRD → plan → TDD → review → verify.
|
|
10
|
+
- **A structured workspace** — `ai/` for ephemeral artifacts (brainstorms, PRDs, plans, reviews) and `docs/foundations/` for canonical, long-lived project knowledge.
|
|
11
|
+
- **Agent-agnostic wiring** — skills live as portable Markdown in `ai/skills/`; the kit generates the entry file each agent reads (`CLAUDE.md` + a `.claude/skills/` symlink for Claude Code, `AGENTS.md` for Codex). More agents are a template + a manifest entry away.
|
|
12
|
+
|
|
13
|
+
## Quickstart
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx ai-engineering-kit
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Run with no arguments for an interactive install: pick which **components** (skills / docs / workspace / entry-files), which **skill categories**, and which **agents** to wire up. The kit previews exactly what it will write, then scaffolds your selection and records it in a `.ai-kit.json` manifest.
|
|
20
|
+
|
|
21
|
+
### Non-interactive
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# scaffold a chosen set without prompts
|
|
25
|
+
npx ai-engineering-kit init --name "My App" \
|
|
26
|
+
--components skills,docs-foundations,entry-files \
|
|
27
|
+
--categories core-workflow \
|
|
28
|
+
--agents claude-code,codex
|
|
29
|
+
|
|
30
|
+
# or everything
|
|
31
|
+
npx ai-engineering-kit init --all --name "My App"
|
|
32
|
+
|
|
33
|
+
# preview a plan without writing anything
|
|
34
|
+
npx ai-engineering-kit --dry-run --all
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Updating & adding parts
|
|
38
|
+
|
|
39
|
+
Re-run the command in a project that already has the kit and it becomes **state-aware** (it reads `.ai-kit.json`):
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npx ai-engineering-kit # interactive: Add parts / Update to latest / both
|
|
43
|
+
npx ai-engineering-kit update # refresh installed parts to the latest version
|
|
44
|
+
npx ai-engineering-kit add --components ai-workspace # add a part later
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
Updates are **conflict-aware**: files you never touched refresh silently, and any file you edited is surfaced as a conflict with a per-file choice — **overwrite** with the new version, **keep mine**, or keep mine and save theirs as `<file>.new`. Files you added yourself are always preserved. The non-interactive `update` keeps your edits by default.
|
|
48
|
+
|
|
49
|
+
## Reproducibility
|
|
50
|
+
|
|
51
|
+
The template content is bundled inside the package and versioned with it, so a pinned version always produces the same scaffold:
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
npx ai-engineering-kit@1.4.0 init --all
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Credits & attribution
|
|
58
|
+
|
|
59
|
+
`ai-engineering-kit` is **inspired by and forks skills from [Matt Pocock's `mattpocock/skills`](https://github.com/mattpocock/skills)** ("Skills For Real Engineers"), distributed under the MIT License. The `engineering/`, `productivity/`, and `misc/` skill categories are derived from that work. See [`NOTICE`](./NOTICE) for the retained copyright and license.
|
|
60
|
+
|
|
61
|
+
Matt's newsletter: https://www.aihero.dev/s/skills-newsletter
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
[MIT](./LICENSE) © Ebert Mota. Forked skills remain © their original authors — see [`NOTICE`](./NOTICE).
|