kiro-kit 0.1.0 → 0.1.3
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/README.md +133 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
<div align="center">
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/kiro-kit)
|
|
4
|
+
[](https://github.com/ihatesea69/kiro-kit/blob/main/LICENSE)
|
|
5
|
+
[](https://www.npmjs.com/package/kiro-kit)
|
|
6
|
+
[](https://nodejs.org)
|
|
7
|
+
[](https://github.com/ihatesea69/kiro-kit/actions/workflows/ci.yml)
|
|
8
|
+
|
|
9
|
+
</div>
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
npx kiro-kit init
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Pick from 6 curated presets, confirm, and your `.kiro/` workspace is ready. Agents, skills, commands, hooks, workflows, MCP servers, statusline, and spec templates — all configured and bundled in the install.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
# or install globally
|
|
23
|
+
npm install -g kiro-kit
|
|
24
|
+
kiro-kit init
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Why kiro-kit
|
|
28
|
+
|
|
29
|
+
Most "AI coding kits" are dotfile dumps. This one wires the whole software lifecycle into a single workflow that humans and AI both read: requirements, design, tasks, code, tests — with formal correctness properties as the glue.
|
|
30
|
+
|
|
31
|
+
Pick a preset, run one command, get a workspace where AI agents act like senior teammates instead of intern auto-completers.
|
|
32
|
+
|
|
33
|
+
## Presets
|
|
34
|
+
|
|
35
|
+
| Preset | Stack | Highlights |
|
|
36
|
+
| ------------ | ------------------------------------ | --------------------------------------------------------------------------- |
|
|
37
|
+
| `frontend` | React, Next.js, TypeScript | 20 agents, 21 skills, 30 commands tuned for components, a11y, performance |
|
|
38
|
+
| `backend` | Node, Python, Go APIs | 19 agents, 20 skills, 29 commands for API design, databases, auth, deploy |
|
|
39
|
+
| `fullstack` | Next.js, T3 stack | 20 agents, 22 skills, 30 commands plus payment and Shopify integration |
|
|
40
|
+
| `mobile` | Flutter, React Native | 23 agents, 25 skills, 30 commands for mobile-first patterns and ai-multimodal |
|
|
41
|
+
| `devops` | Docker, Kubernetes, Terraform | 20 agents, 24 skills, 30 commands plus container scanning and IaC workflows |
|
|
42
|
+
| `data-ai` | Python, ML, AI agents | 20 agents, 32 skills, 35 commands for Pandas, PyTorch, Jupyter, Google ADK |
|
|
43
|
+
|
|
44
|
+
Every preset ships **self-contained**: agents, skills, commands, cross-platform hooks, workflows, statusline scripts, MCP server templates, and spec scaffolding.
|
|
45
|
+
|
|
46
|
+
## Commands
|
|
47
|
+
|
|
48
|
+
| Command | What it does |
|
|
49
|
+
| ------------------------ | ------------------------------------------------------- |
|
|
50
|
+
| `kiro-kit init` | Interactive preset picker and workspace bootstrap |
|
|
51
|
+
| `kiro-kit add <preset>` | Drop another preset into an existing workspace |
|
|
52
|
+
| `kiro-kit list` | See all presets with artifact counts |
|
|
53
|
+
| `kiro-kit info <preset>` | Detailed preset contents and file targets |
|
|
54
|
+
| `kiro-kit update` | Pull latest preset version into your workspace |
|
|
55
|
+
| `kiro-kit restore` | Roll back from a timestamped backup |
|
|
56
|
+
| `kiro-kit doctor` | Health check (8 validations, `--fix` auto-repairs) |
|
|
57
|
+
| `kiro-kit telemetry` | Manage opt-in usage telemetry (off by default) |
|
|
58
|
+
|
|
59
|
+
### Common flags
|
|
60
|
+
|
|
61
|
+
```
|
|
62
|
+
-y, --yes Skip confirmation prompts
|
|
63
|
+
--force Overwrite all conflicts (with backup)
|
|
64
|
+
--skip-existing Skip files that already exist
|
|
65
|
+
--no-color Disable ANSI output
|
|
66
|
+
-v, --verbose Verbose logging
|
|
67
|
+
-q, --quiet Errors only
|
|
68
|
+
--json Machine-readable output (list, info)
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## How it works
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
1. Pick presets 2. Resolve conflicts 3. Workspace ready
|
|
75
|
+
┌─────────┐ ┌──────────────┐ ┌───────────┐
|
|
76
|
+
│ frontend│ ────► │ Backup + │ ────► │ .kiro/ │
|
|
77
|
+
│ devops │ │ Atomic write │ │ Live │
|
|
78
|
+
└─────────┘ └──────────────┘ └───────────┘
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Three principles drive every design decision:
|
|
82
|
+
|
|
83
|
+
- **Bundled, not fetched** — all presets ship in the npm tarball. Works offline after install.
|
|
84
|
+
- **User-priority merge** — existing user content is never silently overwritten. Conflicts always prompt.
|
|
85
|
+
- **Atomic writes** — temp file plus rename guarantees no partial state on crash or interrupt.
|
|
86
|
+
|
|
87
|
+
## Built for real workflows
|
|
88
|
+
|
|
89
|
+
- Cross-platform hooks (`.js` primary, `.sh` and `.ps1` fallbacks)
|
|
90
|
+
- 4-option conflict resolution (overwrite, skip, view diff, overwrite all)
|
|
91
|
+
- Timestamped backups with `restore` and `restore --list`
|
|
92
|
+
- Tracking file (`.kiro/.kiro-kit.json`) records what came from where
|
|
93
|
+
- Property-based tests verify invariants (round-trips, commutativity, idempotency)
|
|
94
|
+
- Structural tests enforce minimum thresholds across all 6 presets
|
|
95
|
+
|
|
96
|
+
## Privacy
|
|
97
|
+
|
|
98
|
+
Telemetry is **off by default**. Nothing leaves your machine unless you explicitly opt in.
|
|
99
|
+
|
|
100
|
+
```bash
|
|
101
|
+
kiro-kit telemetry status # Check current state
|
|
102
|
+
kiro-kit telemetry enable # Opt in (anonymous events only)
|
|
103
|
+
kiro-kit telemetry disable # Opt out
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
Opt-in events include command name, preset selection, OS, and Node version. Never file contents, paths, or PII.
|
|
107
|
+
|
|
108
|
+
## Requirements
|
|
109
|
+
|
|
110
|
+
- Node.js 18 or later
|
|
111
|
+
- pnpm, npm, or yarn (only one needed for `npx`)
|
|
112
|
+
|
|
113
|
+
## Contributing
|
|
114
|
+
|
|
115
|
+
Got an idea for a new preset, or want to improve an existing one? See [CONTRIBUTING.md](https://github.com/ihatesea69/kiro-kit/blob/main/CONTRIBUTING.md) and [docs/creating-presets.md](https://github.com/ihatesea69/kiro-kit/blob/main/docs/creating-presets.md).
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
git clone https://github.com/ihatesea69/kiro-kit.git
|
|
119
|
+
cd kiro-kit
|
|
120
|
+
pnpm install
|
|
121
|
+
pnpm test
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Links
|
|
125
|
+
|
|
126
|
+
- Repository: https://github.com/ihatesea69/kiro-kit
|
|
127
|
+
- Issues: https://github.com/ihatesea69/kiro-kit/issues
|
|
128
|
+
- Releases: https://github.com/ihatesea69/kiro-kit/releases
|
|
129
|
+
- Kiro IDE: https://kiro.dev
|
|
130
|
+
|
|
131
|
+
## License
|
|
132
|
+
|
|
133
|
+
[MIT](https://github.com/ihatesea69/kiro-kit/blob/main/LICENSE)
|