@kibitzsh/kibitz 0.0.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/LICENSE +21 -0
- package/README.md +200 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/cli/index.d.ts.map +1 -0
- package/dist/cli/index.js +2662 -0
- package/dist/cli/index.js.map +1 -0
- package/dist/core/commentary.d.ts +69 -0
- package/dist/core/commentary.d.ts.map +1 -0
- package/dist/core/commentary.js +1041 -0
- package/dist/core/commentary.js.map +1 -0
- package/dist/core/parsers/claude.d.ts +3 -0
- package/dist/core/parsers/claude.d.ts.map +1 -0
- package/dist/core/parsers/claude.js +124 -0
- package/dist/core/parsers/claude.js.map +1 -0
- package/dist/core/parsers/codex.d.ts +3 -0
- package/dist/core/parsers/codex.d.ts.map +1 -0
- package/dist/core/parsers/codex.js +133 -0
- package/dist/core/parsers/codex.js.map +1 -0
- package/dist/core/platform-support.d.ts +17 -0
- package/dist/core/platform-support.d.ts.map +1 -0
- package/dist/core/platform-support.js +146 -0
- package/dist/core/platform-support.js.map +1 -0
- package/dist/core/providers/anthropic.d.ts +15 -0
- package/dist/core/providers/anthropic.d.ts.map +1 -0
- package/dist/core/providers/anthropic.js +236 -0
- package/dist/core/providers/anthropic.js.map +1 -0
- package/dist/core/providers/openai.d.ts +16 -0
- package/dist/core/providers/openai.d.ts.map +1 -0
- package/dist/core/providers/openai.js +154 -0
- package/dist/core/providers/openai.js.map +1 -0
- package/dist/core/session-dispatch.d.ts +28 -0
- package/dist/core/session-dispatch.d.ts.map +1 -0
- package/dist/core/session-dispatch.js +453 -0
- package/dist/core/session-dispatch.js.map +1 -0
- package/dist/core/types.d.ts +78 -0
- package/dist/core/types.d.ts.map +1 -0
- package/dist/core/types.js +22 -0
- package/dist/core/types.js.map +1 -0
- package/dist/core/watcher.d.ts +23 -0
- package/dist/core/watcher.d.ts.map +1 -0
- package/dist/core/watcher.js +866 -0
- package/dist/core/watcher.js.map +1 -0
- package/package.json +74 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 kibitzsh
|
|
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/README.md
ADDED
|
@@ -0,0 +1,200 @@
|
|
|
1
|
+
# Kibitz
|
|
2
|
+
|
|
3
|
+
[](LICENSE)
|
|
4
|
+
[](https://github.com/kibitzsh/kibitz/actions/workflows/pages.yml)
|
|
5
|
+
[](https://kibitz.sh)
|
|
6
|
+
|
|
7
|
+
Kibitz is a VS Code extension + CLI that watches Claude/Codex sessions, generates live commentary, and lets you dispatch prompts to existing or new sessions from one composer.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
**VS Code Extension** — install from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=kibitzsh.kibitz) or search `Kibitz` in the Extensions panel.
|
|
12
|
+
|
|
13
|
+
**CLI — Homebrew (macOS / Linux)**
|
|
14
|
+
```bash
|
|
15
|
+
brew install kibitzsh/tap/kibitz
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
**CLI — npm**
|
|
19
|
+
```bash
|
|
20
|
+
npm install -g @kibitzsh/kibitz
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Compatibility Matrix (Contract)
|
|
24
|
+
|
|
25
|
+
| Platform | VS Code panel | Terminal CLI |
|
|
26
|
+
| --- | --- | --- |
|
|
27
|
+
| macOS | Supported | Supported |
|
|
28
|
+
| Windows | Supported | Supported |
|
|
29
|
+
| Linux | Best effort | Best effort |
|
|
30
|
+
|
|
31
|
+
## Core Capabilities
|
|
32
|
+
|
|
33
|
+
- Live commentary feed for Claude Code and Codex sessions.
|
|
34
|
+
- Cross-session prompt dispatch:
|
|
35
|
+
- Existing active sessions.
|
|
36
|
+
- New session on current provider.
|
|
37
|
+
- Slash controls in composer:
|
|
38
|
+
- `/help`, `/pause`, `/resume`, `/clear`, `/focus`, `/model`, `/preset`
|
|
39
|
+
- session targeting like `/1`, `/2`
|
|
40
|
+
- Provider-aware model handling.
|
|
41
|
+
- Strict dispatch status events: `queued`, `started`, `sent`, `failed`.
|
|
42
|
+
|
|
43
|
+
## Prompt Dispatching
|
|
44
|
+
|
|
45
|
+
Kibitz can send prompts to any active watched session (Claude or Codex), or start a new session on the current provider.
|
|
46
|
+
|
|
47
|
+
### VS Code Panel
|
|
48
|
+
|
|
49
|
+
- Target badges always include:
|
|
50
|
+
- `/1 New session (current provider)`
|
|
51
|
+
- `/2..N` existing active sessions from the watcher list
|
|
52
|
+
- Starting a new terminal session is one step: select `/1` and send your prompt.
|
|
53
|
+
- Select a target by:
|
|
54
|
+
- clicking a target badge
|
|
55
|
+
- typing `/N` (select only)
|
|
56
|
+
- typing `/N <prompt>` or `N/ <prompt>` (select + send)
|
|
57
|
+
- Plain text (without target token) sends to the currently selected target.
|
|
58
|
+
- Each send emits explicit status updates: `queued`, `started`, `sent`, `failed`.
|
|
59
|
+
|
|
60
|
+
### Terminal CLI
|
|
61
|
+
|
|
62
|
+
- Use `/sessions` to list active sessions with numeric indexes.
|
|
63
|
+
- Set target with `/target <index|agent:sessionId|new-codex|new-claude>`.
|
|
64
|
+
- Starting a new terminal session is one command: `/target new-codex` (or `/target new-claude`), then send plain text.
|
|
65
|
+
- After target selection, plain text sends to that target.
|
|
66
|
+
- Dispatch status is printed for every send: `queued`, `started`, `sent`, `failed`.
|
|
67
|
+
|
|
68
|
+
### Scope and Limits
|
|
69
|
+
|
|
70
|
+
- Targeting is limited to active sessions in the watcher window (recent activity).
|
|
71
|
+
- Multi-target broadcast in one send is not implemented.
|
|
72
|
+
|
|
73
|
+
## Development Setup
|
|
74
|
+
|
|
75
|
+
### Prerequisites
|
|
76
|
+
|
|
77
|
+
- Node.js 20+
|
|
78
|
+
- npm 10+
|
|
79
|
+
- VS Code 1.85+
|
|
80
|
+
- At least one provider CLI installed and authenticated:
|
|
81
|
+
- `codex` / `codex.cmd`
|
|
82
|
+
- `claude` / `claude.cmd`
|
|
83
|
+
|
|
84
|
+
### Build
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
npm ci
|
|
88
|
+
npm run build
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Deploy to Local VS Code/Cursor
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
npm run deploy:vscode
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
This copies `dist/` and `package.json` into your local extensions directory and replaces older Kibitz extension folders.
|
|
98
|
+
|
|
99
|
+
### Run CLI
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
npm run build
|
|
103
|
+
node dist/cli/index.js
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## Testing
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
npm run typecheck
|
|
110
|
+
npm run check:compat
|
|
111
|
+
npm run test:ui
|
|
112
|
+
npm run test:all
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Useful targeted checks:
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
npm run test:parsers
|
|
119
|
+
npm run check:session-names
|
|
120
|
+
npm run check:model-persistence
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## Release Flow
|
|
124
|
+
|
|
125
|
+
1. Bump `version` in `package.json`.
|
|
126
|
+
2. Run:
|
|
127
|
+
- `npm run test:all`
|
|
128
|
+
- `npm run deploy:vscode` (local smoke)
|
|
129
|
+
3. Create extension package:
|
|
130
|
+
- `npm run package` (builds `.vsix` via `vsce package`)
|
|
131
|
+
4. Push git tag/release notes and attach `.vsix` to GitHub release (recommended).
|
|
132
|
+
|
|
133
|
+
## Distribution Channels
|
|
134
|
+
|
|
135
|
+
## 1) VS Code Extension Marketplace
|
|
136
|
+
|
|
137
|
+
- Create publisher in VS Marketplace (if not already created).
|
|
138
|
+
- Create Azure DevOps PAT with Marketplace publish scopes.
|
|
139
|
+
- Login and publish with `vsce`.
|
|
140
|
+
- Recommended:
|
|
141
|
+
- publish stable versions to Marketplace,
|
|
142
|
+
- keep `.vsix` artifacts in GitHub Releases for manual install/rollback.
|
|
143
|
+
|
|
144
|
+
## 2) OpenVSX (for Cursor/VSCodium ecosystems)
|
|
145
|
+
|
|
146
|
+
- Publish the same extension package to OpenVSX.
|
|
147
|
+
- Keep version parity with Marketplace.
|
|
148
|
+
|
|
149
|
+
## 3) npm (CLI distribution)
|
|
150
|
+
|
|
151
|
+
- Keep `bin.kibitz` pointing to `dist/cli/index.js`.
|
|
152
|
+
- Publish package to npm.
|
|
153
|
+
- Users can install globally and run `kibitz`.
|
|
154
|
+
|
|
155
|
+
## 4) Homebrew
|
|
156
|
+
|
|
157
|
+
Two common paths:
|
|
158
|
+
|
|
159
|
+
- Formula that installs from npm:
|
|
160
|
+
- wraps `npm install -g kibitz`.
|
|
161
|
+
- Tap formula that downloads built tarball/binary and installs launcher.
|
|
162
|
+
|
|
163
|
+
For VS Code extensions specifically, Homebrew is optional and usually secondary to Marketplace/OpenVSX.
|
|
164
|
+
|
|
165
|
+
## 5) GitHub Releases
|
|
166
|
+
|
|
167
|
+
- Upload `.vsix` and changelog per version.
|
|
168
|
+
- Add quick install instructions:
|
|
169
|
+
- `code --install-extension <file>.vsix`
|
|
170
|
+
|
|
171
|
+
## Recommended Distribution Stack
|
|
172
|
+
|
|
173
|
+
For most users, start with:
|
|
174
|
+
|
|
175
|
+
1. VS Marketplace (primary VS Code install path)
|
|
176
|
+
2. OpenVSX (secondary ecosystem coverage)
|
|
177
|
+
3. npm (CLI users)
|
|
178
|
+
4. GitHub Releases (`.vsix` artifact + release notes)
|
|
179
|
+
|
|
180
|
+
Add Homebrew only if your CLI install demand is high and you want one-command setup for macOS/Linux.
|
|
181
|
+
|
|
182
|
+
## Docs
|
|
183
|
+
|
|
184
|
+
- [Support matrix details](docs/SUPPORT_MATRIX.md)
|
|
185
|
+
- [Compatibility release checklist](docs/COMPAT_CHECKLIST.md)
|
|
186
|
+
|
|
187
|
+
## Legal
|
|
188
|
+
|
|
189
|
+
- [License (MIT)](LICENSE)
|
|
190
|
+
- [Privacy Policy](PRIVACY.md)
|
|
191
|
+
- [Terms of Use](TERMS.md)
|
|
192
|
+
|
|
193
|
+
## Cross-Platform Notes
|
|
194
|
+
|
|
195
|
+
Kibitz mirrors proven `room` patterns:
|
|
196
|
+
|
|
197
|
+
- Login-shell PATH inheritance on macOS.
|
|
198
|
+
- npm global prefix PATH enrichment on Windows.
|
|
199
|
+
- Windows `.cmd` command mapping (`claude.cmd`, `codex.cmd`).
|
|
200
|
+
- Platform-parameterized compatibility tests.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cli/index.ts"],"names":[],"mappings":""}
|