let5see/clawdbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(cli): drop tmux helpers and update help copy

Browse Source
This commit is contained in:
Peter Steinberger
2025-12-08 12:43:13 +01:00
parent bce84376d3
commit 17fa2f4053
9 changed files with 23 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/clawd.md
View File

@@ -240,13 +240,12 @@ Include `MEDIA:/path/to/file.png` in Claude's output to attach images. clawdis h
# Foreground (see all logs)
clawdis relay --provider web --verbose
# Background in tmux (recommended)
clawdis relay:tmux
# With immediate heartbeat on startup
clawdis relay:heartbeat:tmux
clawdis relay:heartbeat
```
For backgrounding, run the relay under your preferred supervisor (e.g., launchd/systemd) and point it at the same `clawdis relay --provider web --verbose` command.
## Tips for a Great Personal Assistant
1. **Give it a home** - A dedicated folder (`~/clawd`) lets your AI build persistent memory

5
docs/heartbeat.md
View File

@@ -39,7 +39,6 @@ Goal: add a simple heartbeat poll for command-based auto-replies (Pi/Tau) that o
- Expose CLI triggers:
- `clawdis heartbeat` (web provider, defaults to first `allowFrom`; optional `--to` override)
- `--session-id <uuid>` forces resuming a specific session for that heartbeat
- `clawdis relay:heartbeat` to run the relay loop with an immediate heartbeat (no tmux)
- `clawdis relay:heartbeat:tmux` to run the same in tmux (detached, attachable)
- Relay supports `--heartbeat-now` to fire once at startup (including the tmux helper).
- `clawdis relay:heartbeat` to run the relay loop with an immediate heartbeat
- Relay supports `--heartbeat-now` to fire once at startup.
- When multiple sessions are active or `allowFrom` is only `"*"`, require `--to <E.164>` or `--all` for manual heartbeats to avoid ambiguous targets.

17
docs/tmux.md
View File

@@ -1,17 +0,0 @@
# tmux helpers (relay backgrounding)
## Why we ship tmux helpers
- Run the relay detached so your shell can close, while keeping an interactive pane you can reattach to.
- Provide a consistent start/attach workflow without adding a daemon mode or external process manager.
- Keep the relay code itself tmux-agnostic; tmux is only a launcher concern.
## Commands
- `clawdis relay:tmux` — restarts the `clawdis-relay` session running `pnpm clawdis relay --verbose`, then attaches (skips attach when stdout isn’t a TTY).
- `clawdis relay:tmux:attach` — attach to the existing session without restarting it.
- `clawdis relay:heartbeat:tmux` — same as `relay:tmux` but adds `--heartbeat-now` so Pi is pinged immediately on startup.
All helpers use the fixed session name `clawdis-relay`.
## Logs
- The relay always writes to the configured file logger (defaults to `/tmp/clawdis/clawdis.log`); on start it prints the active log path and level.
- tmux is just for interactive viewing; you can also tail the log file or use another supervisor if you prefer.