Appshot 📸

AI-First CLI for App Store Screenshots - Generate beautiful, localized screenshots with device frames, gradients, and captions.

🌐 https://appshot.sh

🆕 Version 0.9.1 - Fastlane Export Integration & Screenshot Ordering

• Export Command: New appshot export command for seamless Fastlane integration
• Screenshot Ordering: New appshot order command to control App Store screenshot sequence
• Order Flag: Export with --order to add numeric prefixes (01_, 02_, etc.)
• Smart Ordering: Handles existing prefixes, prevents double-prefixing
• Auto-Detection: Automatically detects languages from your screenshots
• Language Mapping: Smart mapping to Fastlane-compatible language codes (en → en-US, etc.)
• Device Filtering: Export specific devices with --devices iphone,ipad
• Validation: Pre-export validation with warnings and clear error messages
• Configuration Generation: Auto-generate Deliverfile and Fastfile with --generate-config
• Flexible Output: Choose between symlinks (default) or file copying with --copy
• iPad Pro Support: Automatic IPAD_PRO_3GEN_129_ prefix for proper Fastlane recognition
• Dry Run Mode: Preview export operations with --dry-run

Version 0.9.0 - Professional Template System & Enhanced Positioning

• Quick Start: New appshot quickstart command for instant setup with templates
• Templates: 8 professional templates (modern, minimal, bold, elegant, showcase, playful, corporate, nerdy)
• One Command Setup: Apply complete visual styles with appshot template <name>
• Smart Defaults: Each template includes optimized settings for all devices
• Caption Integration: Templates can include captions directly with --caption
• Vertical Alignment: Pin caption text to top or center within the caption box
• Side Margins: Control caption box width with sideMargin (unified wrapping calculation)
• Outer Margins: Add spacing with marginTop/marginBottom for better visual balance
• Apple Watch Fix: Resolved positioning bug allowing proper framePosition control
• Exact Width Parity: Caption wrapping now identical between preview and final render
• Template Samples Overhaul: Local-only gallery with consolidated generator. Run npm run samples to regenerate all 8 presets across iPhone, iPad, Watch, and Mac. Gallery assets now live under template-samples/gallery/ and the samples page matches the appshot.sh look (including ASCII header).

Note on layout changes (0.9.0): This release refines caption placement rules.

• Overlay captions are anchored by the bottom of the entire caption box (padding/border included), and 0 values are respected.
• Above/Below captions enforce a minimum optical clearance from the device and stay fully on‑canvas. In pathological cases where device + caption don’t fit, the engine adapts placement so order is preserved.
• Visual results may differ compared to 0.8.x when captions were near device edges. Adjust marginTop (below) / marginBottom (above) or frameScale/framePosition for fine‑tuning.

📖 Table of Contents

• Why Appshot?
• Features
• Quick Start
  • Prerequisites
  • Installation
  • Your First Screenshot
• Claude Code Integration
• Core Concepts
• Visual Customization
  • Gradient System
  • Font System
  • Device Frames
  • Caption System
  • Style System Guide
• Localization & Translation
• Device Support
• Fastlane Integration
• Command Reference
• Configuration Reference
• Agent & Automation Guide
• Recipes & Examples
• Troubleshooting
• Development
• Roadmap
• License & Support

🌟 Why Appshot?

Appshot is the only agent-first CLI tool designed for automated App Store screenshot generation. Built for LLM agents, CI/CD pipelines, and developers who value automation over GUIs.

NEW in v0.9.0: One-line preset commands! Generate professional screenshots instantly with appshot preset bold --caption "Amazing App" --devices iphone,watch

Key Differentiators

• 🤖 Agent-First Design - JSON outputs, predictable commands, no interactive prompts in automation mode
• 🎯 Smart Automation - Auto-detects orientation, selects appropriate frames, handles batch operations
• 🌍 AI-Powered Localization - Translate captions in real-time using GPT-4o, GPT-5, o1, and o3 models
• 📏 App Store Compliant - Built-in validation for all official Apple App Store specifications
• ⚡ Fast & Parallel - Process hundreds of screenshots with configurable concurrency
• 🛠️ Pure CLI - No web UI, no GUI, just predictable commands perfect for automation

✨ Features

• 🖼️ Smart Frames - Automatically detects portrait/landscape and selects appropriate device frame
• 🎨 Gradient Presets - 24+ beautiful gradients with visual preview and easy application
• 🔤 Font System - 50+ font mappings, direct font setting, interactive selection, and system detection
• 📦 Embedded Fonts - 10 high-quality open source fonts bundled for consistent rendering everywhere
• ✏️ Dynamic Captions - Smart text wrapping, auto-sizing, and multi-line support
• 🌍 AI Translation - Real-time and batch translation using OpenAI's latest models
• 📱 Multi-Device - iPhone, iPad, Mac, Apple TV, Vision Pro, and Apple Watch support
• 🎭 Frame-Only Mode - Quick device framing with transparent backgrounds (no gradients/captions)
• 📏 App Store Specs - All official resolutions with validation and presets
• 🔄 Orientation Detection - Intelligently handles both portrait and landscape
• 👁️ Watch Mode - File system monitoring with auto-processing (macOS)
• 📱 Device Capture - Direct capture from iOS simulators (macOS)
• ⚡ Parallel Processing - Configurable concurrency for large batches
• 🔍 Caption Autocomplete - Intelligent suggestions with fuzzy search and learning
• 🔬 Dry-Run Mode - Preview what would be built without generating images
• 🐛 Verbose Debugging - Detailed rendering metrics for troubleshooting

🚀 Quick Start

Prerequisites

• Node.js 16+ - Required for ESM modules
• npm or yarn - Package manager
• Operating System - macOS, Linux, or Windows
• Optional: OpenAI API key for translation features

Installation

# Install globally via npm
npm install -g appshot-cli

# Or with yarn
yarn global add appshot-cli

# Verify installation
appshot --version

Note: The package is called appshot-cli on NPM, but the command is appshot

Your First Screenshot - Two Ways

Option 1: Quick Start with Templates (NEW! 🎨)

The fastest way to get professional screenshots:

# One command interactive setup
appshot quickstart

# Or apply a specific template
appshot template modern --caption "Your Amazing App"

# Build your screenshots
appshot build

# ✨ Professional screenshots ready in seconds!

Option 2: Traditional Step-by-Step

Full control over every aspect:

# 1. Initialize your project
appshot init

