ShotPlan (WIP)

A command line tool that calls your Xcode Test Plan and creates screenshots of your app automatically.

ShotPlan will also take care of the status bar in your screenshots.

Installation

Mint

mint install Cosmo/ShotPlan@main

Configuration

Change to your Xcode project directory and run the shotplan init command to create a new configuration file. Don't forget to replace the placeholders YOUR_SCHEME and YOUR_TESTPLAN.

shotplan init -s YOUR_SCHEME -t YOUR_TESTPLAN

This will create a file called ShotPlan.json that looks like this:

{
  "scheme" : "YOUR_SCHEME",
  "devices" : [
    {
      "homeStyle" : "indicator",
      "displaySize" : "6.5",
      "simulatorName" : "iPhone 11 Pro Max"
    },
    {
      "homeStyle" : "button",
      "displaySize" : "5.5",
      "simulatorName" : "iPhone 8 Plus"
    },
    {
      "homeStyle" : "indicator",
      "displaySize" : "12.9",
      "simulatorName" : "iPad Pro (12.9-inch) (5th generation)"
    }
  ],
  "testPlan" : "YOUR_TESTPLAN"
}

Usage

Run the following command:

shotplan run

ShotPlan will create a Screenshots directory in your project with all the screenshots of the devices in your configuration and the screens in your Test Plan.