Skip to content

Quickstart

Get your CI test results into Automated Future in under 5 minutes.

1. Get your API key

Sign in to the Automated Future dashboard and go to Team > API Keys. Click Create API Key and copy it.

2. Install the CLI

curl -fsSL https://cli.automatedfuture.co/cli/install.sh | sh

3. Configure

Set your API key and project ID, then load them into the CLI:

export AF_API_KEY=your-key
export AF_PROJECT_ID=proj_abc123
af config from-env

In CI, store these as secrets/variables rather than hardcoding them.

4. Run your tests

af run -- pytest --junitxml=results.xml

af run creates a test run, executes your command, finds JUnit XML output, uploads every test result, and ends the run. Your test framework just needs to produce JUnit XML.

5. See your results

Open the dashboard. Your test run will appear within seconds of completing.

Next steps

  • CI Integration — Copy-paste examples for GitHub Actions, GitLab CI, and Jenkins
  • CLI Reference — Full list of commands, options, and environment variables