\n\nThe Static Web Apps CLI, also known as SWA CLI, serves as a local development tool for [Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps). It can:\n\n- Serve static app assets, or proxy to your app dev server\n- Serve API requests, or proxy to APIs running in Azure Functions Core Tools\n- Emulate authentication and authorization\n- Emulate Static Web Apps configuration, including routing and ACL roles\n- Deploy your app to Azure Static Web Apps\n\n## Important Notes\n\nIf you have suggestions or you encounter issues, please report them or help us fix them. Your contributions are very much appreciated. 🙏\n\nThe 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.**\n\n## Quickstart\n\n### Installing the CLI with `npm`, `yarn` or `pnpm`:\n\n- To install the CLI globally, use:\n\n ```bash\n npm install -g @azure/static-web-apps-cli\n ```\n\n > 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.\n\n### Basic usage\n\n- Open a SWA app folder at the root (outside any /api or /app folders):\n\n ```bash\n cd my-awesome-swa-app\n ```\n\n- The best way to get started is to run the `swa` command alone and follow the interactive prompts:\n ```bash\n swa\n ```\n\nIt will generate a configuration for you, then build your project and ask if you want to deploy it to Azure.\n\nSee [swa](https://azure.github.io/static-web-apps-cli/) for more details.\n\n### Extended usage\n\nHere are the currently supported `swa` commands. Use `swa --help` to learn about options and usage for that particular command.\n\n- [`login`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-login): login into Azure\n- [`init`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-init): initialize a new static web app project\n- [`start`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start): start the emulator from a directory or bind to a dev server\n- [`deploy`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy): deploy the current project to Azure Static Web Apps\n- [`build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build): build your project\n\n### Using `npx`:\n\n- Open a SWA app folder at the root (outside any /api or /app folders):\n\n```bash\ncd my-awesome-swa-app\n```\n\n- Create a configuration for your project:\n\n```bash\nnpx @azure/static-web-apps-cli init\n```\n\n- Start the emulator:\n\n```bash\nnpx @azure/static-web-apps-cli start\n```\n\n- Access your SWA app from `http://localhost:4280`\n\nSee all available [commands and options](https://azure.github.io/static-web-apps-cli/).\n\n## Want to help?\n\nWant to file a bug, contribute some code, or improve the documentation? Excellent! Read up on our guidelines for [contributing](https://github.com/azure/static-web-apps-cli/blob/master/CONTRIBUTING.md) and then check out one of our issues in the list: [community-help](https://github.com/azure/static-web-apps-cli/issues).\n","readmeFilename":"readme.md"}
![\"NPM](\"https://img.shields.io/npm/v/@azure/static-web-apps-cli.svg\")
\n \n ![\"Node](\"https://img.shields.io/node/v/@azure/static-web-apps-cli.svg\")
\n \n ![\"CI](\"https://github.com/azure/static-web-apps-cli/workflows/CI/badge.svg\"){kind=icon}
\n \n \n ![\"Contributions](\"https://img.shields.io/badge/contributions-welcome-brightgreen.svg\"){kind=icon}
\n \n ![\"logo\"](\"docs/swa-cli-logo.svg\"){kind=logo}
\n