Sherlo CLI

Command-line interface for Sherlo - Visual Testing for React Native Storybook.

📚 For full documentation, visit sherlo.io/docs

Commands

init

Initialize Sherlo in your project.

npx sherlo init [--token <token>]

Options:

• --token <token> - Authentication token for the project

test

Run visual tests interactively.

npx sherlo test [options]

Options:

• --android <path> - Path to Android build (.apk)
• --ios <path> - Path to iOS build (.app, .tar.gz, .tar)
• --token <token> - Authentication token for the project
• --message <message> - Custom message to label the test
• --include <stories> - List of story names to include (e.g. "My Story","Another Story")
• --config <path> - Path to the config file (default: sherlo.config.json)
• --project-root <path> - Path to the root directory of your project (default: .)

test:standard

Test standard builds.

npx sherlo test:standard [options]

Options:

• --android <path> - Path to Android build (.apk)
• --ios <path> - Path to iOS build (.app, .tar.gz, .tar)
• --token <token> - Authentication token for the project
• --message <message> - Custom message to label the test
• --include <stories> - List of story names to include (e.g. "My Story","Another Story")
• --config <path> - Path to the config file (default: sherlo.config.json)
• --project-root <path> - Path to the root directory of your project (default: .)

test:eas-update

Test builds with dynamic JavaScript (OTA) updates.

npx sherlo test:eas-update [options]

Options:

• --branch <branch> - Name of the EAS Update branch to fetch the latest update from
• --android <path> - Path to Android build (.apk)
• --ios <path> - Path to iOS build (.app, .tar.gz, .tar)
• --token <token> - Authentication token for the project
• --message <message> - Custom message to label the test
• --include <stories> - List of story names to include (e.g. "My Story","Another Story")
• --config <path> - Path to the config file (default: sherlo.config.json)
• --project-root <path> - Path to the root directory of your project (default: .)

test:eas-cloud-build

Test cloud builds created on Expo servers.

npx sherlo test:eas-cloud-build [options]

Options:

• --easBuildScriptName <name> - Name of the package.json script that triggers EAS Build
• --waitForEasBuild - Start waiting for EAS Build to be triggered manually
• --token <token> - Authentication token for the project
• --message <message> - Custom message to label the test
• --include <stories> - List of story names to include (e.g. "My Story","Another Story")
• --config <path> - Path to the config file (default: sherlo.config.json)
• --project-root <path> - Path to the root directory of your project (default: .)

eas-build-on-complete

Process EAS Build (required for test:eas-cloud-build).

npx sherlo eas-build-on-complete [--profile <profile>]

Options:

• --profile <profile> - EAS Build profile (must match profile used in test:eas-cloud-build)