Skip to main content

Quick Start

Get Testream up and running in minutes. These steps work for every supported framework.

1. Create an account and get your API key​

  1. Sign up at testream.app
  2. Go to Dashboard → Projects Example Jira Navigation Bar
  3. Click + New Project and copy the API key! Please keep this key secret as it will not be shown again. You can always generate a new key if needed.

2. Install a reporter​

Pick the reporter for your testing framework and follow its setup guide.

→ View all reporters

3. Set your API key​

Set the your Testream API key in the secret management system of your choice. In this example, we'll use GitHub Actions secrets since it's the most common CI environment, but you can set this in any CI or locally as an environment variable.

Locally — add to a .env file in your project root (don't commit this):

TESTREAM_API_KEY=your_api_key_here

In CI (GitHub Actions) — add TESTREAM_API_KEY as a repository secret (Settings → Secrets → Actions → New repository secret), then reference it in your workflow:

env:
  TESTREAM_API_KEY: ${{ secrets.TESTREAM_API_KEY }}

4. Run your tests​

Run your tests as normal. The reporter automatically uploads results to Testream when TESTREAM_API_KEY is present.

5. View your results​

Open your Jira instance where Testream is installed and navigate to your project, and check Test Runs to see the uploaded results.

What's Next?​