# @azure/static-web-apps-cli 中文文档

规范地址：https://npmcn.com/package/%40azure/static-web-apps-cli/

版本：2\.1\.0
npm 元数据更新时间：2026-10-20T07:40:16.977Z
中文译文更新时间：2026-11-07T13:19:43.869Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40azure/static-web-apps-cli
原文对照：https://npmcn.com/package/%40azure/static-web-apps-cli/?lang=original
项目主页：https://github.com/azure/static-web-apps-cli#readme
源码仓库：https://github.com/azure/static-web-apps-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：906 kB，333 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18\.0\.0
- 运行依赖：36 个
- 首次发布：2021-02-17T07:55:53.360Z
- 最新版本发布：2026-10-20T07:40:16.610Z
- 近 30 天下载量：629696（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 4 个）

## 中文简介

Azure 静态网络应用程序 CLI

## 安装

```sh
npm install @azure/static-web-apps-cli
```

也可以使用：`pnpm add @azure/static-web-apps-cli`、`yarn add @azure/static-web-apps-cli`、`bun add @azure/static-web-apps-cli`

## README

## Azure 静态网络应用程序 CLI

##  [![NPM version](https://img.shields.io/npm/v/@azure/static-web-apps-cli.svg)](https://www.npmjs.com/package/@azure/static-web-apps-cli)![Node version](https://img.shields.io/node/v/@azure/static-web-apps-cli.svg) [![CI status](https://github.com/azure/static-web-apps-cli/workflows/CI/badge.svg) ](https://github.com/Azure/static-web-apps-cli/actions/workflows/ci.yml)[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/azure/static-web-apps-cli/issues)

![logo](https://npmcn.com/package/%40azure/static-web-apps-cli/docs/swa-cli-logo.svg)

Static Web Apps CLI,又名SWA CLI,是当地开发工具,用于: [Azure 静态网络应用程序](https://docs.microsoft.com/azure/static-web-apps)它可以:

-   服务静态应用程序资产, 或代理到您的应用程序 dev 服务器
-   服务 API 请求, 或代理到 Azure 函数核心工具运行的 APIs
-   模拟认证和授权
-   模拟静态网络应用程序配置,包括路由和ACL角色
-   将您的应用应用到 Azure Static 网络应用

## 重要说明

如果您有建议或遇到问题,请报告或帮助我们解决。 非常感谢你的贡献

CLI模仿了Azure Static Web Apps云服务常用的能力. **预期会出现一些差异。 总是部署和测试你的应用 在Azure确认行为.**

## 快速启动

### 将 CLI 安装到 `npm`, (中文(简体) ), `yarn` 或者说 `pnpm`数字 :

-   要在您的工程中安装 CLI, 请使用 :
    
    ```bash
    npm install -D @azure/static-web-apps-cli
    ```
    
    > 您也可以在全球安装 SWA CLI `npm install -g @azure/static-web-apps-cli`。 。 。 .
    

### 基本用途

-   在根部打开 SWA app文件夹( 在任何 / api 或/ app 文件夹外) :
    
    ```bash
    cd my-awesome-swa-app
    ```
    
-   最好的开始方式是运行 `swa` 命令并跟踪交互式提示 :
    
    ```bash
    swa
    ```
    

它将为您生成一个配置, 然后构建您的项目, 并询问您是否想要将其部署到 Azure .

见 [须花](https://azure.github.io/static-web-apps-cli/) 更多细节.

### 扩展用途

以下是目前支持的 `swa` 命令。 使用 `swa <command> --help` 学习该特定命令的选择和使用.

-   [`login`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-login): 登录到 Azure 中
-   [`init`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-init): 初始化一个新的静态网络应用项目
-   [`start`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start): 从目录启动仿真器或绑定到 dev 服务器
-   [`deploy`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy): 将当前工程部署到 Azure Static Web Apps
-   [`build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build): 构建您的项目

### 使用 `npx`数字 :

-   在根部打开 SWA app文件夹( 在任何 / api 或/ app 文件夹外) :

```bash
cd my-awesome-swa-app
```

-   为您的工程创建配置 :

```bash
npx @azure/static-web-apps-cli init
```

-   启动模拟器 :

```bash
npx @azure/static-web-apps-cli start
```

-   访问您的 SWA 应用程序 `http://localhost:4280`

见所有可用的 [命令和选项](https://azure.github.io/static-web-apps-cli/)。 。 。 .

## 想帮忙吗?

想要归档错误, 提供一些代码, 还是改进文档 ? 不错! 阅读我们的准则 [捐款](https://github.com/azure/static-web-apps-cli/blob/master/CONTRIBUTING.md) 然后查一下我们清单上的问题之一: [社区帮助](https://github.com/azure/static-web-apps-cli/issues)。 。 。 .

## 常见问题

### @azure/static-web-apps-cli 是什么？

Azure 静态网络应用程序 CLI

### 如何安装 @azure/static-web-apps-cli？

在项目目录运行 npm install @azure/static-web-apps-cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 swa，可以用 npx swa 直接运行。

### @azure/static-web-apps-cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/azure\_\_static-web-apps-cli 是否存在。

### @azure/static-web-apps-cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @azure/static-web-apps-cli 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @azure/static-web-apps-cli 可以商用吗？

@azure/static-web-apps-cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @azure/static-web-apps-cli 的下载量有多少？

根据 npm 官方下载统计，@azure/static-web-apps-cli 在 2026/10/08 – 2026/11/06 这 30 天内被下载 629,696 次，日均约 20,990 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @azure/static-web-apps-cli 还在维护吗？

最新版本 2\.1\.0 发布于 2026/10/20（18 天前）；至今共发布 45 个版本，其中过去 12 个月发布了 4 个；首次发布于 2021/02/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。