CLI Reference

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 accountShow the signed-in account.
locally analyticsShow the analytics this installation has collected.
locally apimInspect and call API Management APIs.
locally auditView audit events.
locally buildLaunch the Locally environment on this machine.
locally certificateManage the TLS certificate Locally uses.
locally chaosSimulate transient failures in Locally.
locally ciLaunch the Locally environment in CI mode.
locally completionGenerate the autocompletion script for the specified shell
locally configureConfigure this machine for Locally, one change at a time.
locally connectConnect to a Virtual Machine or a Virtual Machine Scale Set instance.
locally dashboardOpen the Locally Dashboard in your browser.
locally deployDeploy an ARM or Bicep template to Locally.
locally docsOpen the Locally documentation in your browser.
locally eventhubInteract with Event Hubs Namespaces within Locally.
locally functionInteract with Function Apps within Locally.
locally iothubInteract with IoT Hubs within Locally.
locally licenceShow or change the third-party licences you've accepted for Locally to use.
locally loginSign this installation in to a Locally Account.
locally logoutSign out and deregister this installation.
locally logsView HTTP request/response logs.
locally mcpLaunch the Locally MCP server.
locally mysqlInteract with MySQL Flexible Servers within Locally.
locally permissionsPrint the Minimum Necessary Permissions role definition.
locally pluginManage Resource Provider plugins.
locally postgresInteract with PostgreSQL Flexible Servers within Locally.
locally redisInteract with Redis Caches and Managed Redis clusters within Locally.
locally refreshRefresh this installation's Locally licence.
locally refresh-reference-dataRefresh Locally's reference-data override files from real Azure via the Azure CLI.
locally regionsList Azure regions known to Locally.
locally runRun a tool against Locally using Automatic Configuration (az, terraform, pulumi, curl, ...).
locally runbooksManage Locally Runbooks.
locally servicebusInteract with Service Bus Namespaces within Locally.
locally setupSet up this machine to run Locally.
locally snapshotLocally Snapshots: capture all of your resources and data in Locally, and restore them later.
locally storageInteract with Storage Accounts within Locally.
locally subscriptionsManage Locally subscriptions.
locally updateUpdate this copy of Locally to the latest version.
locally validateCheck that Locally is fully configured and ready to run.
locally versionPrint 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

A local cloud for you and your AI agents.

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