packages/agent/README.md
One-liner to connect Screenpipe to your AI agent.
Set up full Screenpipe integration with any AI agent (OpenClaw, OpenClaw, etc.) in one command. Includes data sync, skills, and optional morning summaries.
# Full setup with morning summaries at 8am
bunx @screenpipe/agent --setup openclaw --morning 08:00
# That's it! You'll get daily briefings via Telegram/WhatsApp/etc.
# Setup with morning summary
bunx @screenpipe/agent --setup user@server --morning 08:00
# Setup without morning summary
bunx @screenpipe/agent --setup user@server
# Custom sync interval (30 min)
bunx @screenpipe/agent --setup user@server --sync-interval 1800
# Check status
bunx @screenpipe/agent --status user@server
# Remove integration
bunx @screenpipe/agent --remove user@server
| Flag | Description |
|---|---|
--setup <host> | Set up full integration |
--remove <host> | Remove integration |
--status <host> | Check integration status |
--morning <HH:MM> | Schedule morning summary |
--sync-interval <s> | Sync frequency (default: 3600) |
--skip-sync | Don't set up data sync |
--skip-skills | Don't install skills |
After setup, ask your agent:
With --morning, you'll receive a daily briefing at the specified time:
Good morning! Here's your briefing:
**Yesterday's Focus:**
- VS Code: ~3 hours
- Chrome: ~2 hours
- Slack: ~45 min
**Action Items Found:**
- [ ] Fix auth bug
- [ ] Review PR #234
**Pattern:** Deep focus morning, meetings afternoon.
Your Computer Your Agent Server
┌─────────────┐ ┌─────────────────┐
│ Screenpipe │ ──sync daemon──▶ │ ~/.screenpipe/ │
│ (records) │ (hourly) │ db.sqlite │
└─────────────┘ └────────┬────────┘
│
▼
┌─────────────────┐
│ AI Agent │
│ (OpenClaw) │
│ │
│ Skills query │
│ the database │
└────────┬────────┘
│
▼
┌─────────────────┐
│ Telegram/ │
│ WhatsApp/etc │
└─────────────────┘
MIT - Part of Screenpipe