@flui-cloud/cli

中文文档
0.14.0发布于 2026/11/04AGPL-3.0-or-laterCommonJS近 30 天下载 2969

Command-line interface for Flui — the open-source platform to deploy applications across cloud providers and your own servers.

原始使用文档
文档目录8 节
  1. Install
  2. Quickstart
  3. What you can do next
  4. Topics
  5. Common conventions
  6. Profiles on disk
  7. Links
  8. License

@flui-cloud/cli

Command-line interface for Flui — the open platform layer on top of your cloud provider. Create clusters, deploy applications from a flui.yaml manifest, switch between installations, and operate the lifecycle end to end from one binary.

Full reference: docs.flui.cloud/cli.

Install

npm install -g @flui-cloud/cli       # or: pnpm add -g, yarn global add
flui --version

To upgrade later, run flui update — it self-replaces the global install with the latest published version.

Quickstart

Flui is a modern, multi-cloud platform layer that turns plain cloud servers into a full application platform — you keep ownership of the infrastructure, no vendor lock-in. Create your installation in one interactive command — it asks for an admin email and a credential for one of the supported cloud providers (Hetzner and Scaleway today; more providers and bring-your-own-server installs on the roadmap), then in a few minutes returns an environment ready to host applications: cluster, ingress, TLS, identity, observability, dashboard — already wired in.

flui env create

The command streams the install logs until the platform is reachable, then prints the dashboard, API and OIDC URLs. The full walkthrough lives at Getting started.

What you can do next

Once the cluster is up, plenty works without any extra integration — day-to-day operating the installation, inspecting resources, and deploying pre-built apps:

flui auth login                              # OIDC against the freshly created installation

flui env status                              # control-cluster health, nodes, capacity
flui env credentials --test                  # print + probe the dashboard / API / OIDC / Grafana URLs

flui app list                                # all apps on the installation
flui app status <name>                       # rollout state, replicas, image
flui app logs <name> --tail 200              # recent logs
flui app metrics <name>                      # CPU / memory / network

flui deploy                                  # deploy a flui.yaml from the current directory

For source-built apps (kind: Application, built from a GitHub repo) you also need to connect GitHub first — flui integration connect github with a personal access token, the recommended setup — see Integrations. Pre-built CatalogApps (kind: CatalogApp) skip all of that and deploy straight from flui deploy against any public image registry. The manifest reference is on Deploy.

Topics

Commands are grouped into topics; each verb has its own --help.

TopicWhat it does
envLifecycle of the control cluster — create, inspect, scale, destroy.
cluster / nodeWorkload-cluster destroy and worker-node add/remove/list.
appInspect, scale, restart, snapshot, redeploy, and delete applications; read logs, metrics, and crash reports.
deploy / catalogDeploy from a flui.yaml manifest; validate the manifest offline.
integration / repoConnect GitHub (a personal access token, or the Flui GitHub App) and import repositories — prerequisites for the first source-built deploy.
templateCreate a new repository from a Flui framework template.
backupManage backup destinations, policies, jobs, and restores.
authOIDC login and long-lived M2M API keys.
context / configProfiles (isolated installations) and layered configuration.
server-types / sshList provider server sizes; SSH into a node.
devHelpers for Flui contributors (export secrets, SSH tunnel).
dns / reconcile / updateMaintenance utilities.

Per-topic reference pages: see docs.flui.cloud/cli.

Common conventions

A handful of flags recur across the CLI:

  • -c, --cluster <name|id> — target cluster explicitly. Auto-detected when only one is present.
  • -o, --output <format> — json is always available for scripting; the human format is text or table depending on the command.
  • --no-wait / --detach — return as soon as the job is queued.
  • -f, --force / -y, --yes — skip confirmation on destructive operations.
  • --dry-run — print what would happen on a subset of mutating commands.

Commands that talk to the API print a short context banner before running (active profile + API URL).

Profiles on disk

The CLI keeps each installation's state under ~/.flui/profiles/<name>/. A profile holds the API token, the encrypted credentials needed to talk to the provider, the SSH CA used for cluster nodes, and the local inventory the profile knows about. The path can be moved with the FLUI_DIR environment variable.

Switching between installations: flui context use <name>.

License

AGPL-3.0-or-later. See LICENSE.

版本与发布记录

@flui-cloud/cli 共发布 35 个版本,首次发布于 2026/05/19;过去 12 个月发布了 35 个版本。

版本发布日期距今
0.14.0latest2026/11/0412 天前
0.14.0-rc.10rc2026/11/0412 天前
0.14.0-rc.12026/10/1928 天前
0.13.0-rc.21.52026/10/1828 天前
0.13.0-rc.21.32026/10/1829 天前
0.13.0-rc.21.22026/10/1829 天前

关于 @flui-cloud/cli 的常见问题

@flui-cloud/cli 是什么?

Command-line interface for Flui — the open-source platform to deploy applications across cloud providers and your own servers.

如何安装 @flui-cloud/cli?

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

@flui-cloud/cli 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/flui-cloud__cli 是否存在。

@flui-cloud/cli 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@flui-cloud/cli 需要什么版本的 Node.js?

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

@flui-cloud/cli 可以商用吗?

@flui-cloud/cli 使用 AGPL-3.0-or-later 许可。最严格的 Copyleft:除分发外,通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括,不构成法律意见,请以许可原文为准。

@flui-cloud/cli 的下载量有多少?

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

@flui-cloud/cli 还在维护吗?

最新版本 0.14.0 发布于 2026/11/04(12 天前);至今共发布 35 个版本,其中过去 12 个月发布了 35 个;首次发布于 2026/05/19。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。