# 2. Add your screenshots
cp ~/Desktop/screenshots/*.png screenshots/iphone/

# 3. Add captions interactively
appshot caption --device iphone

# 4. Apply a gradient preset
appshot gradients --apply ocean

# 5. Build final screenshots
appshot build

# ✨ Output ready in final/ directory!

Quick Frame-Only Mode

Need just device frames without the full treatment? Use the new frame command:

# Frame a single screenshot
appshot frame screenshot.png

# Batch frame a directory
appshot frame ./screenshots --recursive

# ✨ Framed PNGs with transparent backgrounds ready!

Watch Mode (macOS)

Automatically process screenshots as they're added:

# Start watching for new screenshots
appshot watch start --process --background

# Capture from simulator (auto-processes via watch)
appshot device capture

# Check status
appshot watch status

# Stop watching
appshot watch stop

Example Output Structure

final/
├── iphone/
│   └── en/           # Language subdirectory (always created)
│       ├── home.png       # 1284×2778 with frame, gradient, and caption
│       ├── features.png   
│       └── settings.png
└── ipad/
    └── en/           # Language subdirectory
        └── dashboard.png  # 2048×2732 iPad Pro screenshot

🤖 Claude Code Integration

Appshot includes comprehensive Claude Code slash commands for AI-assisted screenshot generation. See the complete commands documentation for detailed examples and workflows.

Available Commands

Appshot provides specialized commands for different tasks:

• /appshot-init - Initialize and configure new projects
• /appshot-preset - One-line preset commands for instant screenshots
• /appshot-style - Apply gradients, fonts, and visual styling
• /appshot-caption - Manage captions and translations
• /appshot-build - Build screenshots with troubleshooting
• /appshot-config - Complete configuration reference
• /appshot-quick - Quick reference for common tasks

Quick Installation

# If you have AppShot source code
cd appshot
./commands/install.sh

# If installed via npm
cd node_modules/appshot-cli
./commands/install.sh

# Manual installation
mkdir -p ~/.claude/commands
ln -sf "$(pwd)/commands"/*.md ~/.claude/commands/

How It Works

When you use a command like /appshot-style ocean iphone in Claude Code:

1. Claude receives complete documentation for that specific task
2. All necessary configurations and examples are provided inline
3. No need to search documentation or run help commands
4. Claude can immediately execute the appropriate AppShot CLI commands

Example Conversation

User: I need to add Apple Watch support to my existing iPhone project

Claude: I'll help you add Apple Watch to your project. Let me use /appshot-config
        to show you the exact configuration needed.

        Add this to your .appshot/config.json under "devices":

        "watch": {
          "input": "./screenshots/watch",
          "resolution": "410x502",
          "autoFrame": true
        }

        Note: Apple Watch has special caption handling - uses 2-line wrapping 
        and smaller font size (36px max) for the smaller screen.

Features for AI Agents

• Self-Contained: Each command includes all necessary information
• No Lookups Required: Commands work without external documentation
• Agent-Friendly: Non-interactive commands for full automation
• Complete Examples: Real-world configurations and workflows
• Troubleshooting: Built-in solutions for common issues

Learn More

For complete documentation, examples, and advanced workflows, see:

• 📚 Commands Documentation - Full guide with examples
• 📁 Commands Directory - Individual command files
• 🛠️ Installation Script - Automated setup

📘 Core Concepts

Project Structure

Appshot creates and manages the following directory structure in your project:

your-project/
├── .appshot/
│   ├── config.json          # Main configuration
│   ├── captions/            # Device-specific captions
│   │   ├── iphone.json
│   │   ├── ipad.json
│   │   ├── mac.json
│   │   └── watch.json
│   ├── caption-history.json # Autocomplete history (created on use)
│   ├── ai-config.json       # AI translation settings (optional)
│   ├── processed/           # Watch mode tracking (macOS only)
│   └── watch.pid            # Watch service PID (macOS only)
├── screenshots/             # Your original screenshots
│   ├── iphone/
│   │   └── background.png  # Optional device background
│   ├── ipad/
│   ├── mac/
│   └── watch/
└── final/                   # Generated output
    ├── iphone/
    │   ├── en/              # Language subdirectory (always created)
    │   ├── es/              # Additional languages as needed
    │   └── fr/
    └── ipad/
        └── en/

Created by appshot init:

• .appshot/ directory with config.json
• .appshot/captions/ with device JSON files
• screenshots/ directories for each device type

Created during usage:

• final/ - Created when you run appshot build
• .appshot/caption-history.json - Created when using captions
• .appshot/processed/ - Created by watch mode (macOS)

Configuration Overview

All settings are stored in .appshot/config.json:

{
  "output": "./final",
  "gradient": {
    "colors": ["#0077BE", "#33CCCC"],
    "direction": "diagonal"
  },
  "caption": {
    "font": "SF Pro",
    "fontsize": 64,
    "color": "#FFFFFF",
    "position": "above"
  },
  "devices": {
    "iphone": {
      "resolution": "1290x2796",
      "autoFrame": true
    }
  }
}

Workflow

1. Capture - Take screenshots from simulator/device or design tool
2. Configure - Set up gradients, fonts, and device settings
3. Caption - Add marketing text with optional AI translation
4. Build - Generate final App Store-ready screenshots
5. Validate - Ensure compliance with App Store requirements

🎨 Visual Customization

Template System (NEW! 🚀)

Appshot now includes professional screenshot templates that configure everything with a single command. Each template includes carefully designed backgrounds, device positioning, caption styling, and device-specific optimizations.

Quick Start with Templates

# Interactive template selection
appshot quickstart

# Apply a specific template
appshot template modern

# Apply template with caption
appshot template minimal --caption "Beautiful & Simple"

# Preview template settings
appshot template --preview bold

# List all templates
appshot template --list

Available Templates

📸 View Template Gallery - See visual examples of all templates

| Template | Description | Best For | |----------|-------------|----------| | modern | Vibrant gradient with floating device and clean captions | Most apps, eye-catching | | minimal | Soft pastel background with elegant typography | Clean, simple apps | | bold | Dark dramatic gradient with overlay captions | Gaming, entertainment | | elegant | Sophisticated monochrome design | Professional, business | | showcase | Auto-detects custom backgrounds, partial frames | Apps with branded assets | | playful | Bright, fun gradients | Games, kids apps | | corporate | Clean, professional look | Business, productivity | | nerdy | JetBrains Mono typography with OSS grid background | Developer tools |

Rebuild the Gallery Locally

# From repo root
npm run samples

This generates:

• Device samples: template-samples/{iphone|ipad|watch|mac}/<template>-<device>.png
• Gallery cards: template-samples/gallery/*-sample.png
• Combined image: template-samples/gallery/template-gallery.png

Template Features

Each template automatically configures:

• Background: Gradient colors and direction or image settings
• Device Scale: Optimal size for visual balance (70-110%)
• Device Position: Top, center, bottom, or custom percentage
• Caption Style: Font, size, color, and position
• Caption Background: Optional semi-transparent background with padding
• Caption Border: Optional border with customizable radius
• Partial Frames: Modern look with cut-off device bottoms
• Device Overrides: Optimized settings for watch, iPad, etc.

Template Examples

# Modern Template - Perfect for most apps
appshot template modern
# → Vibrant diagonal gradient (#667eea → #764ba2 → #f093fb)
# → 85% device scale, centered
# → White captions with dark semi-transparent background

# Minimal Template - Clean and simple
appshot template minimal  
# → Soft pastel gradient (#ffecd2 → #fcb69f)
# → 75% device scale, lower position
# → Dark text on light background

# Bold Template - Make a statement
appshot template bold
# → Dark gradient (#0f0c29 → #302b63 → #24243e)
# → 110% device scale with partial frame
# → Large overlay captions with border

# Showcase Template - Feature your backgrounds
appshot template showcase
# → Auto-detects background.png in device folders
# → 90% scale with 25% partial frame
# → Glass-morphism caption effect

Customizing Templates

Templates provide a starting point that you can further customize:

# 1. Apply a template
appshot template modern

# 2. Fine-tune specific settings
appshot style --device iphone  # Adjust positioning
appshot fonts --set "Poppins Bold"  # Change font
appshot caption --device iphone  # Update captions

# 3. Build with your customizations
appshot build

Creating Consistent Screenshots

Templates ensure consistency across all your screenshots:

// After applying a template, all devices share:
{
  "background": { /* Same gradient/image */ },
  "caption": { /* Same font and styling */ },
  "devices": {
    "iphone": { /* Optimized for iPhone */ },
    "ipad": { /* Optimized for iPad */ },
    "watch": { /* Special watch handling */ }
  }
}

