CI Automation API

Preview

Sign in during Public Preview to get the Team plan free, plus an early-adopter discount when we launch. Sign in

CI Automation API

When Using Locally in CI, you can stop it from the command line:

$ locally ci --stop

For more control, Locally also exposes an Automation API at https://127.0.0.1:5674 for programmatic use. No authentication is required.

Endpoint Description
GET/_locally/ci/endpoints Returns the ports and URLs Locally is running on.
GET/_locally/ci/terminate Terminates the running Locally instance and releases the CI lease.

GET /_locally/ci/endpoints

Returns the ports and URLs that Locally is running on, so your CI scripts can discover service addresses programmatically rather than hard-coding them.

Example

$ curl -sk https://127.0.0.1:5674/_locally/ci/endpoints

Response

{
  "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"
}

GET /_locally/ci/terminate

Shuts down the running Locally instance and releases the CI lease. Useful for cleanup steps in automation pipelines.

Returns 202 Accepted with an empty body. Locally releases the lease and then exits.

Example

$ curl -sk https://127.0.0.1:5674/_locally/ci/terminate

Next steps

To start Locally in a pipeline, see the GitHub Actions guide or Other CI Tools. Using Locally in CI covers session limits and the exit codes Locally returns.

Preview

Sign in during Public Preview to get the Team plan free, plus an early-adopter discount when we launch. Sign in

A local cloud for you and your agents.

Your Azure infrastructure, running on your machine. Deploy in seconds, break things freely, and ship to Azure when you're ready.