Docs / CLI
Clipy CLI — your recordings from the terminal
@clipy/cli lists, searches, and reads your screen recordings without a browser: transcripts (including SRT/VTT subtitle export), AI summaries, key moments, MP4 downloads, and the full agent-context bundle. Zero dependencies, Node ≥ 18, and strictly read-only — it can never create, edit, or delete a recording.
1. Install & log in
Create a free API key at clipy.online/settings/api-keys (it looks like clipy_sk_live_… and is shown only once), then:
npm install -g @clipy/cli # or run ad-hoc: npx @clipy/cli list
clipy login # paste your clipy_sk_live_… key oncePrefer no stored state? Set CLIPY_API_KEY in your environment or pass --key per command. Precedence: flag → env → stored config.
2. Commands
Every recording-reading command accepts either the bare public id (3kelcef8wo8h) or the full https://clipy.online/video/<id> share URL.
| command | does |
|---|---|
| clipy login / logout / whoami | Store, clear, or check your API key (kept in ~/.config/clipy, mode 0600). |
| clipy list [-n 20] [--page 2] [--status ready] | List your recordings as a table; --json for scripting. |
| clipy search <query> | Full-text search across titles and descriptions. |
| clipy show <id|share-url> | One recording's metadata, statuses, and share link. |
| clipy transcript <id> [--srt|--vtt] | Plaintext transcript, or proper subtitle export from the timestamped segments. |
| clipy summary <id> | AI summary: TL;DR, key points, action items. |
| clipy moments <id> | Key moments — timestamps, captions, click coordinates, frame URLs. |
| clipy context <id> | The full agent-context bundle as markdown (same content as the .md watch link). |
| clipy download <id> [-o out.mp4] | Download the MP4 with a progress bar. |
| clipy open <id> | Open the share page in your browser. |
| clipy wait <id> --for transcript|summary|both | Block (with spinner) until processing artifacts are ready. |
| clipy mcp | Shortcut that runs the @clipy/mcp server (npx -y @clipy/mcp) for MCP clients. |
3. Scripting
--json prints the raw API response on every read command. Exit codes: 0 ok · 1 error · 2 usage · 3 artifact not ready yet — so scripts can branch on processing state.
# Newest recording's id
clipy list -n 1 --json | jq -r '.recordings[0].id'
# Export subtitles for a recording
clipy transcript 3kelcef8wo8h --srt > recording.srt
# Stop a recording, then block until Clipy finished transcribing
clipy wait 3kelcef8wo8h --for both && clipy summary 3kelcef8wo8hSkill, CLI, or MCP?
The Clipy skill is the default for public pasted links. The CLI is for you — terminals, shell scripts, CI. MCP is for authenticated agent workflows: private library search and inline tool results. clipy mcp bridges the two by launching the MCP server directly.
Package on npm: @clipy/cli · source on GitHub: manovagyanik1/clipy-cli · MCP docs: /docs/mcp · Agent skill: /docs/skill · the full agent story: /for-agents