Gradient System

Appshot includes 24+ professional gradient presets organized by category:

Browse & Apply Gradients

# View all gradients with color preview
appshot gradients

# Apply a gradient to your project
appshot gradients --apply sunset

# Interactive selection
appshot gradients select

# Generate preview image
appshot gradients --preview ocean

# Create sample gallery
appshot gradients --sample

Gradient Categories

• 🔥 Warm: sunset, autumn, golden, coral
• ❄️ Cool: ocean, arctic, mint, twilight
• 🎨 Vibrant: neon, tropical, rainbow, vivid
• 🕊️ Subtle: pastel, lavender, peach, sky
• ⚫⚪ Monochrome: noir, silver, charcoal, pearl
• 🏢 Brand: instagram, spotify, twitter, slack

Custom Gradients

{
  "gradient": {
    "colors": ["#FF5733", "#FFC300", "#FF1493"],
    "direction": "diagonal"  // top-bottom, left-right, diagonal
  }
}

Background System

Replace gradients with custom static background images for a unique, branded look. Appshot supports automatic detection, multiple formats, and intelligent scaling.

Background Locations

Backgrounds are searched in priority order:

1. Device-specific: screenshots/<device>/background.png
2. Global: screenshots/background.png
3. Custom: Path specified via config or CLI

Background Commands

# Set background for a device
appshot backgrounds set iphone ./backgrounds/sunset.jpg

# Set global background for all devices
appshot backgrounds set --global ./backgrounds/brand-bg.png

# Validate dimensions against App Store specs
appshot backgrounds validate

# List all configured backgrounds
appshot backgrounds list

# Clear background configuration
appshot backgrounds clear iphone

Build Options

# Auto-detect background.png in device folders
appshot build --auto-background

# Use specific background image
appshot build --background ./assets/custom-bg.png

# Set background fit mode
appshot build --background-fit cover

# Disable backgrounds (transparent)
appshot build --no-background

Fit Modes

• cover - Scale to cover entire area (may crop)
• contain - Scale to fit within area (may add letterbox bars)
• fill - Stretch to exact dimensions (may distort)
• scale-down - Only scale down if larger, never scale up

Creating Backgrounds with ImageMagick

ImageMagick is a powerful CLI tool for creating custom backgrounds:

# Solid color background
magick -size 1290x2796 canvas:navy background.png

# Gradient background
magick -size 1290x2796 gradient:blue-purple background.png

# Radial gradient
magick -size 1290x2796 radial-gradient:white-darkblue background.png

# Plasma fractal pattern
magick -size 1290x2796 plasma:fractal background.png

# Blurred noise texture
magick -size 1290x2796 xc: +noise Random -blur 0x10 background.png

# Tiled pattern
magick -size 100x100 pattern:checkerboard -scale 1290x2796 background.png

# Multi-point color interpolation
magick -size 1290x2796 xc: -sparse-color barycentric \
  '0,0 skyblue 1290,0 white 645,2796 lightblue' background.png

Configuration

{
  "background": {
    "mode": "image",
    "image": "./backgrounds/global.png",
    "fit": "cover"
  },
  "devices": {
    "iphone": {
      "background": {
        "image": "./backgrounds/iphone.png",
        "fit": "contain"
      }
    }
  }
}

Mixed Configurations

You can mix backgrounds and gradients across devices:

• iPhone uses a custom background image
• iPad falls back to gradient
• Mac uses a different background
• Watch uses the global background

This flexibility allows you to optimize each device's appearance independently.

Dimension Validation

Appshot validates background dimensions and warns about:

• Images smaller than target resolution (will be upscaled)
• Aspect ratio mismatches (may cause cropping/distortion)
• Large file sizes (>10MB triggers optimization suggestion)

Use appshot backgrounds validate to check all backgrounds before building.

Font System

Version 0.4.0 introduces comprehensive font management with intelligent fallbacks.

Font Commands

# Browse recommended fonts
appshot fonts

# Set font directly (NEW in v0.4.0)
appshot fonts --set "Montserrat"

# Interactive font selection (NEW in v0.4.0)
appshot fonts --select

# Set device-specific font (NEW in v0.4.0)
appshot fonts --set "SF Pro" --device iphone

# List ALL system fonts
appshot fonts --all

# Validate a font
appshot fonts --validate "SF Pro"

# Get JSON output for automation
appshot fonts --json

Font Setting Methods

You have three ways to set fonts:

1. Direct Command (Fastest):

   appshot fonts --set "Helvetica"
   appshot fonts --set "SF Pro" --device iphone

2. Interactive Selection:

   appshot fonts --select
   appshot style --device iphone  # Also includes font selection

3. Manual Configuration:

   {
     "caption": {
       "font": "Montserrat",     // Global default
       "fontsize": 64
     },
     "devices": {
       "iphone": {
         "captionFont": "SF Pro"  // Device override
       }
     }
   }

Intelligent Fallbacks

Every font automatically includes appropriate fallback chains:

• SF Pro → system-ui, -apple-system, Helvetica, Arial, sans-serif
• Custom Serif → 'Custom Serif', Georgia, Times New Roman, serif
• Code Font → 'Code Font', Monaco, Consolas, monospace

System Font Detection

• macOS: Uses system_profiler for complete font list
• Linux: Uses fc-list for fontconfig fonts
• Windows: PowerShell queries font registry

Frame-Only Mode

New in v0.8.0, the appshot frame command provides a quick way to apply device frames to screenshots without adding gradients or captions. Perfect for design workflows, quick exports, and when you just need a framed device mockup.

Features

• Auto Device Detection - Intelligently detects iPhone, iPad, Mac, or Apple Watch from image dimensions
• Transparent Backgrounds - Outputs PNG with alpha channel preserved
• Batch Processing - Frame entire directories with recursive support
• Smart Frame Selection - Automatically chooses portrait/landscape frames
• No Configuration Required - Works instantly without setup

Basic Usage

# Frame a single screenshot
appshot frame screenshot.png

# Frame all images in a directory
appshot frame ./screenshots

# Recursive directory processing
appshot frame ./screenshots --recursive

# Output to specific directory
appshot frame screenshot.png -o ./framed

# Force device type
appshot frame screenshot.png --device iphone

Options

• -o, --output <dir> - Output directory (default: same as input)
• -d, --device <type> - Force device type (iphone|ipad|mac|watch)
• -r, --recursive - Process directories recursively
• -f, --format <type> - Output format: png (default) or jpeg
• --suffix <text> - Filename suffix (default: "-framed")
• --overwrite - Overwrite original file name
• --dry-run - Preview without processing
• --verbose - Show detailed information

Examples

# Batch frame iPhone screenshots
appshot frame ./iphone-screenshots

