ScreenFramed CLI

Command-line tools for ScreenFramed captures, projects, auth profiles, and browser-based CLI login.

Install

npm install -g @screenframed/cli

Or run directly:

npx @screenframed/cli login

Login

screenframed login

The CLI opens a browser to approve the device code, then stores a scoped API key in ~/.screenframed.json.

For CI or scripting:

screenframed capture https://example.com --api-key "$SCREENFRAMED_API_KEY"

Capture

screenframed capture https://example.com \
  --device iphone-15-pro \
  --background midnight \
  --shadow \
  --output screenshot.png

Useful options:

screenframed capture https://example.com --url-only
screenframed capture https://example.com --json
screenframed capture https://example.com --async --webhook-url https://example.com/hook
screenframed raw https://example.com --output raw.png

Projects

screenframed projects list
screenframed projects create example.com --name "Marketing site" --default
screenframed projects brand prj_...
screenframed projects secret prj_...

Auth Profiles

Record a logged-in browser session and reuse it for captures behind auth:

screenframed auth login --url https://app.example.com --project prj_...
screenframed capture https://app.example.com/dashboard --auth-profile ap_...
screenframed auth refresh ap_... --url https://app.example.com
screenframed auth list

Environment

Set SCREENFRAMED_API_BASE_URL to target a non-production API.

Links

• Dashboard: https://screenframed.com/dashboard
• Docs: https://docs.screenframed.com
• API reference: https://docs.screenframed.com/api