docs(status): make status first-step
This commit is contained in:
@@ -7,30 +7,29 @@ Quick answers plus deeper troubleshooting for real-world setups (local dev, VPS,
|
||||
|
||||
## First 60 seconds if something's broken
|
||||
|
||||
1) **Run the doctor**
|
||||
1) **Quick status (first check)**
|
||||
```bash
|
||||
clawdbot doctor
|
||||
clawdbot status
|
||||
```
|
||||
Repairs/migrates config/state + runs health checks. See [Doctor](/gateway/doctor).
|
||||
Fast local summary: OS + update, gateway/daemon reachability, agents/sessions, provider config + runtime issues (when gateway is reachable).
|
||||
|
||||
2) **Daemon + port state**
|
||||
2) **Pasteable report (safe to share)**
|
||||
```bash
|
||||
clawdbot status --all
|
||||
```
|
||||
Read-only diagnosis with log tail (tokens redacted).
|
||||
|
||||
3) **Daemon + port state**
|
||||
```bash
|
||||
clawdbot daemon status
|
||||
```
|
||||
Shows supervisor runtime vs RPC reachability, the probe target URL, and which config the daemon likely used.
|
||||
|
||||
3) **Local probes**
|
||||
4) **Deep probes**
|
||||
```bash
|
||||
clawdbot status --deep
|
||||
```
|
||||
Checks provider connectivity and local health. See [Health](/gateway/health).
|
||||
|
||||
4) **Gateway snapshot**
|
||||
```bash
|
||||
clawdbot health --json
|
||||
clawdbot health --verbose # shows the target URL + config path on errors
|
||||
```
|
||||
Asks the running gateway for a full snapshot (WS-only). See [Health](/gateway/health).
|
||||
Runs gateway health checks + provider probes (requires a reachable gateway). See [Health](/gateway/health).
|
||||
|
||||
5) **Tail the latest log**
|
||||
```bash
|
||||
@@ -42,6 +41,19 @@ Quick answers plus deeper troubleshooting for real-world setups (local dev, VPS,
|
||||
```
|
||||
File logs are separate from service logs; see [Logging](/logging) and [Troubleshooting](/gateway/troubleshooting).
|
||||
|
||||
6) **Run the doctor (repairs)**
|
||||
```bash
|
||||
clawdbot doctor
|
||||
```
|
||||
Repairs/migrates config/state + runs health checks. See [Doctor](/gateway/doctor).
|
||||
|
||||
7) **Gateway snapshot**
|
||||
```bash
|
||||
clawdbot health --json
|
||||
clawdbot health --verbose # shows the target URL + config path on errors
|
||||
```
|
||||
Asks the running gateway for a full snapshot (WS-only). See [Health](/gateway/health).
|
||||
|
||||
## What is Clawdbot?
|
||||
|
||||
### What is Clawdbot, in one paragraph?
|
||||
|
||||
@@ -160,6 +160,7 @@ node dist/entry.js gateway --port 18789 --verbose
|
||||
In a new terminal:
|
||||
|
||||
```bash
|
||||
clawdbot status
|
||||
clawdbot health
|
||||
clawdbot message send --to +15555550123 --message "Hello from Clawdbot"
|
||||
```
|
||||
|
||||
@@ -154,6 +154,8 @@ describe("statusCommand", () => {
|
||||
expect(logs.some((l) => l.includes("LaunchAgent"))).toBe(true);
|
||||
expect(logs.some((l) => l.includes("FAQ:"))).toBe(true);
|
||||
expect(logs.some((l) => l.includes("Troubleshooting:"))).toBe(true);
|
||||
expect(logs.some((l) => l.includes("More:"))).toBe(true);
|
||||
expect(logs.some((l) => l.includes("clawdbot status --all"))).toBe(true);
|
||||
});
|
||||
|
||||
it("shows gateway auth when reachable", async () => {
|
||||
|
||||
@@ -1028,7 +1028,18 @@ export async function statusCommand(
|
||||
runtime.log("");
|
||||
runtime.log("FAQ: https://docs.clawd.bot/faq");
|
||||
runtime.log("Troubleshooting: https://docs.clawd.bot/troubleshooting");
|
||||
runtime.log(
|
||||
"More: clawdbot status --all · clawdbot status --deep · clawdbot gateway status · clawdbot providers status --probe · clawdbot daemon status · clawdbot logs --follow",
|
||||
);
|
||||
runtime.log("");
|
||||
runtime.log("More:");
|
||||
runtime.log(" clawdbot status --all # pasteable report (redacts tokens)");
|
||||
runtime.log(" clawdbot logs --follow # live logs");
|
||||
if (!gatewayReachable) {
|
||||
runtime.log(
|
||||
" clawdbot gateway status # check which gateway you’re targeting",
|
||||
);
|
||||
runtime.log(
|
||||
" clawdbot daemon status # supervisor state (launchd/systemd/…)",
|
||||
);
|
||||
} else {
|
||||
runtime.log(" clawdbot status --deep # gateway health + provider probes");
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user