# Frame with custom output directory
appshot frame ./screenshots -o ./mockups --recursive

# Preview what would be framed
appshot frame ./screenshots --dry-run

# Force iPad frame for ambiguous dimensions
appshot frame screenshot.png --device ipad

# JPEG output with white background
appshot frame screenshot.png --format jpeg

Device Detection Logic

The frame command uses intelligent heuristics to detect device type:

1. Apple Watch - Small, square-ish images (< 600k pixels, aspect ratio 0.75-1.3)
2. iPad - 4:3 aspect ratio (1.20-1.40) with 1.5M-8M pixels
3. Mac - 16:10 or 16:9 aspect ratio (1.50-1.85) with 2M+ pixels
4. iPhone - Tall aspect ratios (1.60-2.40) with < 5M pixels

When dimensions are ambiguous, use --device to specify the target device.

Device Frames

Smart Frame Selection

Appshot automatically detects screenshot orientation and selects the appropriate frame:

{
  "devices": {
    "iphone": {
      "autoFrame": true,  // Auto-detect orientation
      "preferredFrame": "iphone-16-pro-max-portrait"  // Override
    }
  }
}

Partial Frames

Create modern App Store screenshots with cut-off device frames:

{
  "devices": {
    "iphone": {
      "partialFrame": true,
      "frameOffset": 25,      // Cut 25% from bottom
      "framePosition": 40,    // Position at 40% from top
      "frameScale": 0.85      // Scale to 85%
    }
  }
}

Frame Positioning System

Important: The framePosition value (0-100) behaves differently depending on your caption positioning mode.

Relative vs Absolute Positioning

When using captionPosition: "above" or "below":

• Frame positioning is RELATIVE to the remaining space after accounting for the caption
• framePosition: 0 = Top of available space (immediately after/before caption)
• framePosition: 50 = Center of remaining space
• framePosition: 100 = Bottom of available space

When using captionPosition: "overlay":

• Frame positioning is ABSOLUTE to the entire canvas
• framePosition: 0 = Top of canvas (pixel 0)
• framePosition: 50 = Center of entire canvas
• framePosition: 100 = Bottom of canvas

Visual Examples

// Example 1: Caption above with framePosition: 0
{
  "devices": {
    "iphone": {
      "captionPosition": "above",
      "framePosition": 0  // Device starts right after caption
    }
  }
}
// Result: [Caption] then [Device at top of remaining space]

// Example 2: Caption overlay with framePosition: 0
{
  "devices": {
    "iphone": {
      "captionPosition": "overlay",
      "framePosition": 0  // Device at absolute top
    }
  }
}
// Result: [Device at canvas top] with [Caption overlaid at bottom]

The Math Behind Positioning

For "above" mode, the device position is calculated as:

deviceTop = topMargin + captionHeight + (availableSpace * framePosition/100)
where availableSpace = canvasHeight - topMargin - captionHeight - bottomMargin - deviceHeight

For "overlay" mode, the device position is calculated as:

deviceTop = availableSpace * (framePosition/100)
where availableSpace = canvasHeight - bottomMargin - deviceHeight

Practical Implications

1. Same framePosition, Different Results: A framePosition: 0 will place the device at different absolute positions:

   • With above caption: Device starts after the caption (e.g., at pixel 198)
   • With overlay caption: Device starts at the top (pixel 0)

2. Caption Height Affects Layout: In above/below modes, varying caption lengths change the available space, affecting all frame positions. Use overlay mode for consistent device positioning across screenshots with different caption lengths.

3. Best Practices:

   • Use above/below for guaranteed caption-device separation
   • Use overlay for consistent device positioning across all screenshots
   • Set fixed caption heights (minHeight/maxHeight) for uniform layouts

📚 Visual Preset Showcase - Interactive visual guide showing all available preset templates and their styles

Caption System

Dynamic Caption Box

Intelligent caption rendering that adapts to content:

{
  "caption": {
    "position": "above",      // above, below, or overlay
    "box": {
      "autoSize": true,       // Dynamic height
      "maxLines": 3,          // Line limit
      "lineHeight": 1.4,      // Line spacing
      "minHeight": 100,
      "maxHeight": 500
    }
  }
}

Caption Positioning Options

• above (default): Caption appears above the device frame
• below (new in v0.7.0): Caption appears below the device frame
• overlay: Caption overlays on the gradient background

# Configure caption below device
appshot style --device iphone
# → Select "Below device frame" option

# Or set directly in config
{
  "devices": {
    "iphone": {
      "captionPosition": "below"
    }
  }
}

Caption Styling (Enhanced in v0.8.7)

Create professional captions with customizable backgrounds and borders:

{
  "caption": {
    "color": "#FFFFFF",           // Text color (hex)
    "background": {
      "color": "#000000",         // Background color (hex)
      "opacity": 0.8,             // Transparency (0-1)
      "padding": 20               // Padding around text
    },
    "border": {
      "color": "#FFFFFF",         // Border color (hex)
      "width": 2,                 // Border thickness (1-10)
      "radius": 12                // Rounded corners (0-30); used for background too
    }
  }
}

Key Features:

• Full-width styling - Backgrounds and borders span device width for uniformity
• Flexible positioning - Works with above, below, and overlay positions
• Device-specific overrides - Customize styling per device type
• Professional appearance - Rounded corners and padding for polished look
• Vertical anchoring (NEW) - Align caption text to top or center of the box
• Unified side margins (NEW) - Control caption box width with caption.background.sideMargin

Interactive Configuration:

# Configure caption styling interactively
appshot style --device iphone
# → Choose caption position (above/below/overlay)
# → Configure background color and opacity
# → Set border color, width, and radius
# → Set vertical alignment (top/center)
# → Set side margin, min/max height, max lines

Examples:

// Dark background with white border
{
  "caption": {
    "color": "#FFFFFF",
    "background": {
      "color": "#000000",
      "opacity": 0.9,
      "padding": 30
    },
    "border": {
      "color": "#FFFFFF",
      "width": 3,
      "radius": 16
    }
  }
}

// Subtle gradient-matched styling
{
  "caption": {
    "color": "#FFFFFF",
    "background": {
      "color": "#FF5733",
      "opacity": 0.6,
      "padding": 25,
      "sideMargin": 24
    }
  }
}

Fixed vs Adaptive Caption Height

{
  "caption": {
    "position": "above",
    "box": {
      "autoSize": false,       // Fixed height banner
      "minHeight": 320,
      "maxHeight": 320,
      "verticalAlign": "top"   // Pin text to top of banner
    }
  }
}

• Set autoSize: true plus minHeight/maxHeight clamps for adaptive banners.
• Use verticalAlign: 'top' to avoid recenters when height changes.

Preset Templates Guide

An interactive showcase of all available preset templates is available at positioning-guide/preset-showcase.html.

• Visual preview of all 7 professional templates (modern, minimal, bold, elegant, showcase, playful, corporate)
• Side-by-side comparison across iPhone, iPad, Mac, and Watch devices
• Shows gradient backgrounds, device positioning, and caption styles
• Helps you choose the perfect template for your app's style
• One-line command examples for each preset

Open the file in a browser to explore all available templates before applying them via appshot preset or appshot template.

Caption Autocomplete

