Skip to content

Commit aed30ec

Browse files
committed
docs: README — add verify/remove/upgrade/troubleshooting, requirements, changelog link
1 parent 93e20f0 commit aed30ec

1 file changed

Lines changed: 49 additions & 7 deletions

File tree

README.md

Lines changed: 49 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,14 @@ Kiro: This week: 47 commits, +3.2k LOC, 38% tests.
6868
Improve: test ratio below 40% — add integration tests.
6969
```
7070

71-
## Install
71+
## Requirements
72+
73+
- [Kiro CLI](https://kiro.dev) installed and working
74+
- macOS, Linux, or WSL
75+
- Git
76+
- Bash 4+
7277

73-
**Requirements:** [Kiro CLI](https://kiro.dev) installed and working.
78+
## Install
7479

7580
### One-line install
7681

@@ -108,6 +113,14 @@ This clones the repo and creates symlinks from each skill directory into `~/.kir
108113

109114
Everything lives inside `~/.kiro/skills/`. Nothing touches your PATH or runs in the background. Pure Markdown — no binaries, no dependencies.
110115

116+
### Verify installation
117+
118+
```bash
119+
cd ~/.kiro/skills/kstack && ./setup verify
120+
```
121+
122+
This checks that kiro-cli is available, the skills directory exists, and all symlinks point to valid SKILL.md files.
123+
111124
### Add to your repo (optional)
112125

113126
So teammates get the skills when they clone:
@@ -184,7 +197,7 @@ Paranoid staff engineer mode. Checklist covers security (injection, auth, secret
184197

185198
### `ship`
186199

187-
Release engineer mode. Verify branch state → sync main → run tests → push → open PR. Stops on failure. No questions asked. No code changes.
200+
Release engineer mode. Verify branch state → sync main → run tests → push → open PR. Stops on failure. No questions asked. No code changes. Supports GitHub and GitLab.
188201

189202
### `qa`
190203

@@ -214,17 +227,44 @@ Run evals with any LLM-as-judge framework, or manually verify by running each pr
214227
cd ~/.kiro/skills/kstack && git pull
215228
```
216229

217-
Symlinks mean the skills update immediately — no re-setup needed.
230+
Symlinks mean the skills update immediately — no re-setup needed. If new skills are added in an update, re-run `./setup` to create the new symlinks.
218231

219232
## Uninstalling
220233

221234
```bash
222-
for s in plan-product plan-eng code-review ship qa retro; do
223-
rm -f ~/.kiro/skills/$s
224-
done
235+
cd ~/.kiro/skills/kstack && ./setup remove
236+
```
237+
238+
This removes all symlinks. The repo directory is left intact. To fully remove:
239+
240+
```bash
225241
rm -rf ~/.kiro/skills/kstack
226242
```
227243

244+
## Troubleshooting
245+
246+
### "kiro-cli not found"
247+
248+
kstack installs skills even without kiro-cli present. Install Kiro CLI from https://kiro.dev, then run `./setup verify`.
249+
250+
### Broken symlinks
251+
252+
```bash
253+
cd ~/.kiro/skills/kstack && ./setup verify
254+
```
255+
256+
If any symlinks are broken, re-run `./setup` to recreate them.
257+
258+
### Skills not showing up in Kiro
259+
260+
1. Run `./setup verify` to confirm symlinks are correct
261+
2. Check that `~/.kiro/skills/{skill}/SKILL.md` is readable
262+
3. Restart your Kiro CLI session — skills are loaded at startup
263+
264+
### Conflicts with existing skills
265+
266+
If you already have a skill with the same name (e.g. `~/.kiro/skills/ship/`), the setup script backs it up to `~/.kiro/skills/ship.bak` before creating the symlink.
267+
228268
## How It Works
229269

230270
kstack is not magic. It's six carefully written Markdown files that tell Kiro CLI which cognitive mode to use for each phase of software development.
@@ -253,6 +293,8 @@ Guidelines:
253293
- Include eval test cases for any new skill.
254294
- Keep skills platform-agnostic (no hardcoded paths, no personal config).
255295

296+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details. See [CHANGELOG.md](CHANGELOG.md) for release history.
297+
256298
## License
257299

258300
MIT

0 commit comments

Comments
 (0)