clisbot 0.1.36 → 0.1.39
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 +22 -18
- package/config/clisbot.json.template +799 -213
- package/config/clisbot.json.v0.1.0.template +299 -0
- package/config/clisbot.json.v0.1.39.template +885 -0
- package/dist/main.js +4728 -2944
- package/package.json +1 -1
- package/templates/customized/personal-assistant/AGENTS.md +2 -0
- package/templates/customized/team-assistant/AGENTS.md +2 -0
- package/templates/openclaw/AGENTS.md +2 -0
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# clisbot - Turn your favorite coding CLI into an agentic assistant
|
|
1
|
+
# clisbot - Turn your favorite coding CLI into an agentic personal assistant, workplace assistant, coding partner - on the go
|
|
2
2
|
Want to use OpenClaw but are struggling because:
|
|
3
3
|
|
|
4
4
|
- API cost is too high, so you end up looking for LLM proxy workarounds
|
|
@@ -174,24 +174,25 @@ The docs in this repo are kept current, including the [User Guide](docs/user-gui
|
|
|
174
174
|
|
|
175
175
|
If you prefer to configure everything yourself:
|
|
176
176
|
|
|
177
|
-
1. Read the
|
|
178
|
-
2.
|
|
179
|
-
3.
|
|
180
|
-
4.
|
|
177
|
+
1. Read the official config template in [config/clisbot.json.template](config/clisbot.json.template).
|
|
178
|
+
2. If you need the archived legacy snapshot, compare it with [config/clisbot.json.v0.1.0.template](config/clisbot.json.v0.1.0.template).
|
|
179
|
+
3. Copy the official template to `~/.clisbot/clisbot.json` and adjust bots, routes, agents, workspaces, and policies for your environment.
|
|
180
|
+
4. Add agents through the CLI so tool defaults, startup options, and bootstrap templates stay consistent.
|
|
181
|
+
5. Optionally move stable channel secrets into env vars or canonical credential files after your first successful run.
|
|
181
182
|
|
|
182
183
|
Channel route setup is manual by design:
|
|
183
184
|
|
|
184
185
|
- fresh config does not auto-add Slack channels
|
|
185
186
|
- fresh config does not auto-add Telegram groups or topics
|
|
186
187
|
- add only the exact channel, group, topic, or DM routing you want to expose
|
|
187
|
-
- default
|
|
188
|
+
- default bot credential setup lives in [docs/user-guide/bots-and-credentials.md](docs/user-guide/bots-and-credentials.md)
|
|
188
189
|
|
|
189
190
|
Advanced agent management:
|
|
190
191
|
|
|
191
192
|
- most users should stay on `clisbot start --cli ... --bot-type ...` and let first-run create the default agent
|
|
192
|
-
- if you need more than one agent, custom
|
|
193
|
+
- if you need more than one agent, custom bot defaults, or manual route setup flows, use the `clisbot agents ...`, `clisbot bots ...`, and `clisbot routes ...` commands described in [docs/user-guide/README.md](docs/user-guide/README.md)
|
|
193
194
|
- README intentionally keeps that low-level surface out of the main onboarding path because the public first-run model is `--bot-type personal|team`, not internal template-mode naming
|
|
194
|
-
- fresh
|
|
195
|
+
- fresh bot config still points at the `default` agent; if your first useful agent uses another id, update the fallback with `clisbot bots set-agent ...` or override it on a route with `clisbot routes set-agent ...`
|
|
195
196
|
|
|
196
197
|
Env-backed setup is still supported when you want config to reference an env name instead of persisting a credential file:
|
|
197
198
|
|
|
@@ -206,7 +207,7 @@ clisbot start \
|
|
|
206
207
|
- these flags are written into `~/.clisbot/clisbot.json` as `${ENV_NAME}` placeholders
|
|
207
208
|
- you can pass either `CUSTOM_SLACK_APP_TOKEN` or `'${CUSTOM_SLACK_APP_TOKEN}'`
|
|
208
209
|
- use this path when you want config to point at env variable names you chose yourself
|
|
209
|
-
- keep env export details in [docs/user-guide/
|
|
210
|
+
- keep env export details in [docs/user-guide/bots-and-credentials.md](docs/user-guide/bots-and-credentials.md) instead of front-loading them into quick start
|
|
210
211
|
|
|
211
212
|
## Troubleshooting
|
|
212
213
|
|
|
@@ -216,7 +217,7 @@ If the quick start does not work, check these in order:
|
|
|
216
217
|
- If config behavior is confusing, inspect [config/clisbot.json.template](config/clisbot.json.template) first, then compare it with [docs/user-guide/README.md](docs/user-guide/README.md).
|
|
217
218
|
- If `clisbot start` says no agents are configured, prefer `clisbot start --cli codex --bot-type personal --telegram-bot-token <your-telegram-bot-token>`.
|
|
218
219
|
- If you want later runs to work with plain `clisbot start`, rerun your successful first-run command with `--persist`.
|
|
219
|
-
- If `clisbot start` prints token refs as `missing`, either pass the token explicitly on the command line or switch to env-backed setup described in [docs/user-guide/
|
|
220
|
+
- If `clisbot start` prints token refs as `missing`, either pass the token explicitly on the command line or switch to env-backed setup described in [docs/user-guide/bots-and-credentials.md](docs/user-guide/bots-and-credentials.md).
|
|
220
221
|
- If you use custom env names, pass them explicitly with `--slack-app-token`, `--slack-bot-token`, or `--telegram-bot-token`.
|
|
221
222
|
- If `clisbot status` shows `bootstrap=...:missing` or `bootstrap=...:not-bootstrapped`, follow the advanced agent bootstrap steps in [docs/user-guide/README.md](docs/user-guide/README.md).
|
|
222
223
|
- If Codex shows `Do you trust the contents of this directory?`, keep `trustWorkspace: true` in clisbot config and also mark the workspace as trusted in `~/.codex/config.toml`, for example:
|
|
@@ -251,12 +252,14 @@ Most users only need a small set of commands at first:
|
|
|
251
252
|
- `clisbot auth add-user agent --agent <id> --role admin --user <principal>`
|
|
252
253
|
- `clisbot pairing approve slack <CODE>`
|
|
253
254
|
- `clisbot pairing approve telegram <CODE>`
|
|
254
|
-
- `clisbot
|
|
255
|
-
- `clisbot
|
|
256
|
-
- `clisbot
|
|
257
|
-
- `clisbot
|
|
258
|
-
- `clisbot
|
|
259
|
-
- `clisbot
|
|
255
|
+
- `clisbot bots list`
|
|
256
|
+
- `clisbot bots add --channel telegram --bot default --bot-token TELEGRAM_BOT_TOKEN --persist`
|
|
257
|
+
- `clisbot bots add --channel slack --bot default --app-token SLACK_APP_TOKEN --bot-token SLACK_BOT_TOKEN --persist`
|
|
258
|
+
- `clisbot routes add --channel telegram group:<chatId> --bot default`
|
|
259
|
+
- `clisbot routes add --channel telegram topic:<chatId>:<topicId> --bot default`
|
|
260
|
+
- `clisbot routes add --channel slack channel:<channelId> --bot default`
|
|
261
|
+
- `clisbot routes set-agent --channel telegram group:<chatId> --bot default --agent <id>`
|
|
262
|
+
- `clisbot routes set-agent --channel slack channel:<channelId> --bot default --agent <id>`
|
|
260
263
|
- `clisbot --help`
|
|
261
264
|
|
|
262
265
|
If you are running from the repo instead of the global package:
|
|
@@ -306,14 +309,14 @@ Command prefix defaults:
|
|
|
306
309
|
|
|
307
310
|
- slash-style shortcuts: `["::", "\\"]`
|
|
308
311
|
- bash shortcuts: `["!"]`
|
|
309
|
-
- both are configurable with `
|
|
312
|
+
- both are configurable with `bots.defaults.commandPrefixes`, `bots.slack.defaults.commandPrefixes`, or `bots.telegram.defaults.commandPrefixes`
|
|
310
313
|
|
|
311
314
|
Sensitive actions now follow auth and route policy:
|
|
312
315
|
|
|
313
316
|
- `/transcript` depends on the route `verbose` policy
|
|
314
317
|
- `/bash` depends on resolved agent auth through `shellExecute`
|
|
315
318
|
- use `clisbot auth --help` to inspect scopes and mutate role users or permissions
|
|
316
|
-
- use `clisbot
|
|
319
|
+
- use `clisbot routes --help` for route-level setup and route policy guidance
|
|
317
320
|
|
|
318
321
|
Follow-up behavior matters in team threads:
|
|
319
322
|
|
|
@@ -386,6 +389,7 @@ This repo also serves as a small example of an AI-native engineering workflow:
|
|
|
386
389
|
- lessons-learned docs to capture repeated feedback and pitfalls
|
|
387
390
|
- architecture docs used as a stable implementation contract
|
|
388
391
|
- end-to-end validation expectations to close the feedback loop for AI agents
|
|
392
|
+
- workflow docs for shortest-review-first artifacts, repeated review loops, and task-readiness shaping in [docs/workflow/README.md](docs/workflow/README.md)
|
|
389
393
|
|
|
390
394
|
## Contributing
|
|
391
395
|
|