The caption command includes intelligent autocomplete:

appshot caption --device iphone
# Features:
# - Fuzzy search
# - Frequency tracking
# - Device-specific suggestions
# - Pattern detection

Keyboard shortcuts:

• Tab - Complete suggestion
• ↑↓ - Navigate suggestions
• Enter - Select
• Esc - Dismiss

🌍 Localization & Translation

AI-Powered Translation

Appshot integrates with OpenAI for instant caption translation.

Setup

export OPENAI_API_KEY="your-api-key-here"

Real-Time Translation

# Translate as you type
appshot caption --device iphone --translate --langs es,fr,de

# Output:
# ? home.png: Welcome to the future
#   es: Bienvenido al futuro
#   fr: Bienvenue dans le futur
#   de: Willkommen in der Zukunft

Batch Translation

# Translate all existing captions
appshot localize --langs es,fr,de,ja,zh-CN

# Device-specific translation
appshot localize --device iphone --langs es,fr

# Use premium model
appshot localize --langs ja,ko --model gpt-5

# Review before saving
appshot localize --langs es --review

Supported Models

| Model Series | Best For | Parameter | Temperature | |-------------|----------|-----------|-------------| | GPT-4o | Fast, cost-effective | max_tokens | 0.3 | | GPT-5 | High-quality, nuanced | max_completion_tokens | 1.0 | | o1 | Deep reasoning | max_completion_tokens | 1.0 | | o3 | State-of-the-art | max_completion_tokens | 1.0 |

Supported Languages

25+ languages including:

• European: es, fr, de, it, pt, nl, sv, no, da, fi, pl, ru
• Asian: ja, ko, zh-CN, zh-TW, hi, th, vi, id, ms
• Middle Eastern: ar, he, tr
• Variants: pt-BR

Multi-Language Workflow

# 1. Add captions with translation
appshot caption --device iphone --translate --langs es,fr

# 2. Build localized screenshots
appshot build --langs en,es,fr

# Output structure (always uses language subdirectories):
# final/
#   iphone/
#     en/
#     es/
#     fr/

📱 Device Support

Apple Devices

| Device | Orientations | Frame Variants | Special Features | |--------|-------------|----------------|------------------| | iPhone | Portrait, Landscape | 15+ models | Notch/Dynamic Island support | | iPad | Portrait, Landscape | 10+ models | Multiple sizes | | Mac | Landscape | 4 resolutions | 16:10 aspect ratio | | Apple Watch | Portrait | 5 sizes | Band cropping | | Apple TV | Landscape | HD, 4K | TV frame | | Vision Pro | Landscape | 3840×2160 | Spatial computing |

App Store Specifications

Required Resolutions

iPhone (choose one):

• 6.9" Display: 1290×2796 (iPhone 16/15 Pro Max)
• 6.5" Display: 1284×2778 (iPhone 14 Plus)

iPad:

• 13" Display: 2064×2752 or 2048×2732

Mac:

• 16:10 aspect: 2880×1800, 2560×1600, 1440×900, or 1280×800

Apple Watch:

• Must use same size across all localizations

Preset Management

# View all presets
appshot presets

# Show required only
appshot presets --required

# Generate config for specific presets
appshot presets --generate iphone-6-9,ipad-13

# Build with presets
appshot build --preset iphone-6-9,ipad-13

Validation

# Validate against App Store requirements
appshot validate

# Strict mode (required presets only)
appshot validate --strict

# Get fix suggestions
appshot validate --fix

🚀 Fastlane Integration

Appshot seamlessly integrates with Fastlane for uploading screenshots to App Store Connect. The export command reorganizes your Appshot-generated screenshots into Fastlane's expected directory structure.

Overview

Appshot and Fastlane work together but remain separate tools:

• Appshot: Generates beautiful screenshots with frames, gradients, and captions
• Fastlane: Uploads screenshots to App Store Connect

Quick Start

# 1. Generate screenshots with Appshot
appshot build --preset iphone-6-9,ipad-13

# 2. Export for Fastlane (auto-detects languages)
appshot export

# 3. Upload with Fastlane
cd fastlane && fastlane deliver

Export Command

The appshot export command bridges Appshot and Fastlane:

# Basic export (auto-detects languages, creates symlinks)
appshot export

# Export specific devices only
appshot export --devices iphone,ipad

# Copy files instead of symlinks (for CI/CD)
appshot export --copy --clean

# Generate Fastlane configuration
appshot export --generate-config

# Preview without creating files
appshot export --dry-run

# Custom paths
appshot export --source ./my-screenshots --output ./upload

Language Mapping

Appshot automatically maps language codes to Fastlane format:

• en → en-US
• es → es-ES
• fr → fr-FR
• de → de-DE
• zh → zh-Hans
• pt → pt-PT
• [and 20+ more mappings]

Custom mappings via .appshot/export-config.json:

{
  "languageMappings": {
    "en": "en-GB",
    "custom": "x-special"
  }
}

Directory Structure

Appshot Output (source):

final/
├── iphone/
│   ├── en/
│   │   ├── home.png
│   │   └── features.png
│   └── es/
│       └── home.png
└── ipad/
    └── en/
        └── home.png

Fastlane Structure (after export):

fastlane/screenshots/
├── en-US/
│   ├── iphone/
│   │   ├── home.png
│   │   └── features.png
│   └── ipad/
│       └── IPAD_PRO_3GEN_129_home.png  # Auto-renamed
└── es-ES/
    └── iphone/
        └── home.png

Special Handling

iPad Pro Naming

iPad Pro 12.9" (3rd gen) screenshots are automatically renamed with the IPAD_PRO_3GEN_129_ prefix for proper Fastlane recognition.

Symlinks vs Copying

• Default: Creates symlinks (saves disk space, instant)
• CI/CD: Use --copy for portable archives
• Clean: Use --clean to remove old exports before creating new ones

Screenshot Ordering (NEW! v0.9.1)

📌 Important Discovery: Fastlane uploads screenshots in alphabetical order by filename. Without explicit ordering, your carefully arranged screenshots may appear in the wrong sequence on the App Store!

The Order Problem

When exporting screenshots for Fastlane, the alphabetical ordering can disrupt your intended flow:

• ❌ Without ordering: bluesky.png, cast.png, home.png, media.png, updates.png
• ✅ With ordering: 01_home.png, 02_updates.png, 03_cast.png, 04_media.png, 05_bluesky.png

Managing Screenshot Order

# Set order interactively for each device
appshot order --device iphone
appshot order --device ipad
appshot order --device watch

# Export with numeric prefixes
appshot export --order --copy --clean

# View current order
appshot order --show

The order configuration is saved in .appshot/screenshot-order.json and intelligently handles:

• Files with existing numeric prefixes (prevents double-prefixing like 01_01_home.png)
• Mixed naming conventions in your source files
• New screenshots added after initial ordering

Quick Order Setup

Create a standard order configuration:

cat > .appshot/screenshot-order.json << 'EOF'
{
  "version": "1.0",
  "orders": {
    "iphone": ["home.png", "features.png", "search.png", "profile.png", "settings.png"],
    "ipad": ["home.png", "features.png", "search.png", "profile.png", "settings.png"],
    "watch": ["home.png", "features.png", "profile.png"]
  }
}
EOF

