Appshots CLI Usage

appshots CLI Usage

Controls the running App Screenshots desktop app via HTTP commands on localhost.

Prerequisites

• The App Screenshots desktop app must be running
• Install CLI: dart pub global activate --source path packages/app_screenshots_cli
• Port auto-discovered from ~/.config/app-screenshots/server.port

Connection

# Check the app is running and server is available
appshots status

JSON Mode

All commands support --json for machine-readable output — essential for AI agents and scripted workflows:

appshots --json editor state
appshots --json translate get-texts
appshots --json library list
appshots --json editor list-overlays

Command Groups

Quick Reference

# Status & state
appshots status                        # Check connection
appshots editor state                  # Current design state
appshots multi state                   # Multi-editor state
appshots translate state               # Translation state

# Browse resources
appshots editor list-devices           # Available device frames
appshots editor list-fonts --query ""  # Google Fonts (browsable)
appshots editor list-icons --query ""  # Material & SF Symbols
appshots preset list                   # Available presets
appshots library list                  # Saved designs

API Response Format

All responses return JSON:

{"ok": true, "data": { ... }}

{"ok": false, "error": "Error message"}

Display Types

Tip: For 2025, design at 6.9" iPhone + 13" iPad as your base — Apple auto-scales to smaller sizes.

File Format

• Export as PNG (recommended for sharp text and fine UI details)
• JPEG also accepted
• Must be RGB color space, no transparency, flattened