screenpipe-cli

Operate screenpipe recording, search, pipes, and connections from the terminal.

21.3k|2.2k|Updated Jun 19, 2024
One-click install
npx skills add https://github.com/screenpipe/screenpipe --skill screenpipe-cli
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: screenpipe-cli
Source: https://github.com/screenpipe/screenpipe/tree/main/crates/screenpipe-core/assets/skills/screenpipe-cli
Command: npx skills add https://github.com/screenpipe/screenpipe --skill screenpipe-cli

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Managing screenpipe without the desktop app requires knowing the correct CLI invocation patterns, service modes, and safe ways to query local capture data without corrupting the live database.

Core Features & Use Cases

  • Recorder and Service Management: Install, monitor, and diagnose always-on screen and audio capture services across macOS, Linux, and Windows.
  • Local History Search: Query captured screen and audio history with time ranges, content types, apps, and speakers using JSON output or read-only SQL through the local API.
  • Pipes and Connections: Create, schedule, test, and publish markdown-based AI automation pipes, and configure integrations like Telegram, Slack, Discord, and Todoist.
  • Use Case: An agent checks status --json to verify capture health, searches the last 30 minutes of activity, then creates a one-off pipe that fires tomorrow at 5pm to check for an email reply.

Quick Start

Ask the agent to check screenpipe recording status and search recent activity using the screenpipe CLI.

Frequently Asked Questions about screenpipe-cli

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up continuous screen recording from the command line?

Run doctor, then service install, then status using the screenpipe CLI. The service install command defaults to recorder mode with screen and audio capture launched at login, and doctor reports any macOS permission issues to resolve first.

How do I search my screenpipe history from the terminal?

Use the search command with flags like --start, --content-type, --app, and --json for structured output. For repeated or SQL reads, use the MCP query_recordings tool or the daemon's read-only raw_sql endpoint instead of touching the database directly.

Does the screenpipe CLI work on Windows and Linux?

Yes, the CLI works on macOS, Linux, and Windows. It always runs under bash, using the bundled git-portable bash on Windows, and mktemp is available on all three platforms.

Why does the screenpipe CLI fail in sandboxed agent shells?

Some agents like Codex block shell network access, so bun x cannot fetch the package and calls to localhost:3030 fail. In that case, use the screenpipe MCP tools instead of the CLI.

Can I query the screenpipe SQLite database directly?

No, never access live db.sqlite, db.sqlite-wal, or db.sqlite-shm files directly. Use the search command, the MCP query_recordings tool, or the authenticated raw_sql endpoint on the local API instead.

How do I schedule a one-off automation with screenpipe pipes?

Create a pipe.md with an 'at <RFC3339 timestamp>' schedule in its YAML frontmatter. The pipe fires once at that time, then auto-disables itself while remaining on disk as history.