Azure Static Web Apps CLI
The Static Web Apps CLI, also known as SWA CLI, serves as a local development tool for Azure Static Web Apps. It can:
- Serve static app assets, or proxy to your app dev server
- Serve API requests, or proxy to APIs running in Azure Functions Core Tools
- Emulate authentication and authorization
- Emulate Static Web Apps configuration, including routing and ACL roles
- Deploy your app to Azure Static Web Apps
If you have suggestions or you encounter issues, please report them or help us fix them. Your contributions are very much appreciated.
The CLI emulates commonly used capabilities of the Azure Static Web Apps cloud service. Some differences are expected. Always deploy and test your apps in Azure to confirm behavior.
Installing the CLI with
To install the CLI globally, use:
npm install -g @azure/static-web-apps-cli
You can also install the SWA CLI inside a project (instead of globally) as a development dependency using
npm install -D @azure/static-web-apps-cli. This is highly recommended.
Open a SWA app folder at the root (outside any /api or /app folders):
The best way to get started is to run the
swacommand alone and follow the interactive prompts:
It will generate a configuration for you, then build your project and ask if you want to deploy it to Azure.
See swa for more details.
Here are the currently supported
swa commands. Use
swa <command> --help to learn about options and usage for that particular command.
login: login into Azure
init: initialize a new static web app project
start: start the emulator from a directory or bind to a dev server
deploy: deploy the current project to Azure Static Web Apps
build: build your project
- Open a SWA app folder at the root (outside any /api or /app folders):
- Create a configuration for your project:
npx @azure/static-web-apps-cli init
- Start the emulator:
npx @azure/static-web-apps-cli start
- Access your SWA app from
See all available commands and options.