voxclaw

VoxClaw

Use this skill when the user wants audible output from an agent.

VoxClaw runs on macOS as a menu bar app and can speak text through:

• the local voxclaw CLI
• the voxclaw://read?text=... URL scheme
• the HTTP listener, usually on port 4140

Preferred flow

If the human provides a VoxClaw setup pointer, use the provided health_url and speak_url directly.

Connection order:

1. Use plugins/voxclaw/scripts/voxclaw-say --health when working in this repo.
2. If a pointer is available, pass its speak_url or health_url to the helper.
3. Otherwise let the helper probe http://localhost:4140/status.
4. The helper falls back to the local voxclaw CLI when needed.

Never guess a .local hostname if the user already supplied a numeric LAN IP.

Preferred command

Default to the helper script instead of open-coded curl:

plugins/voxclaw/scripts/voxclaw-say "Hello from the agent"
plugins/voxclaw/scripts/voxclaw-say --health
plugins/voxclaw/scripts/voxclaw-say --url http://192.168.1.50:4140/read "Deployment complete"
plugins/voxclaw/scripts/voxclaw-say --voice nova --rate 1.2 "Build failed"
plugins/voxclaw/scripts/voxclaw-say --instructions "Read warmly" "Welcome back"
plugins/voxclaw/scripts/voxclaw-say --project-id /Users/me/myproject "Update from my project"

HTTP API

Health check:

curl -sS http://localhost:4140/status

Speak text:

curl -X POST http://localhost:4140/read \
  -H 'Content-Type: application/json' \
  -d '{"text":"Hello","project_id":"/Users/me/myproject","agent_id":"my-agent"}'

Optional fields: voice, rate, instructions, project_id, agent_id.

Acknowledge (user has read the response, skip speaking it):

curl -X POST http://localhost:4140/ack \
  -H 'Content-Type: application/json' \
  -d '{"project_id":"/Users/me/myproject"}'

CLI fallback

voxclaw "Hello"
voxclaw --clipboard
voxclaw --voice nova "Build passed"
voxclaw --send "Hello"   # send to an already running listener
voxclaw --status

User experience guidance

• Audio leads, visuals follow.
• Do not trigger the overlay before audio is ready.
• Keep spoken summaries concise unless the user asks for full narration.
• Default to a spoken final summary after work completes.