Getting started

Overview

Before getting started, sign your team up for Launchable: Sign up →

(Launchable is free for small teams and open source projects. Otherwise, we offer a free 60-day trial)

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.

Note that the CLI requires both Python 3.5+ and Java 8+.

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:

CI system

Docs

Azure DevOps Pipelines

Set secret variables

Bitbucket Pipelines

Variables and secrets

CircleCI

Using Environment Variables

GitHub Actions

How to configure a secret

GitLab CI

GitLab CI/CD environment variables

GoCD

Setting variables on an environment

Jenkins

Injecting secrets into builds

(Create a global "secret text" to use in your job)

Travis CI

Environment Variables

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.

We recommend including || true so that the exit status from the command is always 0.

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.