Overview

The Launchable CLI enables integration between your CI pipeline and Launchable. To get started,

1. install the CLI as part of your CI script,

2. set your Launchable API key, and

3. verify connectivity

Then follow the instructions for your test runner or build tool to send data to Launchable.

Installing the CLI

The Launchable CLI is a Python3 package that you can install from PyPI.

You can install the CLI in your CI pipeline by adding this to the part of your CI script where you install dependencies:

pip3 install --user --upgrade launchable~=1.0

Setting your API key

First, create an API key at app.launchableinc.com. This authentication token allows the CLI to talk to Launchable.

Then, make this API key available as the LAUNCHABLE_TOKEN environment variable in your CI process. How you do this depends on your CI system:

Verifying connectivity

After setting your API key, you can add launchable verify || true to your script to verify connectivity. If successful, you should receive an output such as:

$ launchable verify || true
​
Organization: <organization name>
Workspace: <workspace name>
Platform: macOS-11.4-x86_64-i386-64bit
Python version: 3.9.5
Java command: java
launchable version: 1.22.3
Your CLI configuration is successfully verified 🎉

If you get an error, see Troubleshooting.

Next steps

Now that you've added the CLI to your pipeline, you can start sending data to Launchable to analyze and optimize your test runs.