Fastlane Gotchas & Solutions

🔍 Key Discoveries from Real-World Integration

1. Nested Directory Limitations

Problem: Fastlane's deliver command struggles with nested device directories inside language folders.

Solution: Appshot v0.9.1+ automatically flattens the structure during export:

# Appshot structure (nested):
final/iphone/en/home.png →

# Fastlane structure (flattened):
fastlane/screenshots/en-US/iphone/home.png

2. Device-Specific Prefixes

Discovery: Some devices require specific filename prefixes for Fastlane to recognize them correctly.

Handled Automatically:

• iPad Pro 12.9" (3rd gen) → IPAD_PRO_3GEN_129_ prefix
• iPad Pro 11" → IPAD_PRO_11_ prefix

3. Upload Staging Approach

For complex projects with many screenshots, use the staging approach in your Fastfile:

lane :upload_screenshots_staged do
  # Flattens nested structures for Fastlane compatibility
  # Handles device prefixes automatically
  # See full implementation in Fastlane export --generate-config
end

4. API Key Configuration

Important: Never commit your api_key.json to version control!

# Use the template
cp fastlane/api_key.json.template fastlane/api_key.json
# Edit with your credentials
# Add to .gitignore (done automatically by export --generate-config)

Complete Workflow Example

# 1. Initialize Appshot project
appshot init

# 2. Add your raw screenshots
# Place them in screenshots/iphone/home.png, etc.

# 3. Generate styled screenshots
appshot build --preset iphone-6-9,ipad-13 --langs en,es,fr

# 4. Export for Fastlane with config generation
appshot export --generate-config

# 5. Configure Fastlane (one-time setup)
cd fastlane
# Edit Deliverfile with your App Store Connect credentials
# app_identifier "com.example.myapp"
# username "[email protected]"

# 6. Upload to App Store Connect
fastlane deliver --skip_metadata --skip_app_version_update

# 7. For updates, just rebuild and re-export
appshot build --preset iphone-6-9,ipad-13
appshot export --clean
cd fastlane && fastlane deliver

CI/CD Integration

# GitHub Actions Example
- name: Generate Screenshots
  run: |
    npm install -g appshot-cli
    appshot build --preset iphone-6-9,ipad-13

- name: Export for Fastlane
  run: appshot export --copy --clean

- name: Upload to App Store
  env:
    APP_STORE_CONNECT_API_KEY: ${{ secrets.ASC_API_KEY }}
  run: |
    cd fastlane
    fastlane deliver --api_key_path api_key.json

Validation

The export command includes comprehensive validation:

• Checks for valid output directory permissions
• Validates language codes against Fastlane's supported set
• Warns about missing screenshots for requested devices
• Suggests App Store required presets if missing

# Preview and validate
appshot export --dry-run --verbose

# Check what would be exported
appshot export --dry-run --json | jq

Generated Fastlane Files

With --generate-config, Appshot creates:

• Deliverfile: Screenshot configuration
• Fastfile: Upload lanes
• README.md: Instructions
• .gitignore: Excludes screenshots

Example generated Deliverfile:

# Generated by Appshot
screenshots_path "./screenshots"
languages ["en-US", "es-ES", "fr-FR"]
skip_binary_upload true
skip_metadata true
overwrite_screenshots true

Tips

1. Language Detection: Let Appshot auto-detect languages from your screenshots
2. Device Filtering: Export only what you need with --devices
3. Dry Run First: Always preview with --dry-run before actual export
4. Validation: Run appshot validate before export to ensure compliance
5. Incremental Updates: Use --clean to ensure fresh exports

📝 Command Reference

appshot quickstart (NEW!)

Get started with App Store screenshots in seconds with interactive setup.

appshot quickstart [options]

Options:

• --template <id> - Template to use (default: modern)
• --caption <text> - Main caption for screenshots
• --no-interactive - Skip interactive prompts
• --force - Overwrite existing configuration

What it does:

1. Creates project structure
2. Applies professional template
3. Sets up example captions
4. Shows next steps

Examples:

# Interactive setup
appshot quickstart

# Quick setup with template
appshot quickstart --template minimal --caption "My App"

# Non-interactive
appshot quickstart --template bold --no-interactive

appshot template (NEW!)

Apply professional screenshot templates for instant visual styling.

appshot template [template] [options]

Arguments:

• [template] - Template ID (modern, minimal, bold, elegant, showcase, playful, corporate)

Options:

• --list - List all available templates
• --preview <id> - Preview template configuration
• --caption <text> - Add caption to all screenshots
• --device <name> - Apply to specific device only
• --no-backup - Skip config backup
• --dry-run - Preview without applying

Examples:

# List templates
appshot template --list

# Apply template
appshot template modern

# With caption
appshot template minimal --caption "Beautiful App"

# Preview settings
appshot template --preview bold

# Device-specific
appshot template elegant --device iphone

appshot preset (NEW!)

Ultra-simple one-line commands to generate App Store screenshots with professional templates.

appshot preset <preset-name> [options]

Arguments:

• <preset-name> - Template to use (modern, bold, minimal, elegant, showcase, playful, corporate)

Options:

• -c, --caption <text> - Add caption to all screenshots
• -d, --devices <list> - Comma-separated device list
• -l, --langs <list> - Comma-separated language codes
• -o, --output <path> - Output directory (default: ./final)
• --dry-run - Preview without building
• -v, --verbose - Show detailed output

Examples:

# Quick professional screenshots
appshot preset modern --caption "Amazing Features"

# Multiple devices
appshot preset bold --devices iphone,ipad,watch

# Multiple languages
appshot preset minimal --langs en,es,fr,de

# Custom output
appshot preset elegant --output ./marketing/screenshots

# Preview mode
appshot preset corporate --dry-run

# Full example
appshot preset showcase \
  --caption "Summer Sale!" \
  --devices iphone,ipad \
  --langs en,es,fr \
  --output ./app-store-assets

What it does:

1. Applies professional template (gradient, positioning, styling)
2. Adds caption to first screenshot if provided
3. Builds screenshots for specified devices and languages
4. All in one command - perfect for CI/CD!

appshot build

Generate final screenshots with frames, gradients, and captions.

appshot build [options]

Options:

• --devices <list> - Comma-separated device list (default: all)
• --preset <ids> - Use App Store presets (e.g., iphone-6-9,ipad-13)
• --config <file> - Custom config file (default: .appshot/config.json)
• --langs <list> - Build for specific languages (if not specified, auto-detects)
• --preview - Generate low-res previews
• --concurrency <n> - Parallel processing limit (default: 5)
• --dry-run - Show what would be rendered without generating images
• --verbose - Show detailed rendering information
• --no-frame - Skip device frames
• --no-gradient - Skip gradient backgrounds
• --no-caption - Skip captions

Language Detection: When --langs is not specified, appshot automatically determines languages in this order:

1. Languages found in caption files (if using multi-language captions)
2. defaultLanguage setting in config.json
3. System locale (e.g., fr for French systems)
4. Fallback to en

Examples:

# Build all devices
appshot build

# Specific devices and languages
appshot build --devices iphone,ipad --langs en,fr,es

# Use App Store presets
appshot build --preset iphone-6-9-portrait,ipad-13-landscape

