@sma1lboy/kobe 0.1.0 → 0.1.1
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 +33 -3
- package/dist/index.js +5719 -5636
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -27,15 +27,45 @@ shell wrapping it.
|
|
|
27
27
|
Tests via vitest + PTY-driven behavior tests. Lint via biome. Engine spawns the `claude` CLI as a
|
|
28
28
|
subprocess and parses `--output-format stream-json`.
|
|
29
29
|
|
|
30
|
-
##
|
|
30
|
+
## Install (end users)
|
|
31
|
+
|
|
32
|
+
[](https://www.npmjs.com/package/@sma1lboy/kobe)
|
|
33
|
+
|
|
34
|
+
Requires [Bun](https://bun.sh) ≥ 1.0 on the host (kobe's renderer is
|
|
35
|
+
opentui, which uses Bun-FFI). The `claude` CLI must also be on `PATH`.
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
bun install -g @sma1lboy/kobe
|
|
39
|
+
kobe # launches the TUI
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Or run without installing:
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
bunx @sma1lboy/kobe
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Quick start (developing on kobe itself)
|
|
31
49
|
|
|
32
50
|
```bash
|
|
33
51
|
bun install
|
|
34
52
|
bun run dev # boots the 5-pane TUI
|
|
35
53
|
bun run test # unit + type tests
|
|
36
54
|
bun run test:behavior # PTY-driven; spawns kobe as a real binary
|
|
55
|
+
bun run build # produces ./dist/index.js for `npm publish`
|
|
37
56
|
```
|
|
38
57
|
|
|
39
|
-
Tasks live at `~/.kobe/tasks.json`; per-task git worktrees live at
|
|
58
|
+
Tasks live at `~/.kobe/tasks.json`; per-task git worktrees live at
|
|
59
|
+
`<repo>/.claude/worktrees/<task-id>/`.
|
|
60
|
+
|
|
61
|
+
## Releasing
|
|
62
|
+
|
|
63
|
+
Bump `package.json`, move `## [Unreleased]` in `CHANGELOG.md` to the
|
|
64
|
+
new version section, commit, then push the matching `vX.Y.Z` tag.
|
|
65
|
+
The release workflow ([`.github/workflows/release.yml`](./.github/workflows/release.yml))
|
|
66
|
+
runs typecheck + unit tests + build, asserts the tag matches
|
|
67
|
+
`package.json`, then `npm publish --provenance` and creates a GitHub
|
|
68
|
+
release with the changelog section as the body.
|
|
40
69
|
|
|
41
|
-
Current direction, what just shipped, and what's next live in [`HANDOFF.md`](./HANDOFF.md)
|
|
70
|
+
Current direction, what just shipped, and what's next live in [`HANDOFF.md`](./HANDOFF.md)
|
|
71
|
+
and [`CHANGELOG.md`](./CHANGELOG.md).
|