Getting Started

Installing Locally

You can install Locally using either a package manager (HomeBrew / Scoop) or by downloading it and installing it on your systems PATH. We'd recommend using a package manager to do this, because it makes it easy to keep it up-to-date, but you can find the download links below if you'd prefer that.

Configuring Locally

With Locally installed, now we need to configure Locally for use, which we can do by running:

$ locally setup

This is a one-time configuration that configures your machine for use with Locally, which involves:

• Configures the TLS certificates needed to run Locally on your local machine, and then ensures your machine trusts that certificate.
• Installs Plugins for each of the Locally emulated Azure Services that you want to use.
• (Optional) Signs you into your Locally Account so that you can take full advantage of Locally. You can use Locally without signing in, but when you do you can only use a limited number of Plugins and sessions are limited to 60 minutes at a time.
• Configures DNS and Docker/Podman (depending on which you have installed) on your local machine, so that you can use Locally's built-in DNS server from anywhere on your local machine.

Should you need to change any of these settings in the future, you can re-run locally setup at any time.

---

Note: in order to use Locally's DNS and ensure the certificate is trusted by your applications, you may need to restart those applications (or reboot your machine) for this to be picked up.

Launching Locally

With Locally configured, we can now launch the Locally environment by running:

$ locally build

Leave locally build running, and use a second terminal for the next step.

---

Locally will automatically open the Locally Dashboard in your default browser. If you'd rather it didn't, you can launch Locally via:

$ locally build --skip-browser

---

Locally also validates at launch that its configuration is correct on your machine, should you encounter any issues you can run the following command in order to determine the issue:

$ locally validate

Provisioning your first Resource

Now that Locally is running, next we'll create a Resource Group using the Azure CLI.

Locally supports the Automatic Configuration of common tooling, like the Azure CLI, HashiCorp Terraform and more, by prefixing commands with locally run.

For example, where you would normally run:

$ az group create -n hello-world -l westus

To run the same command against Locally we'd prefix it with locally run, for example:

$ locally run az group create -n hello-world -l berlin

Where to next

Next up we'd recommend following the Tutorial, which takes you from a Resource Group to a Storage Account you write a blob to and read it back from - the same az commands you'd run against Azure, entirely on your machine.

You may also want to learn more about Automatic Configuration - what the locally run prefix does to point a tool at Locally rather than Azure, and the credentials and subscription variables it sets for you.