# @faable/faable 中文文档

规范地址：https://npmcn.com/package/%40faable/faable/

版本：4\.41\.0
npm 元数据更新时间：2026-11-13T13:03:06.427Z
中文译文更新时间：2026-11-14T07:38:47.038Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40faable/faable
原文对照：https://npmcn.com/package/%40faable/faable/?lang=original
项目主页：https://faable.com/docs/cli
源码仓库：https://github.com/faablecloud/faable

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

- 包体积（解压后）：697 kB，200 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.8
- 运行依赖：14 个
- 首次发布：2022-12-20T18:45:46.246Z
- 最新版本发布：2026-11-13T13:03:05.750Z
- 近 30 天下载量：7907（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：216（近 12 个月 172 个）

## 中文简介

[![Faable CLI: deploy and run your apps from the terminal](https://raw.githubusercontent.com/faablecloud/faable/main/.github/assets/cover.png)](https://faable.com/docs/cli)

## 安装

```sh
npm install @faable/faable
```

也可以使用：`pnpm add @faable/faable`、`yarn add @faable/faable`、`bun add @faable/faable`

## README

[![Faable CLI: deploy and run your apps from the terminal](https://raw.githubusercontent.com/faablecloud/faable/main/.github/assets/cover.png)](https://faable.com/docs/cli)

[![npm version](https://img.shields.io/npm/v/@faable/faable.svg?labelColor=121a29&color=7270ee)](https://www.npmjs.com/package/@faable/faable) [![MIT license](https://img.shields.io/badge/license-MIT-7270ee?labelColor=121a29)](https://npmcn.com/package/%40faable/faable/LICENSE) [![Documentation](https://img.shields.io/badge/docs-faable.com-7270ee?labelColor=121a29)](https://faable.com/docs/cli)

# 异能的CLI

`@faable/faable` 是命令行接口 [异类](https://faable.com/) 平台。 这个 覆盖 **法可部署** (船舶和操作应用程序) **名人奥特** (管理身份租户: 用户、登录流程动作、OAuth客户端和审计日志)从一个二进制.

全文 : **[faable.com/docs/cli (英语)](https://faable.com/docs/cli)**。 。 。 .

## 安装

需要节点js 22.8 或以后.

```bash
npm i -g @faable/faable
```

## 快开始

```bash
faable login    # sign in from your browser
faable deploy   # deploy the current directory
faable deploy status
```

## 图标

| 组 | 它会做什么 | 文档 |
| --- | --- | --- |
| `faable login` 编号 : `whoami` 编号 : `logout` | 会话管理( 设备流; CI 使用 OIDC, 不需要登录) | [认证](https://faable.com/docs/cli#authentication) |
| `faable project` | 工程命令根据 : `list`, (中文(简体) ), `use`, (中文(简体) ), `current`, (中文(简体) ), `clear` (或 `--project` 在任何命令上) | [项目](https://faable.com/docs/cli#projects) |
| `faable organization` | 公司下属的集团项目: `list`, (中文(简体) ), `get`, (中文(简体) ), `create`, (中文(简体) ), `projects add`编号 :`rm`, (中文(简体) ), `admins add`编号 :`rm` (单位:千美元)`org` 简称) | [组织](https://faable.com/docs/cli#organizations) |
| `faable deploy` | `launch` (默认:一赤出) `faable deploy` 部署当前目录),然后 `status`, (中文(简体) ), `logs`, (中文(简体) ), `deployments`, (中文(简体) ), `inspect`, (中文(简体) ), `trigger`, (中文(简体) ), `redeploy`, (中文(简体) ), `cancel`, (中文(简体) ), `traffic`, (中文(简体) ), `usage`, (中文(简体) ), `quota`, (中文(简体) ), `open` | [部署](https://faable.com/docs/cli#deployment) |
| `faable deploy apps` | `list`, (中文(简体) ), `get`, (中文(简体) ), `create` (来自GitHub存储器,包括首次部署), `set` (分支、根目录、部署模式) | [应用程序](https://faable.com/docs/cli#apps) |
| `faable deploy secrets` | 环境变量: `list`, (中文(简体) ), `set` (单位:千美元)`KEY=VALUE`, (中文(简体) ), `--env-file`,或 `-f -` 从斯丁, `rm` | [秘诀](https://faable.com/docs/cli#secrets) |
| `faable deploy domains` | 自定义域 : `add` (印刷国家妇女委员会), `list`, (中文(简体) ), `check`, (中文(简体) ), `rm` | [域数](https://faable.com/docs/cli#domains) |
| `faable deploy waf` | 边缘规则 : `block` (403个), `sink` (404年没有唤醒应用程序), `list`, (中文(简体) ), `rm` | [边缘规则](https://faable.com/docs/cli#edge-rules-waf) |
| `faable auth users` | `list` (可行的QL过滤器), `get` (包括联邦身份), `suspend`, (中文(简体) ), `reinstate` | [用户](https://faable.com/docs/cli#users) |
| `faable auth actions` | 登录流程钩 : `list`, (中文(简体) ), `get --code`, (中文(简体) ), `create`, (中文(简体) ), `update`, (中文(简体) ), `rm` | [行动](https://faable.com/docs/cli#actions) |
| `faable auth clients` | OAuth 客户端: `list`, (中文(简体) ), `get --secret`, (中文(简体) ), `create`, (中文(简体) ), `rm` | [代理客户端](https://faable.com/docs/cli#oauth-clients) |
| `faable auth logs` | 审计日志( 只读) : `list` 有过滤器, `get` | [审计记录](https://faable.com/docs/cli#audit-logs) |

每个命令都有 `--help` 财务报告和审定财务报表 `--json`。 。 。 . `--app` 需要一个应用识别码,名称或弹壳. 完整的表格在 [命令引用](https://faable.com/docs/cli#command-reference)。 。 。 .

### MCP 服务器

`faable mcp` 将 CLI 作为 [MCP 磁共振](https://modelcontextprotocol.io/) 服务器结束 stdio,所以克劳德代码, Cursor 或任何 MCP 客户端都可以读取您的应用程序,部署 和日志——"为什么我最后一次部署失败了?"—— 和部署,与你 `faable login` 会议:

```bash
claude mcp add faable -- npx -y @faable/faable mcp
```

默认它会曝光读取加 `deploy_app` (建立最新的承诺服务器侧). `faable mcp --writes` 添加可逆写作: 从寄存器创建应用程序, 设置环境变量, 添加一个域, 重试或取消构建, 更改部署 设置。 没有破坏力暴露。 秘密值永远不会返回,而且 日志作为数据而不是指令返回.

### 脚本和代理

数据到 stdout,消息到 stderr. 与 `--json`数字 :

-   每个列表是 `{"object":"list","data":[…],"has_more","next_cursor"}` (单位:千美元)`--limit`, (中文(简体) ), `--starting-after`, (中文(简体) ), `--all`(三);
-   每次写回它所改变的东西 和无所事事的写回 `{"result":"noop","reason"}`· ;
-   失败退出 1 与 `{"error":{"message","code","status","action"}}` 打开 师曰. 代码 : `not_logged_in`, (中文(简体) ), `session_expired`, (中文(简体) ), `account_suspended`, (中文(简体) ), `apikey_session`, (中文(简体) ), `forbidden`, (中文(简体) ), `not_found`, (中文(简体) ), `confirmation_required`, (中文(简体) ), `app_required`, (中文(简体) ), `usage`,或API自己的代码.

驱动 CLI 的程序应该设置 `FAABLE_NONINTERACTIVE=1` (或通过) `--non-interactive`: 没有提示——没有确认 `--yes` 失败 与 `confirmation_required` —— 应用程序从不从工作的推断 目录,以及 `faable deploy launch` 需求 `--app`, (中文(简体) ), `--workdir` 财务报告和审定财务报表 `--yes`。 。 。 . 通过 stdin 上的秘密值 (`faable deploy secrets set -f -`),从来没有像 参数.

### 部署

```bash
faable login
faable deploy                       # deploy the current directory (= deploy launch)
faable deploy launch --app app_x    # deploy another app, from anywhere
faable deploy apps create --repo acme/web   # create, link, first deploy
faable deploy --create site --workdir ./public --yes   # a new app from a folder (git or not)
faable deploy link --app web --repo acme/web      # link a repository to an existing app
faable deploy apps rm --app app_x   # delete an app (asks first; --yes to skip)
faable deploy status                # phase, URL and detected stack
faable deploy logs --build -n 100   # end of the build output (--follow to tail)
faable deploy traffic --since 7d    # status codes, top and failing paths
faable deploy secrets set KEY=value
faable deploy domains add app.example.com
```

### 名人奥特

`faable auth` 管理 a [名人奥特](https://faable.com/docs/auth) 租户和 重用您的语言 `faable login` 届会。 指着房客 `--auth-url https://<account>.auth.faable.link` (或 `FAABLE_AUTH_URL`) (中文(简体) ).

```bash
faable auth users list --query email_verified:false --limit 50
faable auth users get user_abc123                   # includes GitHub/… identities
faable auth users suspend user_abc123 -r "abuse: crypto miner"

# Bulk: pipe ids from a filtered listing
faable auth users list --suspended --json | jq -r '.data[].id' | faable auth users reinstate -y

faable auth actions create -n add-claims -t post-login -f ./claims.js
faable auth clients create -n my-app --callback https://app.example.com/callback
faable auth logs list --origin oauth --status failed --since 2026-08-01
```

见 [`faable auth` 文档中](https://faable.com/docs/cli#faable-auth) 页:1 每个旗帜。 每一组背后的概念见Faable Auth: [用户暂停( s)](https://faable.com/docs/auth/suspend-users), (中文(简体) ), [动作](https://faable.com/docs/auth/extensibility/actions), (中文(简体) ), [登录流量](https://faable.com/docs/auth/login-flows), (中文(简体) ), [代理客户端](https://faable.com/docs/auth/clients) 财务报告和审定财务报表 [审计记录](https://faable.com/docs/auth/logs)。 。 。 .

## 文档

CLI是一个很薄的客户端:它部署什么和管理什么被记录在其中 公众文件,不在这里.

### 国 际

-   [命令参考](https://faable.com/docs/cli#command-reference) 每个命令和旗帜
-   [认证](https://faable.com/docs/cli#authentication) —— 说 `login`, (中文(简体) ), `whoami`, (中文(简体) ), `logout`
-   [部署](https://faable.com/docs/cli#deployment) • 妇女 [检查](https://faable.com/docs/cli#inspecting) • 妇女 [秘诀](https://faable.com/docs/cli#secrets) • 妇女 [域数](https://faable.com/docs/cli#domains) • 妇女 [边缘规则](https://faable.com/docs/cli#edge-rules-waf) • 妇女 [名人奥特](https://faable.com/docs/cli#faable-auth)

### 法可部署

-   [开始吧](https://faable.com/docs/deploy/get-started) 几分钟后首次部署
-   [如何部署](https://faable.com/docs/deploy/how-it-works) ——推向部署,建设和释放
-   [运行时间](https://faable.com/docs/deploy/runtime) ——支持的语言,框架检测, `faable.json` 编号 : `Procfile` 覆盖
-   [建设者所期望的](https://faable.com/docs/deploy/build-requirements) 建立和启动命令, `$PORT`单体
-   [环境发布](https://faable.com/docs/deploy/environment) ——秘密,env vars和发行版本
-   [自定义域](https://faable.com/docs/deploy/domains/custom-domain) 财务报告和审定财务报表 [SSL 证书](https://faable.com/docs/deploy/domains/ssl-certificates)
-   [Web 应用程序防火墙](https://faable.com/docs/deploy/security-waf) - 后面的边缘规则 `faable deploy waf`
-   [从你自己的线人部署](https://faable.com/docs/deploy/github-actions) — OIDC, 不需要登录
-   框架指南: [下一个.js](https://faable.com/docs/deploy/guides/guide-next), (中文(简体) ), [维特](https://faable.com/docs/deploy/guides/guide-vite), (中文(简体) ), [天体](https://faable.com/docs/deploy/guides/guide-astro), (中文(简体) ), [快递](https://faable.com/docs/deploy/guides/guide-express), (中文(简体) ), [强哥](https://faable.com/docs/deploy/guides/guide-django), (中文(简体) ), [FastAPI 软件](https://faable.com/docs/deploy/guides/guide-fastapi), (中文(简体) ), [火焰](https://faable.com/docs/deploy/guides/guide-flask), (中文(简体) ), [前一頁](https://faable.com/docs/deploy/guides/guide-php)

### 名人奥特

-   [开始吧](https://faable.com/docs/auth/get-started) ——设立租户
-   [客户](https://faable.com/docs/auth/clients) • 妇女 [连接](https://faable.com/docs/auth/connections) • 妇女 [社会登录](https://faable.com/docs/auth/social) • 妇女 [无密码](https://faable.com/docs/auth/passwordless)
-   [暂停用户](https://faable.com/docs/auth/suspend-users) - 什麽 `users suspend` 编号 : `reinstate` 切换会话和符号
-   [登录流量](https://faable.com/docs/auth/login-flows) 财务报告和审定财务报表 [动作](https://faable.com/docs/auth/extensibility/actions) - 钩子由 `auth actions`
-   [日志](https://faable.com/docs/auth/logs) - 阅读的审计线索 `auth logs`
-   [OAuth 2.0 流量](https://faable.com/docs/auth/oauth-flows) • 妇女 [OpenID 连接](https://faable.com/docs/auth/oidc) • 妇女 [验证访问令牌](https://faable.com/docs/auth/validate-access-tokens)

## 支助

-   **联合国** [faable.com/docs (英语)](https://faable.com/docs)
-   **社区帮助,每个计划:** [GitHub 讨论](https://github.com/orgs/faablecloud/discussions)
-   **在Hobby和Pro计划上** [支持@faable.com](mailto:support@faable.com)。 。 。 . 见 [支持页面](https://faable.com/docs/platform/support)
-   **错误和特性请求 :** [打开一个问题](https://github.com/faablecloud/faable/issues)
-   **安全问题:** 私下报告 [支持@faable.com](mailto:support@faable.com), (中文(简体) ), 不在公共场合

## 许可证

[麻省理工学院](https://npmcn.com/package/%40faable/faable/LICENSE) 飞云 SLU

## 常见问题

### 如何安装 @faable/faable？

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

### @faable/faable 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @faable/faable 支持 ESM 还是 CommonJS？

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

### @faable/faable 需要什么版本的 Node\.js？

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

### @faable/faable 可以商用吗？

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

### @faable/faable 的下载量有多少？

根据 npm 官方下载统计，@faable/faable 在 2026/10/14 – 2026/11/12 这 30 天内被下载 7,907 次，日均约 264 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @faable/faable 还在维护吗？

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