@blunking/codexlink 0.1.12 → 0.1.14

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 CHANGED
@@ -1,110 +1,110 @@
1
- <div align="center">
2
-
3
- # CodexLink
4
-
5
- **Your agent in your pocket.**
6
-
7
- [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
8
- [![Powered by BLUN](https://img.shields.io/badge/Powered%20by-BLUN-22D3EE.svg)](https://blun.ai)
9
-
10
- </div>
11
-
12
- CodexLink is the BLUN launcher for one visible CLI session with optional Telegram delivery.
13
-
14
- It keeps transport and queueing around the operator, without spinning up a hidden second session.
15
-
16
- Telegram delivery is serial by default:
17
-
18
- - inbound messages land in queue first
19
- - active work is not interrupted immediately
20
- - direct messages wait until the visible session is quiet
21
- - ambient group noise stays queued until it is relevant or manually drained
22
- - escalation-style messages can still jump the line
23
- - stale pending replies time out automatically, so the queue cannot block forever
24
-
25
- ## Install
26
-
27
- From GitHub:
28
-
29
- ```powershell
30
- npm install -g github:maykbiletti/codexlink
31
- ```
32
-
33
- From npm:
34
-
35
- ```powershell
36
- npm install -g @blunking/codexlink
37
- ```
38
-
39
- Local development:
40
-
41
- ```powershell
42
- cd codexlink
43
- npm install
44
- npm link
45
- ```
46
-
47
- ## Schnellstart
48
-
49
- Normal starten:
50
-
51
- ```powershell
52
- blun-codex
53
- ```
54
-
55
- Telegram aktivieren:
56
-
57
- ```powershell
58
- blun-codex telegram-plugin
59
- ```
60
-
1
+ <div align="center">
2
+
3
+ # CodexLink
4
+
5
+ **Your agent in your pocket.**
6
+
7
+ [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
8
+ [![Powered by BLUN](https://img.shields.io/badge/Powered%20by-BLUN-22D3EE.svg)](https://blun.ai)
9
+
10
+ </div>
11
+
12
+ CodexLink is the BLUN launcher for one visible CLI session with optional Telegram delivery.
13
+
14
+ It keeps transport and queueing around the operator, without spinning up a hidden second session.
15
+
16
+ Telegram delivery is serial by default:
17
+
18
+ - inbound messages land in queue first
19
+ - active work is not interrupted immediately
20
+ - direct messages wait until the visible session is quiet
21
+ - ambient group noise stays queued until it is relevant or manually drained
22
+ - escalation-style messages can still jump the line
23
+ - stale pending replies time out automatically, so the queue cannot block forever
24
+
25
+ ## Install
26
+
27
+ From GitHub:
28
+
29
+ ```powershell
30
+ npm install -g github:maykbiletti/codexlink
31
+ ```
32
+
33
+ From npm:
34
+
35
+ ```powershell
36
+ npm install -g @blunking/codexlink
37
+ ```
38
+
39
+ Local development:
40
+
41
+ ```powershell
42
+ cd codexlink
43
+ npm install
44
+ npm link
45
+ ```
46
+
47
+ ## Schnellstart
48
+
49
+ Normal starten:
50
+
51
+ ```powershell
52
+ blun-codex
53
+ ```
54
+
55
+ Telegram aktivieren:
56
+
57
+ ```powershell
58
+ blun-codex telegram-plugin
59
+ ```
60
+
61
61
  Wenn Telegram noch nicht eingerichtet ist, startet automatisch ein kurzer Setup-Flow und fragt:
62
62
 
63
63
  - Telegram Bot Token
64
64
 
65
65
  Danach oeffnest du Telegram und sendest eine Nachricht an den Bot. CodexLink erkennt Chat oder Gruppe automatisch und schreibt alles lokal an die richtige Stelle. Du musst keine Chat-ID suchen und keine `.env`-Datei bearbeiten.
66
-
67
- Pruefen:
68
-
69
- ```powershell
70
- blun-codex telegram-doctor
71
- ```
72
-
73
- ## Commands
74
-
75
- Normal startup:
76
-
77
- ```powershell
78
- blun-codex
79
- ```
80
-
81
- Alias:
82
-
83
- ```powershell
84
- codexlink
85
- ```
86
-
87
- Telegram mode:
88
-
89
- ```powershell
90
- blun-codex telegram-plugin
91
- ```
92
-
93
- Manual setup:
94
-
95
- ```powershell
96
- blun-codex telegram-setup
97
- ```
98
-
99
- Legacy equivalent:
100
-
101
- ```powershell
102
- blun-codex --telegram plugin
103
- ```
104
-
105
- Status:
106
-
107
- ```powershell
66
+
67
+ Pruefen:
68
+
69
+ ```powershell
70
+ blun-codex telegram-doctor
71
+ ```
72
+
73
+ ## Commands
74
+
75
+ Normal startup:
76
+
77
+ ```powershell
78
+ blun-codex
79
+ ```
80
+
81
+ Alias:
82
+
83
+ ```powershell
84
+ codexlink
85
+ ```
86
+
87
+ Telegram mode:
88
+
89
+ ```powershell
90
+ blun-codex telegram-plugin
91
+ ```
92
+
93
+ Manual setup:
94
+
95
+ ```powershell
96
+ blun-codex telegram-setup
97
+ ```
98
+
99
+ Legacy equivalent:
100
+
101
+ ```powershell
102
+ blun-codex --telegram plugin
103
+ ```
104
+
105
+ Status:
106
+
107
+ ```powershell
108
108
  blun-codex telegram-status
109
109
  ```
110
110
 
@@ -122,131 +122,131 @@ BLUN_TELEGRAM_OTHER_AGENT_NAMES=frida,angel,dieter,alfred
122
122
  ```
123
123
 
124
124
  Doctor:
125
-
126
- ```powershell
127
- blun-codex telegram-doctor
128
- ```
129
-
130
- JSON doctor output:
131
-
132
- ```powershell
133
- blun-codex telegram-doctor --json
134
- ```
135
-
136
- Dry run:
137
-
138
- ```powershell
139
- blun-codex telegram-plugin --print-only
140
- ```
141
-
142
- ## Eigene Profile
143
-
144
- Der normale Start braucht kein eigenes Profil.
145
-
146
- Wenn du nur einen Slot auf deinem Rechner brauchst, reicht:
147
-
148
- ```powershell
149
- blun-codex telegram-plugin
150
- ```
151
-
152
- Ein eigenes Profil brauchst du nur fuer Fortgeschrittene oder Parallelbetrieb, zum Beispiel wenn mehrere Operatoren auf demselben Rechner laufen.
153
-
154
- Beispiel:
155
-
156
- ```powershell
157
- blun-codex --profile alfred telegram-plugin
158
- ```
159
-
160
- ## Private internal profiles
161
-
162
- If you run more than one internal operator on the same machine, do not start all of them on the shared `default` slot.
163
-
164
- Use a dedicated private profile per operator:
165
-
166
- ```powershell
167
- blun-codex --profile frida telegram-plugin
168
- ```
169
-
170
- Why this matters:
171
-
172
- - `blun-codex telegram-plugin` without `--profile` uses the shared `default` runtime slot
173
- - starting a second operator on `default` will replace the first `default` runtime
174
- - a private profile gives that operator a separate runtime slot, state directory, and Mnemo binding
175
-
176
- For internal/private profiles:
177
-
178
- - keep the profile local on the machine
179
- - give it its own `agent_name`
180
- - give it its own Telegram state directory
181
- - do not ship internal agent profiles in the public package
182
-
183
- Local private profiles are loaded from:
184
-
185
- ```text
186
- %USERPROFILE%\.codex\profiles\codexlink\<name>.json
187
- ```
188
-
189
- Example:
190
-
191
- ```powershell
192
- blun-codex --profile frida telegram-plugin
193
- ```
194
-
195
- looks for:
196
-
197
- ```text
198
- %USERPROFILE%\.codex\profiles\codexlink\frida.json
199
- ```
200
-
201
- ## What it does
202
-
203
- - starts one consistent local CLI runtime
204
- - writes a launch record into `.codex/runtimes/default/`
205
- - keeps Telegram queue state under `.codex/channels/telegram-default/`
206
- - attaches Telegram delivery to the same visible session
207
- - defers automatic Telegram delivery until the foreground session is idle
208
- - keeps poller, dispatcher, and reply relay separate from the foreground operator
209
-
210
- ## What it does not do
211
-
212
- - no hidden autonomous answer bot
213
- - no second shadow session
214
- - no per-agent internal company presets in the public package
215
-
216
- ## Public profile
217
-
218
- The shipped default profile is intentionally generic:
219
-
220
- - display name: `CodexLink`
221
- - lane: `general`
222
- - workspace: current directory by default
223
- - model: inherited from the local host unless explicitly set
224
-
225
- If you need custom paths or lane rules, add your own profile JSON next to `profiles/default.json`.
226
-
227
- ## Telegram plugin folder
228
-
229
- The bundled plugin lives under `telegram-plugin/` and contains:
230
-
231
- - `.codex-plugin/plugin.json`
232
- - `.mcp.json`
233
- - `server.js`
234
- - sidecars and bridge helpers
235
-
236
- ## Requirements
237
-
238
- - Windows PowerShell
239
- - Node.js 20+
240
- - a working local `codex` command in `PATH`
241
- - a Telegram bot token when Telegram mode is enabled
242
-
243
- ## First-run behavior
244
-
125
+
126
+ ```powershell
127
+ blun-codex telegram-doctor
128
+ ```
129
+
130
+ JSON doctor output:
131
+
132
+ ```powershell
133
+ blun-codex telegram-doctor --json
134
+ ```
135
+
136
+ Dry run:
137
+
138
+ ```powershell
139
+ blun-codex telegram-plugin --print-only
140
+ ```
141
+
142
+ ## Eigene Profile
143
+
144
+ Der normale Start braucht kein eigenes Profil.
145
+
146
+ Wenn du nur einen Slot auf deinem Rechner brauchst, reicht:
147
+
148
+ ```powershell
149
+ blun-codex telegram-plugin
150
+ ```
151
+
152
+ Ein eigenes Profil brauchst du nur fuer Fortgeschrittene oder Parallelbetrieb, zum Beispiel wenn mehrere Operatoren auf demselben Rechner laufen.
153
+
154
+ Beispiel:
155
+
156
+ ```powershell
157
+ blun-codex --profile alfred telegram-plugin
158
+ ```
159
+
160
+ ## Private internal profiles
161
+
162
+ If you run more than one internal operator on the same machine, do not start all of them on the shared `default` slot.
163
+
164
+ Use a dedicated private profile per operator:
165
+
166
+ ```powershell
167
+ blun-codex --profile frida telegram-plugin
168
+ ```
169
+
170
+ Why this matters:
171
+
172
+ - `blun-codex telegram-plugin` without `--profile` uses the shared `default` runtime slot
173
+ - starting a second operator on `default` will replace the first `default` runtime
174
+ - a private profile gives that operator a separate runtime slot, state directory, and Mnemo binding
175
+
176
+ For internal/private profiles:
177
+
178
+ - keep the profile local on the machine
179
+ - give it its own `agent_name`
180
+ - give it its own Telegram state directory
181
+ - do not ship internal agent profiles in the public package
182
+
183
+ Local private profiles are loaded from:
184
+
185
+ ```text
186
+ %USERPROFILE%\.codex\profiles\codexlink\<name>.json
187
+ ```
188
+
189
+ Example:
190
+
191
+ ```powershell
192
+ blun-codex --profile frida telegram-plugin
193
+ ```
194
+
195
+ looks for:
196
+
197
+ ```text
198
+ %USERPROFILE%\.codex\profiles\codexlink\frida.json
199
+ ```
200
+
201
+ ## What it does
202
+
203
+ - starts one consistent local CLI runtime
204
+ - writes a launch record into `.codex/runtimes/default/`
205
+ - keeps Telegram queue state under `.codex/channels/telegram-default/`
206
+ - attaches Telegram delivery to the same visible session
207
+ - defers automatic Telegram delivery until the foreground session is idle
208
+ - keeps poller, dispatcher, and reply relay separate from the foreground operator
209
+
210
+ ## What it does not do
211
+
212
+ - no hidden autonomous answer bot
213
+ - no second shadow session
214
+ - no per-agent internal company presets in the public package
215
+
216
+ ## Public profile
217
+
218
+ The shipped default profile is intentionally generic:
219
+
220
+ - display name: `CodexLink`
221
+ - lane: `general`
222
+ - workspace: current directory by default
223
+ - model: inherited from the local host unless explicitly set
224
+
225
+ If you need custom paths or lane rules, add your own profile JSON next to `profiles/default.json`.
226
+
227
+ ## Telegram plugin folder
228
+
229
+ The bundled plugin lives under `telegram-plugin/` and contains:
230
+
231
+ - `.codex-plugin/plugin.json`
232
+ - `.mcp.json`
233
+ - `server.js`
234
+ - sidecars and bridge helpers
235
+
236
+ ## Requirements
237
+
238
+ - Windows PowerShell
239
+ - Node.js 20+
240
+ - a working local `codex` command in `PATH`
241
+ - a Telegram bot token when Telegram mode is enabled
242
+
243
+ ## First-run behavior
244
+
245
245
  `blun-codex telegram-plugin` now behaves like a guided setup for normal users:
246
246
 
247
247
  1. check whether Telegram is already configured
248
248
  2. ask only for a missing Bot Token
249
- 3. wait for one Telegram message to the bot
249
+ 3. wait for one Telegram message to the bot when no chat is paired yet
250
250
  4. detect and store the chat/group ID automatically
251
251
  5. continue into Telegram mode
252
252
 
@@ -254,12 +254,12 @@ Allowed Chat ID(s) are no longer typed by hand. To pair a different chat or grou
254
254
 
255
255
  ```powershell
256
256
  blun-codex telegram-setup
257
- ```
258
-
259
- If something is missing later, `blun-codex telegram-doctor` tells you exactly what is missing and what to run next.
260
-
261
- ## Notes
262
-
263
- - the package currently targets local Windows operators first
264
- - the package is installable from GitHub before registry publishing
265
- - once an npm token is available, the same package can be published without changing the command shape
257
+ ```
258
+
259
+ If something is missing later, `blun-codex telegram-doctor` tells you exactly what is missing and what to run next.
260
+
261
+ ## Notes
262
+
263
+ - the package currently targets local Windows operators first
264
+ - the package is installable from GitHub before registry publishing
265
+ - once an npm token is available, the same package can be published without changing the command shape