# Preview mode
appshot build --preview --devices iphone

# Dry-run to see what would be built
appshot build --dry-run

# Verbose mode for debugging
appshot build --verbose --devices iphone

Exit Codes:

• 0 - Success
• 1 - Configuration error
• 2 - Missing screenshots
• 3 - Processing error

appshot caption

Add or edit captions with autocomplete and AI translation.

appshot caption --device <name> [options]

Options:

• --device <name> - Device name (required)
• --lang <code> - Primary language (default: en)
• --translate - Enable real-time AI translation
• --langs <codes> - Target languages for translation
• --model <name> - OpenAI model (default: gpt-4o-mini)

Examples:

# Basic caption entry
appshot caption --device iphone

# With translation
appshot caption --device iphone --translate --langs es,fr,de

# Custom model
appshot caption --device ipad --translate --langs ja --model gpt-5

appshot check

Validate project configuration and assets.

appshot check [options]

Options:

• --fix - Attempt automatic fixes

Checks:

• Configuration file validity
• Screenshot presence
• Frame availability
• Directory structure
• Caption files

appshot clean

Remove generated files and temporary data.

appshot clean [options]

Options:

• --all - Remove all generated files including .appshot/
• --history - Clear caption autocomplete history
• --keep-history - Preserve history when using --all
• --yes - Skip confirmation prompt

Examples:

# Clean output only
appshot clean

# Full reset
appshot clean --all --yes

# Clear history
appshot clean --history

appshot doctor

Run comprehensive system diagnostics to verify appshot installation and dependencies.

appshot doctor [options]

Options:

• --json - Output results as JSON for CI/automation
• --verbose - Show detailed diagnostic information
• --category <categories> - Run specific checks (comma-separated: system,dependencies,fonts,filesystem,frames)

Checks:

• System Requirements - Node.js version (≥18), npm availability, platform detection
• Dependencies - Sharp module installation, native bindings, image processing test, OpenAI API key
• Font System - Font detection commands, system font loading, common font availability
• File System - Write permissions (current/temp directories), .appshot directory, configuration validity
• Frame Assets - Frame directory presence, Frames.json validation, device frame counts, missing files

Examples:

# Run all diagnostics
appshot doctor

# Check specific categories
appshot doctor --category system,dependencies

# JSON output for CI
appshot doctor --json

# Verbose mode for debugging
appshot doctor --verbose

Output Example:

🏥 Appshot Doctor - System Diagnostics

System Requirements:
  ✓ Node.js v20.5.0 (minimum: v18.0.0)
  ✓ npm v9.8.0
  ✓ darwin (macOS)

Dependencies:
  ✓ Sharp v0.33.5 installed
  ✓ libvips v8.15.3 loaded
  ✓ Sharp image processing test passed
  ⚠ OpenAI API key not found (translation features disabled)

Summary: 20 passed, 1 warning, 0 errors

Suggestions:
  • Set OPENAI_API_KEY environment variable to enable translation features

appshot fonts

Browse, validate, and set fonts for captions. Includes 8 high-quality embedded fonts for consistent rendering across all platforms.

appshot fonts [options]

Options:

• --all - List all system fonts
• --embedded - Show embedded fonts bundled with appshot
• --recommended - Show recommended fonts only (default)
• --validate <name> - Check if font is available (embedded or system)
• --set <name> - Set the caption font
• --select - Interactive font selection
• --device <name> - Target specific device (with --set or --select)
• --json - Output as JSON

Embedded Fonts (Always Available):

• Modern UI: Inter, Poppins, Montserrat, DM Sans
• Popular Web: Roboto, Open Sans, Lato, Work Sans
• Monospace: JetBrains Mono, Fira Code
• Variants: Regular, Italic, Bold, and Bold Italic styles

All embedded fonts use open source licenses (OFL or Apache 2.0) and provide consistent rendering without requiring system installation. Font variants are automatically detected and properly rendered with correct styles.

Examples:

# Browse recommended fonts
appshot fonts

# Show embedded fonts
appshot fonts --embedded

# Set global font directly (embedded font)
appshot fonts --set "Inter"

# Set font variant (italic style)
appshot fonts --set "Poppins Italic"

# Set bold variant
appshot fonts --set "Montserrat Bold"

# Interactive font selection
appshot fonts --select

# Set device-specific font variant
appshot fonts --set "Poppins Bold Italic" --device iphone

# Validate font availability
appshot fonts --validate "Inter"  # Shows: embedded
appshot fonts --validate "Arial"  # Shows: system installed

# List all system fonts
appshot fonts --all

# JSON output for automation
appshot fonts --json > fonts.json

appshot frame

Apply device frames to screenshots with transparent backgrounds (no gradients or captions).

appshot frame <input> [options]

Arguments:

• <input> - Input image file or directory

Options:

• -o, --output <dir> - Output directory (default: same as input)
• -d, --device <type> - Force device type (iphone|ipad|mac|watch)
• -r, --recursive - Process directories recursively
• -f, --format <type> - Output format: png or jpeg (default: png)
• --suffix <text> - Filename suffix when not overwriting (default: "-framed")
• --overwrite - Overwrite original file name
• --dry-run - Preview files without processing
• --verbose - Show detailed information

Features:

• Auto-detects device type from image dimensions
• Preserves transparency with PNG output
• Batch processes entire directories
• Smart portrait/landscape frame selection
• Progress indicators for large batches

Examples:

# Frame single file (auto-detect device)
appshot frame screenshot.png

# Specify output directory
appshot frame screenshot.png -o framed/

# Force device type
appshot frame screenshot.png --device iphone

# Batch process directory
appshot frame ./screenshots -o ./framed --recursive

# Dry run with verbose logs
appshot frame ./screenshots --dry-run --verbose

# JPEG output (white background)
appshot frame screenshot.png --format jpeg

appshot device (macOS only)

Capture screenshots from iOS simulators.

appshot device <command> [options]

Commands:

• capture - Capture screenshot from device
• list - List available devices
• prepare - Boot simulators

Capture Options:

• -d, --device <name> - Device name or alias
• --all - Capture from all devices
• --simulators - Filter simulators
• --booted - Currently booted simulators
• --process - Auto-process with frames
• --app <bundleId> - Launch app before capture

Examples:

# List devices
appshot device list

# Interactive capture
appshot device capture

# Capture from specific device
appshot device capture --device "iPhone 15 Pro"

# Capture and process
appshot device capture --process

appshot watch (macOS only)

Monitor directories for new screenshots with automatic processing.

appshot watch <command> [options]

Commands:

• start - Start watching directories
• stop - Stop the watch service
• status - Check service status
• setup - Interactive configuration

Start Options:

• -d, --dirs <paths...> - Directories to watch
• --devices <names...> - Device names for processing
• --process - Auto-process with frames
• --frame-only - Frames only (no gradient/caption)
• --background - Run in background
• --verbose - Detailed output

Examples:

# Interactive setup
appshot watch setup

# Start in background with processing
appshot watch start --process --background

# Watch multiple directories
appshot watch start --dirs ./screenshots ./downloads

# Check status
appshot watch status --verbose

# Stop watching
appshot watch stop

appshot gradients

Manage gradient presets.

appshot gradients [options]
appshot gradients select

Options:

