@@ -46,30 +46,64 @@ cd bashclaw && ./bashclaw doctor
4646
4747## Quick Start
4848
49- ### Recommended: Claude Code CLI Engine
49+ ### 1. Start the Gateway
5050
51- If you have a [ Claude Code] ( https://docs.anthropic.com/en/docs/claude-code ) subscription (Pro/Max/Team/Enterprise), BashClaw can use it directly as its backend -- no API keys, no per-token cost:
51+ ``` sh
52+ bashclaw gateway
53+ ```
54+
55+ Open ` http://localhost:18789 ` in your browser. If no API key is configured, a first-run setup overlay guides you through it.
56+
57+ ### 2. Choose an Engine
58+
59+ <table >
60+ <tr ><th >Claude Code CLI (Recommended)</th ><th >Builtin (Direct API)</th ></tr >
61+ <tr >
62+ <td >
63+
64+ Reuses your Claude subscription -- no API keys, no per-token cost.
5265
5366``` sh
54- bashclaw config set ' .agents.defaults.engine' ' "claude"'
67+ bashclaw config set \
68+ ' .agents.defaults.engine' ' "claude"'
69+ ```
5570
56- bashclaw agent -m " What is the mass of the sun?" # one-shot
57- bashclaw agent -i # interactive REPL
71+ Requires: [ Claude Code CLI] ( https://docs.anthropic.com/en/docs/claude-code ) installed and authenticated.
72+
73+ </td >
74+ <td >
75+
76+ Calls LLM APIs directly via curl. Supports 18 providers.
77+
78+ ``` sh
79+ export ANTHROPIC_API_KEY=" sk-ant-..."
80+ # or set via web dashboard
5881```
5982
60- This delegates all reasoning and tool execution to the ` claude ` CLI, reusing your existing subscription.
83+ </td >
84+ </tr >
85+ </table >
6186
62- ### Alternative: Builtin Engine with API Keys
87+ ### 3. Connect Channels (Optional)
6388
64- For other providers or if you prefer direct API access :
89+ Add always-on messaging through Telegram, Discord, Slack, or Feishu. Channels auto-start with the gateway :
6590
6691``` sh
67- export ANTHROPIC_API_KEY=" sk-ant-..." # or OPENAI_API_KEY, GOOGLE_API_KEY, etc.
92+ # Example: Telegram
93+ bashclaw config set ' .channels.telegram.botToken' ' "BOT_TOKEN"'
94+ bashclaw config set ' .channels.telegram.enabled' ' true'
95+ bashclaw gateway # web + Telegram both active
96+ ```
97+
98+ See [ Channels] ( #channels ) for all platforms.
99+
100+ ### 4. CLI Mode (Power Users)
101+
102+ For scripting, automation, or SSH sessions:
68103
104+ ``` sh
69105bashclaw agent -m " What is the mass of the sun?" # one-shot
70106bashclaw agent -i # interactive REPL
71- bashclaw onboard # guided setup wizard
72- bashclaw gateway # web dashboard + channels
73107```
74108
75109## Why BashClaw
@@ -106,12 +140,11 @@ BashClaw targets Bash 3.2 deliberately: no `declare -A`, no `mapfile`, no `|&`.
106140
107141## Features
108142
109- - ** Pure shell ** -- Zero dependencies beyond bash 3.2, curl, jq. Already on your machine .
110- - ** Self-modifying ** -- Agent hot-patches its own source at runtime. No compilation step .
143+ - ** Web dashboard ** -- Built-in browser UI for chat, config, and monitoring. First-run setup wizard. No external tools .
144+ - ** Multi-channel ** -- Telegram, Discord, Slack, Feishu/Lark. Each channel is one shell script. Auto-starts with gateway .
111145- ** Dual engine** -- Claude Code CLI (reuses subscription) or builtin (direct API via curl). Per-agent configurable.
112146- ** Multi-provider** -- 18 providers: Claude, GPT, Gemini, DeepSeek, Qwen, Zhipu, Moonshot, MiniMax, Groq, xAI, Mistral, Ollama, vLLM, and more.
113- - ** Multi-channel** -- Telegram, Discord, Slack, Feishu/Lark. Each channel is one shell script.
114- - ** Web dashboard** -- Built-in browser UI for chat, config, and monitoring. No external tools.
147+ - ** Pure shell** -- Zero dependencies beyond bash 3.2, curl, jq. Already on your machine.
115148- ** 14 built-in tools** -- Web fetch, search, shell exec, memory, cron, file I/O, inter-agent messaging.
116149- ** Plugin system** -- 4 discovery paths. Register tools, hooks, commands, providers.
117150- ** 8-layer security** -- SSRF protection, command filters, pairing codes, rate limiting, RBAC, audit.
@@ -153,14 +186,15 @@ bashclaw gateway
153186** Logs** -- Live log viewer with level filtering.
154187** First-run** -- If no API key is set, shows a setup overlay on first visit.
155188
156- ### Web + CLI Dual Mode
189+ ### Web + Channels + CLI
157190
158- Both modes share the same config, sessions, and state. Changes in the dashboard take effect in CLI immediately, and vice versa .
191+ All three modes share the same config, sessions, and state. Changes in one take effect in the others immediately .
159192
160193| Mode | Best For | Command |
161194| ------| ----------| ---------|
162- | Web | First-time setup, visual config, casual chat | ` bashclaw gateway ` |
163- | CLI | Automation, scripting, SSH, power users | ` bashclaw agent -i ` |
195+ | Web | First-time setup, visual config, casual chat | ` bashclaw gateway ` then open browser |
196+ | Channels | Always-on team bot, mobile access | ` bashclaw gateway ` with channels enabled |
197+ | CLI | Automation, scripting, SSH, CI/CD | ` bashclaw agent -m "..." ` or ` bashclaw agent -i ` |
164198
165199### REST API
166200
@@ -780,19 +814,29 @@ Config file: `~/.bashclaw/bashclaw.json`
780814
781815## Use Cases
782816
783- ** Personal assistant on a Mac**
817+ ** Web dashboard on a Mac**
784818``` sh
785- export ANTHROPIC_API_KEY=" sk-ant-..."
786- bashclaw agent -i
787- # No Python, no Node, no Docker. Just works.
819+ bashclaw gateway
820+ # Open http://localhost:18789 -- first-run wizard configures API keys
821+ # Chat with the agent in your browser immediately
822+ ```
823+
824+ ** Multi-channel team bot**
825+ ``` sh
826+ # One agent, multiple channels -- all served by a single gateway
827+ bashclaw config set ' .channels.telegram.enabled' ' true'
828+ bashclaw config set ' .channels.discord.enabled' ' true'
829+ bashclaw config set ' .channels.slack.enabled' ' true'
830+ bashclaw gateway
831+ # Messages from all platforms routed to the same agent
788832```
789833
790- ** Headless server agent**
834+ ** Always-on server agent**
791835``` sh
792836# Install on a fresh Ubuntu server
793837curl -fsSL .../install.sh | bash
794838bashclaw daemon install --enable
795- # Agent runs 24/7, accessible via Telegram or web dashboard
839+ # Agent runs 24/7, accessible via Telegram, Discord, Slack, or web dashboard
796840```
797841
798842** CI/CD pipeline agent**
@@ -801,14 +845,10 @@ bashclaw daemon install --enable
801845bashclaw agent -m " Review this diff and suggest improvements" < diff.patch
802846```
803847
804- ** Multi-channel team bot **
848+ ** SSH / headless CLI **
805849``` sh
806- # One agent, multiple channels
807- bashclaw config set ' .channels.telegram.enabled' ' true'
808- bashclaw config set ' .channels.discord.enabled' ' true'
809- bashclaw config set ' .channels.slack.enabled' ' true'
810- bashclaw gateway
811- # Messages from all platforms routed to the same agent
850+ bashclaw agent -i
851+ # Interactive REPL for power users. No browser needed.
812852```
813853
814854## Testing
0 commit comments