Skip to main content

Quick Start


Install the Mesmer CLI by running the right install snippet for your platform:


The installer will download the mesmer (or mesmer.exe) binary into your user directory, and add it to your $PATH.

Getting Started#

The setup process for the CLI is a little different depending if you're just using the Mesmer Sidecar, or want to integrate with a hosted Mesmer platform tenant:

Mesmer Sidecar (beta)#

To use the Sidecar, you'll need a few requirements installed on your system. Then, you're off to the races---check out the Sidecar guide or command reference to get started.

Mesmer Platform#

To get started using the CLI, first, sign in to your Mesmer tenant with an email and password:

# If the URL of your web console looks like :$ mesmer auth login
โ”€โ”€โ”€ Sign In    Email:    Password [hidden]: [hidden]
 โœ“  Authenticated as William Goodall

Once you've created a project and uploaded your first build through the web UI, you can tie your working directory to a Mesmer project with mesmer init:

# Show a project picker, and create a `.mesmer.yml` file in the# current directory with the project and tenant you choose.$ mesmer initSelect a project: Calculator โœ“  Created `.mesmer.yml` in "/your/working/directory"

This will create a file, .mesmer.yml, in the current directory. Any time you run mesmer from inside this directory, it'll pick up the right tenant and project ID. It's intended that you check this file in to Git, and version it alongside your app's code.

Check everything works, with mesmer project describe:

$ mesmer project describeName ..... CalculatorType ..... AndroidPackage ..
 Project ID  5ee00107f73ce45ba4d041e8

Then, you're pretty much off to the races. Check out the guides section for some useful recipes, and the command reference for detailed documentation on each subcommand.