Preview
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in
CLI Reference
Every command the locally CLI ships, with a page for each. These pages are generated from the CLI's own help output, so they match what locally <command> --help prints. Flags that apply to locally run itself must come before the command being run.
Commands
| Command | Does |
|---|---|
| locally account | Show the signed-in account. |
| locally analytics | Show the analytics this installation has collected. |
| locally apim | Inspect and call API Management APIs. |
| locally audit | View audit events. |
| locally build | Launch the Locally environment on this machine. |
| locally certificate | Manage the TLS certificate Locally uses. |
| locally chaos | Simulate transient failures in Locally. |
| locally ci | Launch the Locally environment in CI mode. |
| locally completion | Generate the autocompletion script for the specified shell |
| locally configure | Configure this machine for Locally, one change at a time. |
| locally connect | Connect to a Virtual Machine or a Virtual Machine Scale Set instance. |
| locally dashboard | Open the Locally Dashboard in your browser. |
| locally deploy | Deploy an ARM or Bicep template to Locally. |
| locally docs | Open the Locally documentation in your browser. |
| locally eventhub | Interact with Event Hubs Namespaces within Locally. |
| locally function | Interact with Function Apps within Locally. |
| locally iothub | Interact with IoT Hubs within Locally. |
| locally licence | Show or change the third-party licences you've accepted for Locally to use. |
| locally login | Sign this installation in to a Locally Account. |
| locally logout | Sign out and deregister this installation. |
| locally logs | View HTTP request/response logs. |
| locally mcp | Launch the Locally MCP server. |
| locally mysql | Interact with MySQL Flexible Servers within Locally. |
| locally permissions | Print the Minimum Necessary Permissions role definition. |
| locally plugin | Manage Resource Provider plugins. |
| locally postgres | Interact with PostgreSQL Flexible Servers within Locally. |
| locally redis | Interact with Redis Caches and Managed Redis clusters within Locally. |
| locally refresh | Refresh this installation's Locally licence. |
| locally refresh-reference-data | Refresh Locally's reference-data override files from real Azure via the Azure CLI. |
| locally regions | List Azure regions known to Locally. |
| locally run | Run a tool against Locally using Automatic Configuration (az, terraform, pulumi, curl, ...). |
| locally runbooks | Manage Locally Runbooks. |
| locally servicebus | Interact with Service Bus Namespaces within Locally. |
| locally setup | Set up this machine to run Locally. |
| locally snapshot | Locally Snapshots: capture all of your resources and data in Locally, and restore them later. |
| locally storage | Interact with Storage Accounts within Locally. |
| locally subscriptions | Manage Locally subscriptions. |
| locally update | Update this copy of Locally to the latest version. |
| locally validate | Check that Locally is fully configured and ready to run. |
| locally version | Print the version of Locally in this binary. |
Preview
During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in