CLI

The CLI extends the TypeScript SDK by providing a local, easy-to-use UI that streamlines the creation and maintenance of GPT Driver powered mobile tests. Designed to work directly with local iOS and Android emulators, it helps engineers move faster from manual interaction to reliable automation.

Key benefits:

  • Visual test creation and refinement Use the UI to define test steps and run individual steps in isolation, making it easy to fine-tune parameters and validate behavior before committing them to a full flow.

  • Interaction recording for iOS and Android Record real interactions with your app directly from a connected device, removing the need to manually author test steps from scratch.

  • Automatic natural-language generation Recorded interactions are translated into natural-language steps, reducing the effort for the test author and ensuring best practice prompting.

  • Seamless integration with Appium via the SDK Recorded flows are saved locally as JSON files and can be executed in an existing Appium test suite using the SDK’s executeFlow method. This allows complete flows to live in dedicated files (which makes the maintenance via the CLI easier), while still supporting modular test design by referencing and reusing flows across tests.

Installing the CLI

The MobileBoost CLI is distributed via npm and can be installed as a project dependency or globally, depending on your workflow.

npm install mobileboost-cli

Once installed, the mobileboost command becomes available in your project.

CLI Commands

mobileboost init

Initializes MobileBoost in your project by creating a configuration file in the current directory. This file is used by the CLI to determine how test flows are stored and executed.

mobileboost init

Run this command once per project before recording or executing test flows.

mobileboost studio

Launches the local UI for recording, editing, and maintaining test flows. The studio connects to locally running iOS or Android (simulators / emulators / physical devices), allowing you to visually create and refine tests.

From the studio, you can:

  • Record interactions with your app

  • Edit and replay individual tests / steps

  • Generate natural-language test steps

  • Save flows locally as JSON files for execution via the SDK or the CLI

mobileboost run

Runs mobile tests in the current project using the MobileBoost CLI. Tests can be executed either locally or on the managed MobileBoost infrastructure, depending on the selected options.

Arguments

  • [tests...] (optional) Specifies which tests to run. If no tests are provided, the CLI will execute all tests in the current project.

    You can pass:

    • One or more individual test names

    • Paths to specific test files

    • Folder paths containing multiple tests

    • Substrings to match test names

  • env

    • local Runs tests against locally available emulators or simulators. This mode is ideal for development, debugging, and rapid iteration.

    • cloud Runs tests on MobileBoost’s managed infrastructure. This mode is suited for larger test suites, parallel execution, and CI environments, without requiring local emulator setup.

PreviousReferenceNextFAQ

Last updated