Command examples
Usage and examples for each snapbot command.
Explore the Command Map or find a command below. Examples use placeholder IDs and paths. Review request files and dry-run output before running commands that change local or provider state.
snapbot help
Print usage and supported capture flags.
snapbot helpExample:
pnpm exec tsx src/main.ts --helpRun from the installed Snapbot source checkout. --help is an alias for help.
snapbot capture
Build an Expo iOS app and save simulator screenshots.
snapbot capture --config <snapbot.json> --output <folder> [--project-root <path>] [--exec <executable>] [--dotenv <path>]Example:
pnpm capture --project-root /absolute/path/to/app --config snapbot.json --output snapbot-output/new-runFile: snapbot.json
{
"name": "example-app",
"appDirectory": ".",
"bundleIdentifier": "com.example.app",
"scheme": "example",
"xcodeScheme": "ExampleApp",
"iosProduct": "ExampleApp.app",
"apiEnvironment": "development",
"appearance": "light",
"simulator": {
"name": "Snapbot Example",
"deviceType": "iPhone 17 Pro",
"runtime": "iOS 26.5"
},
"metro": {
"port": 8090
},
"defaults": {
"minimumWaitMs": 750,
"sampleIntervalMs": 250,
"stableSamples": 3,
"timeoutMs": 15000
},
"screenshots": [
{
"name": "home",
"deeplink": "example://home"
}
]
}Save snapbot.json in your app root. Replace the app identifiers, route, and simulator values with your app and an installed runtime. Run the command from the Snapbot checkout. Capture builds the app and operates a simulator; there is no dry run. Choose a new or empty output directory.