{"id":13668179,"url":"https://azure.github.io/static-web-apps-cli/","last_synced_at":"2025-04-26T22:30:34.088Z","repository":{"id":37769922,"uuid":"275245011","full_name":"Azure/static-web-apps-cli","owner":"Azure","description":"Azure Static Web Apps CLI ✨","archived":false,"fork":false,"pushed_at":"2025-04-11T15:09:02.000Z","size":16314,"stargazers_count":622,"open_issues_count":126,"forks_count":129,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-04-15T00:49:59.490Z","etag":null,"topics":["authentication","azure","azure-functions","cli","serverless","static","swa","swa-emulator","web","webapp"],"latest_commit_sha":null,"homepage":"https://aka.ms/swa/cli-local-development","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Azure.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-06-26T20:48:08.000Z","updated_at":"2025-04-14T00:40:48.000Z","dependencies_parsed_at":"2023-09-22T22:06:49.087Z","dependency_job_id":"6f8c9e35-056b-42a9-a089-01310afe0801","html_url":"https://github.com/Azure/static-web-apps-cli","commit_stats":{"total_commits":922,"total_committers":57,"mean_commits":16.17543859649123,"dds":0.559652928416486,"last_synced_commit":"f9f9b7e92f5fb03cf9b75626377f951a5f85cd5d"},"previous_names":["manekinekko/swa-emulator"],"tags_count":47,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fstatic-web-apps-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fstatic-web-apps-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fstatic-web-apps-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Azure%2Fstatic-web-apps-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Azure","download_url":"https://codeload.github.com/Azure/static-web-apps-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251063114,"owners_count":21530832,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","azure","azure-functions","cli","serverless","static","swa","swa-emulator","web","webapp"],"created_at":"2024-08-02T08:00:23.815Z","updated_at":"2025-04-26T22:30:29.053Z","avatar_url":"https://github.com/Azure.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ch2 align=\"center\"\u003eAzure Static Web Apps CLI\u003c/h2\u003e\n  \u003ch2 align=\"center\"\u003e\n    \u003ca href=\"https://www.npmjs.com/package/@azure/static-web-apps-cli\"\u003e\n      \u003cimg src=\"https://img.shields.io/npm/v/@azure/static-web-apps-cli.svg\" alt=\"NPM version\"\u003e\n    \u003c/a\u003e\n    \u003cimg src=\"https://img.shields.io/node/v/@azure/static-web-apps-cli.svg\" alt=\"Node version\"\u003e\n    \u003ca href=\"https://github.com/Azure/static-web-apps-cli/actions/workflows/ci.yml\"\u003e\n      \u003cimg src=\"https://github.com/azure/static-web-apps-cli/workflows/CI/badge.svg\" alt=\"CI status\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/azure/static-web-apps-cli/issues\"\u003e\n      \u003cimg src=\"https://img.shields.io/badge/contributions-welcome-brightgreen.svg\" alt=\"Contributions welcome\"\u003e\n    \u003c/a\u003e\n  \u003c/h2\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg align=\"center\" src=\"docs/swa-cli-logo.svg\" width=\"300\" alt=\"logo\"\u003e\n\u003c/p\u003e\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 in your project, use:\n\n  ```bash\n  npm install -D @azure/static-web-apps-cli\n  ```\n\n  \u003e You can also install the SWA CLI globally using `npm install -g @azure/static-web-apps-cli`.\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 \u003ccommand\u003e --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","funding_links":[],"categories":["Official"],"sub_categories":["Official Repositories and Tools"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/azure.github.io%2Fstatic-web-apps-cli%2F","html_url":"https://awesome.ecosyste.ms/projects/azure.github.io%2Fstatic-web-apps-cli%2F","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/azure.github.io%2Fstatic-web-apps-cli%2F/lists"}