Back to Screenpipe

@screenpipe/agent

packages/agent/README.md

2.3.273.6 KB
Original Source

@screenpipe/agent

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.

Quick Start

bash
# 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.

What It Does

  1. Syncs your screen data - Daemon runs locally, syncs to your agent every hour
  2. Installs skills - recall, search, digest, context
  3. Schedules morning summary - Agent sends you daily briefing at specified time
  4. Just works - Survives reboots, runs in background

Usage

bash
# 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

Options

FlagDescription
--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-syncDon't set up data sync
--skip-skillsDon't install skills

Requirements

  • Screenpipe running locally
  • SSH access to your agent server
  • AI agent that supports skills (OpenClaw, OpenClaw, etc.)

What You Get

After setup, ask your agent:

  • "What was I working on yesterday?"
  • "Find when I saw that error message"
  • "Summarize my screen activity today"
  • "What meetings did I have this week?"

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.

How It Works

Your Computer                    Your Agent Server
┌─────────────┐                  ┌─────────────────┐
│  Screenpipe │ ──sync daemon──▶ │ ~/.screenpipe/  │
│  (records)  │    (hourly)      │   db.sqlite     │
└─────────────┘                  └────────┬────────┘
                                          │
                                          ▼
                                 ┌─────────────────┐
                                 │  AI Agent       │
                                 │  (OpenClaw)     │
                                 │                 │
                                 │  Skills query   │
                                 │  the database   │
                                 └────────┬────────┘
                                          │
                                          ▼
                                 ┌─────────────────┐
                                 │  Telegram/      │
                                 │  WhatsApp/etc   │
                                 └─────────────────┘

License

MIT - Part of Screenpipe