Using Locally with Other CI Tools

Environment Variables

The following Environment Variables are used to configure CI mode:

• LOCALLY_TEAM_UUID - The UUID of your Locally team, if your OIDC trust belongs to a Team.
• LOCALLY_USER_UUID - The UUID of your Locally user, if your OIDC trust belongs to your User. Set either this or LOCALLY_TEAM_UUID, not both.
• LOCALLY_TLS_CA_FILE_PATH - Specifies the path to the local Certificate Authority.
• LOCALLY_TLS_CERT_FILE_PATH - Specifies the path to the TLS Certificate.
• LOCALLY_TLS_KEY_FILE_PATH - Specifies the path to the Private Key.
• LOCALLY_WORKING_DIRECTORY - Specifies a working directory that Locally can write temporary files to. If you're not sure, you should be able to use $TMPDIR on macOS/Linux and %TEMP% on Windows.
• LOCALLY_OIDC_TOKEN (optional) - An OIDC token for authentication with a custom provider.
• LOCALLY_OIDC_TOKEN_FILE (optional) - Path to a file containing an OIDC token.

The TLS material must be valid for the full set of domains Locally serves locally - you can get an up-to-date list by running locally certificate get-required-domains.

Launching CI Mode

Once you've configured your OIDC trust and set the required environment variables, launch CI mode by running:

Once Locally has been launched in CI mode, it will output a JSON payload with the endpoints:

{
  "endpoints": {
    "atlas": "https://127.0.0.1:5679",
    "author": "https://127.0.0.1:5677",
    "controlPlane": "https://127.0.0.1:5680",
    "termination": "https://127.0.0.1:5674/_locally/ci/terminate"
  },
  "information": {
    "launch-time": "2025-04-06T12:14:07Z",
    "product": "locally",
    "version": "0.0.1"
  }
}

Using Locally Run in CI Mode

Once CI mode is running, use locally run to execute commands through the Locally environment:

Stopping CI Mode

When your pipeline is complete, stop CI mode to release resources:

See Using Locally in CI for session limits, exit codes and the ports/endpoints Locally needs access to.

Next steps

The Automation API lets your pipeline look up Locally's endpoints and stop it over HTTP. If your OIDC Trust belongs to a Team, Locally uses the same Locally Runbooks as the rest of your team.

Should you encounter any issues, please take a look at the troubleshooting section.