• --list - List all presets (default)
• --category <name> - Filter by category
• --preview <id> - Generate preview image
• --sample - Generate all samples with HTML
• --apply <id> - Apply preset to project

Examples:

# Browse all
appshot gradients

# Apply preset
appshot gradients --apply ocean

# Interactive selection
appshot gradients select

# Generate samples
appshot gradients --sample

appshot init

Initialize new project with scaffolding.

appshot init [options]

Options:

• --force - Overwrite existing files

Creates:

• .appshot/config.json
• .appshot/captions/
• screenshots/ directories
• Default configuration

appshot migrate

Migrate project structure to latest version.

appshot migrate [options]

Options:

• --output-structure - Migrate to language subdirectory structure
• --dry-run - Preview changes without making them
• --lang <code> - Language to use for migration (default: system language)

Examples:

# Migrate existing screenshots to language subdirectories
appshot migrate --output-structure

# Preview migration without changes
appshot migrate --output-structure --dry-run

# Specify target language
appshot migrate --output-structure --lang fr

appshot localize

Batch translate all captions using AI.

appshot localize --langs <codes> [options]

Options:

• --langs <codes> - Target languages (required)
• --device <name> - Specific device only
• --model <name> - OpenAI model (default: gpt-4o-mini)
• --source <lang> - Source language (default: en)
• --review - Review before saving
• --overwrite - Replace existing translations

Examples:

# Translate all
appshot localize --langs es,fr,de

# Device-specific
appshot localize --device iphone --langs ja,ko

# Premium model with review
appshot localize --langs zh-CN --model gpt-5 --review

appshot presets

Manage App Store screenshot presets.

appshot presets [options]

Options:

• --list - List all presets (default)
• --required - Show required only
• --generate <ids> - Generate config for presets
• --category <type> - Filter by device type
• --output <file> - Output file for config

Examples:

# View all
appshot presets

# Required only
appshot presets --required

# Generate config
appshot presets --generate iphone-6-9,ipad-13

appshot specs

Display complete Apple App Store screenshot specifications.

appshot specs [options]

Options:

• --device <name> - Filter by device type (iphone|ipad|mac|watch|appletv|visionpro)
• --json - Output as JSON (exact Apple specifications for diffing)
• --required - Show only required presets

Shows:

• Complete Apple specifications with exact resolutions
• Display sizes and device compatibility lists
• Required vs optional indicators
• Fallback notes and requirements

JSON Output for Change Tracking: The --json flag outputs the complete Apple App Store specifications data, perfect for tracking changes over time:

# Save current specifications
appshot specs --json > apple-specs-2024-08.json

# After Apple updates (typically September)
appshot specs --json > apple-specs-2024-09.json

# See what changed
diff apple-specs-2024-08.json apple-specs-2024-09.json

Data Source: The specifications mirror Apple's official screenshot requirements and are maintained in sync with Apple's updates. The JSON output preserves all metadata including:

• Exact resolutions (e.g., 1290x2796 for iPhone 6.9")
• Device groupings (which devices share requirements)
• Requirement status (mandatory vs optional)
• Fallback rules and special notes

This is particularly useful for:

• Tracking when Apple adds new device requirements
• Validating screenshot compliance before submission
• Automating screenshot generation pipelines
• Planning resource allocation for new devices

appshot style

Configure device styling interactively.

appshot style --device <name> [options]

Options:

• --device <name> - Device name (required)
• --reset - Reset to defaults

Configures:

• Font selection
• Frame settings
• Partial frames
• Frame positioning
• Frame scaling
• Caption settings

Examples:

# Configure iPhone
appshot style --device iphone

# Reset to defaults
appshot style --device iphone --reset

appshot validate

Validate screenshots against App Store requirements.

appshot validate [options]

Options:

• --strict - Validate required presets only
• --fix - Show fix suggestions

Validates:

• Resolution compliance
• Aspect ratios
• Required presets
• File formats

⚙️ Configuration Reference

Complete Schema

{
  "output": "./final",           // Output directory
  "frames": "./frames",          // Frame directory
  "defaultLanguage": "en",       // Default language for builds (optional)
  "gradient": {
    "colors": ["#hex1", "#hex2"],
    "direction": "top-bottom"    // or diagonal, left-right
  },
  "caption": {
    "font": "Font Name",
    "fontsize": 64,              // Pixels
    "color": "#FFFFFF",         // Text color (hex)
    "align": "center",           // left, center, right
    "position": "above",         // above, below, overlay
    "paddingTop": 100,
    "paddingBottom": 60,
    "background": {              // Optional background styling
      "color": "#000000",        // Background color (hex)
      "opacity": 0.8,            // Transparency (0-1)
      "padding": 20              // Padding around text
    },
    "border": {                  // Optional border styling
      "color": "#FFFFFF",        // Border color (hex)
      "width": 2,                // Border thickness (1-10)
      "radius": 12               // Rounded corners (0-30)
    },
    "box": {
      "autoSize": true,          // Dynamic height
      "maxLines": 3,
      "lineHeight": 1.4,
      "minHeight": 100,
      "maxHeight": 500
    }
  },
  "devices": {
    "iphone": {
      "input": "./screenshots/iphone",
      "resolution": "1290x2796",
      "autoFrame": true,
      "preferredFrame": "frame-name",
      "partialFrame": false,
      "frameOffset": 25,         // Percentage
      "framePosition": "center", // or top, bottom, 0-100
      "frameScale": 0.9,         // 0.5-2.0
      "captionFont": "Override",
      "captionSize": 72,
      "captionPosition": "above",
      "captionBox": {
        "autoSize": false,
        "minHeight": 320,
        "maxHeight": 320
      }
    }
  }
}

Device Configuration

Each device can override global settings:

{
  "devices": {
    "iphone": {
      // Required
      "input": "./screenshots/iphone",
      "resolution": "1290x2796",
      
      // Frame options
      "autoFrame": true,
      "preferredFrame": "iphone-16-pro-max-portrait",
      "partialFrame": true,
      "frameOffset": 25,
      "framePosition": 40,
      "frameScale": 0.85,
      
      // Caption overrides
      "captionFont": "SF Pro",
      "captionSize": 64,
      "captionPosition": "above",
      "captionBackground": {     // Device-specific background
        "color": "#FF5733",
        "opacity": 0.7,
        "padding": 25
      },
      "captionBorder": {         // Device-specific border
        "color": "#FFFFFF",
        "width": 3,
        "radius": 16
      },
      "captionBox": {
        "autoSize": false,
        "minHeight": 320,
        "maxHeight": 320,
        "maxLines": 3
      }
    }
  }
}

Fixed Layout Configuration

For consistent screenshots regardless of caption length:

{
  "devices": {
    "iphone": {
      "autoFrame": false,
      "preferredFrame": "iphone-16-pro-max-portrait",
      "frameScale": 0.85,
      "framePosition": 40,
      "captionBox": {
        "autoSize": false,    // Critical
        "minHeight": 320,     // Fixed height
        "maxHeight": 320      // Same as min
      }
    }
  }
}

🤖 Agent & Automation Guide

Design Principles

Appshot is built for automation:

1. Predictable - Consistent commands and outputs
2. Scriptable - JSON configs, exit codes, no GUI
3. Composable - Unix philosophy, pipe-friendly