refactor: normalize cli command hints
This commit is contained in:
@@ -184,22 +184,25 @@ Clawdbot is a personal AI assistant you run on your own devices. It replies on t
|
||||
The repo recommends running from source and using the onboarding wizard:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/clawdbot/clawdbot.git
|
||||
cd clawdbot
|
||||
|
||||
pnpm install
|
||||
|
||||
# Optional if you want built output / global linking:
|
||||
pnpm build
|
||||
|
||||
# If the Control UI assets are missing or you want the dashboard:
|
||||
pnpm ui:build # auto-installs UI deps on first run
|
||||
|
||||
pnpm clawdbot onboard
|
||||
curl -fsSL https://clawd.bot/install.sh | bash
|
||||
clawdbot onboard --install-daemon
|
||||
```
|
||||
|
||||
The wizard can also build UI assets automatically. After onboarding, you typically run the Gateway on port **18789**.
|
||||
|
||||
From source (contributors/dev):
|
||||
|
||||
```bash
|
||||
git clone https://github.com/clawdbot/clawdbot.git
|
||||
cd clawdbot
|
||||
pnpm install
|
||||
pnpm build
|
||||
pnpm ui:build # auto-installs UI deps on first run
|
||||
clawdbot onboard
|
||||
```
|
||||
|
||||
If you don’t have a global install yet, run it via `pnpm clawdbot onboard`.
|
||||
|
||||
### How do I open the dashboard after onboarding?
|
||||
|
||||
The wizard now opens your browser with a tokenized dashboard URL right after onboarding and also prints the full link (with token) in the summary. Keep that tab open; if it didn’t launch, copy/paste the printed URL on the same machine. Tokens stay local to your host—nothing is fetched from the browser.
|
||||
@@ -330,7 +333,7 @@ git clone https://github.com/clawdbot/clawdbot.git
|
||||
cd clawdbot
|
||||
pnpm install
|
||||
pnpm build
|
||||
pnpm clawdbot doctor
|
||||
clawdbot doctor
|
||||
clawdbot daemon restart
|
||||
```
|
||||
|
||||
|
||||
@@ -116,6 +116,13 @@ If a token is configured, paste it into the Control UI settings (stored as `conn
|
||||
⚠️ **Bun warning (WhatsApp + Telegram):** Bun has known issues with these
|
||||
channels. If you use WhatsApp or Telegram, run the Gateway with **Node**.
|
||||
|
||||
## 3.5) Quick verify (2 min)
|
||||
|
||||
```bash
|
||||
clawdbot status
|
||||
clawdbot health
|
||||
```
|
||||
|
||||
## 4) Pair + connect your first chat surface
|
||||
|
||||
### WhatsApp (QR login)
|
||||
@@ -158,9 +165,11 @@ cd clawdbot
|
||||
pnpm install
|
||||
pnpm ui:build # auto-installs UI deps on first run
|
||||
pnpm build
|
||||
pnpm clawdbot onboard --install-daemon
|
||||
clawdbot onboard --install-daemon
|
||||
```
|
||||
|
||||
If you don’t have a global install yet, run the onboarding step via `pnpm clawdbot ...` from the repo.
|
||||
|
||||
Gateway (from this repo):
|
||||
|
||||
```bash
|
||||
@@ -169,15 +178,13 @@ node dist/entry.js gateway --port 18789 --verbose
|
||||
|
||||
## 7) Verify end-to-end
|
||||
|
||||
In a new terminal:
|
||||
In a new terminal, send a test message:
|
||||
|
||||
```bash
|
||||
clawdbot status
|
||||
clawdbot health
|
||||
clawdbot message send --target +15555550123 --message "Hello from Clawdbot"
|
||||
```
|
||||
|
||||
If `health` shows “no auth configured”, go back to the wizard and set OAuth/key auth — the agent won’t be able to respond without it.
|
||||
If `clawdbot health` shows “no auth configured”, go back to the wizard and set OAuth/key auth — the agent won’t be able to respond without it.
|
||||
|
||||
Tip: `clawdbot status --all` is the best pasteable, read-only debug report.
|
||||
Health probes: `clawdbot health` (or `clawdbot status --deep`) asks the running gateway for a health snapshot.
|
||||
|
||||
@@ -35,9 +35,11 @@ clawdbot setup
|
||||
From inside this repo, use the local CLI entry:
|
||||
|
||||
```bash
|
||||
pnpm clawdbot setup
|
||||
clawdbot setup
|
||||
```
|
||||
|
||||
If you don’t have a global install yet, run it via `pnpm clawdbot setup`.
|
||||
|
||||
## Stable workflow (macOS app first)
|
||||
|
||||
1) Install + launch **Clawdbot.app** (menu bar).
|
||||
@@ -92,7 +94,7 @@ The app will attach to the running gateway on the configured port.
|
||||
- Or via CLI:
|
||||
|
||||
```bash
|
||||
pnpm clawdbot health
|
||||
clawdbot health
|
||||
```
|
||||
|
||||
### Common footguns
|
||||
|
||||
Reference in New Issue
Block a user