Reference

Preview

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

The reference section covers the bits of Locally you'll dip into rather than read cover-to-cover - installing and setting Locally up, component names, ports, supported regions, troubleshooting steps and frequently asked questions.

CLI Reference

Every locally command with its synopsis, usage and flags, generated from the CLI's own help output.

Components

The services that make up Locally - the Control Plane, the Locally Dashboard, Authorization, the Directory (Entra) Emulator and the Data Plane Emulators.

Feature Flags

The feature flags you can turn on and off in Locally, what each one does and which plan it needs.

Frequently Asked Questions

Common questions about Locally - why it's a custom environment and offline use.

Glossary

The Locally-specific terms the documentation uses, from Automatic Configuration to Seeded and Session.

Locally Setup

What locally setup does - local CA, DNS resolution, plugin install and Docker validation, with safe re-runs.

Locations & Regions

The Azure locations and regions you can provision resources into when using Locally.

Networking & Proxies

Every port Locally listens on and which interface it binds, how containers reach Locally, and what to do about HTTP proxies, VPNs and corporate DNS.

Reference Data

Override or extend the VM images, VM SKUs, extension types and app stacks Locally knows about, pulling them from Azure with locally refresh-reference-data.

Requirements

What a machine needs to run Locally - supported operating systems and architectures, permissions, ports, outbound endpoints and container runtimes.

Security & Telemetry

What Locally listens on and for whom, what leaves your machine, every field in the opt-in crash reports and analytics, retention, and how to turn each off.

Troubleshooting

Diagnose and fix common issues when running Locally - locally validate, macOS notarisation and more.

Updating & Uninstalling

How to update the Locally CLI and its plugins, and how to remove Locally completely - the binary, config, resolver rule and trusted root certificate.

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.