MobileBoost CLI

MobileBoost is a CLI tool designed for agentic mobile testing. It helps setup the environment, manages configuration, and provides a "Studio" dashboard for visualising and interacting with your tests.

Project Structure

The project is a hybrid TypeScript CLI and Web Application.

mobileboost-cli/
├── bin/              # Executable entry point
├── src/
│   ├── cli.ts        # Main CLI entry point (Commander.js)
│   ├── commands/     # Command implementations
│   │   ├── init.ts   # 'init' command
│   │   ├── doctor.ts # 'check-env' command
│   │   └── studio.ts # 'studio' command (Express + tRPC)
│   ├── server/       # tRPC Backend logic
│   │   └── router.ts # AppRouter definition
│   └── client/       # Studio Frontend (React + Vite)
│       ├── main.tsx  # React entry
│       ├── App.tsx   # Root component
│       └── ...
├── dist/             # Compiled output (both CommonJS CLI and Client Assets)
└── ...

Main Components

1. CLI Core: Built with Commander.js. Handles command routing and argument parsing.
2. Studio Frontend: A web dashboard built with React, Vite, and tRPC. It communicates with the CLI backend to file system operations.
3. Studio Backend: An Express server that runs locally when mobileboost studio is executed. It serves the built React assets and exposes a tRPC API.

Developer Guide

Follow these steps to run the project locally for development and testing.

1. Installation

Clone the repository and install dependencies. This installs both CLI and Frontend dependencies.

npm install

2. Build

The build command compiles the React Frontend (using Vite) and the TypeScript CLI code.

npm run build

Note: You must rebuild if you make changes to either the src/client or src code.

3. Link Locally

To test the CLI commands on your machine, link the package globally.

npm link

4. Running the Configured CLI

Now you can use the mobileboost command system-wide.

Initialize a test project (in any directory):

mkdir my-mobile-project
cd my-mobile-project
mobileboost init

Run the Studio:

mobileboost studio

This will start the server at http://localhost:8877.

5. Development Workflow

For rapid development, you can use the dev script, but note that for the Studio, you generally need to re-run npm run build to see frontend changes reflected in the CLI command, as the CLI serves the static dist/client folder.

To create valid test data for the studio, you can manually add .ts files to the tests/ directory created by mobileboost init.