CLI

Generate App Store screenshots from your terminal. One command to go from a raw simulator capture to all required sizes.

Installation

Run without installing:

npx framefast generate -i screenshot.png --caption "Track your habits"

Or install globally:

npm install -g framefast

Authentication

Set your API key as an environment variable or pass it with --key:

# Environment variable (recommended)
export FRAMEFAST_API_KEY=ff_live_your_key

# Or inline
framefast generate -i screenshot.png --key ff_live_your_key

Commands

generate

Generate one or more App Store screenshots from a raw screenshot file.

framefast generate [options]

Flags

Flag	Default	Description
-i, --input <path>	—	Input screenshot file (required)
-o, --output <dir>	./screenshots/	Output directory
-t, --template <id>	dark-gradient	Template ID
-d, --device <id>	iphone-16-pro	Device frame
--caption <text>	—	Top caption text
--subtitle <text>	—	Bottom caption / subtitle
--badge <type>	none	Badge overlay: none, new, free, rating, pro
--blur	false	Use screenshot as blurred background
--sizes <list>	6.7	Comma-separated sizes: 6.7, 6.5, 5.5, ipad, or all
--key <key>	—	API key (or use FRAMEFAST_API_KEY env var)
--api-url <url>	production	Override API URL

templates

List all available templates.

$ framefast templates

Available templates:

  dark-gradient        Dark Gradient
  light-clean          Light Clean
  colorful             Colorful
  minimal-black        Minimal Black
  neon                 Neon

devices

List all available device frames.

$ framefast devices

Available device frames:

  iphone-16-pro        iPhone 16 Pro
  iphone-16            iPhone 16
  ipad-pro             iPad Pro

Examples

Generate all App Store sizes

framefast generate \
  -i simulator-capture.png \
  --template colorful \
  --caption "Track your habits" \
  --subtitle "Simple and beautiful" \
  --sizes all \
  -o ./appstore-screenshots/

Quick single screenshot

framefast generate -i screen.png --caption "Hello World"

iPad screenshot with badge

framefast generate \
  -i ipad-screen.png \
  --device ipad-pro \
  --template minimal-black \
  --badge pro \
  --sizes ipad

Environment variables

Variable	Description
FRAMEFAST_API_KEY	Your API key. Avoids passing `--key` every time.

← API MCP →