@getxflow/cli

中文文档
2.0.5发布于 2026/11/16UNLICENSED零依赖近 30 天下载 4499

CLI for the XFlow platform: projects with apps, functions and a database; source sync, deployment and publishing

原始使用文档

@getxflow/cli

CLI for the XFlow platform: source sync, builds and releases.

npm i -g @getxflow/cli
xflow login
xflow init my-app
cd my-app && npm install && xflow dev
xflow deploy -m "First version"

Requires Node 22+. The package has no dependencies: it holds an access key, and nobody else's code belongs next to it.

CommandWhat it does
login / logout / whoamisign in through the browser, sign out, whose key this is and what it can do
org / org switchorganizations with a stored key, and which one this folder works with
init / linknew app, link a folder to an existing one
migratemove a CLI 1 project (root with apps/) into one app folder
status / pullstate of the sources on the server and fetching them back
deploy / publish / rollback / deploymentsbuild a version (site, functions, migrations), publish it, go back to an earlier one, history
db status / db migrateapplied migrations, a dry run of migrations/*.sql (they apply with deploy)
db schema / db querytables and columns, reading data in a read-only transaction
functions listcloud functions of the app from functions/<name>/index.ts, live with publish
functions invoke / functions logscall a function, look at its crashes with the stack
schedules list / set / rmrunning functions on a timer (timer triggers)
env / env check / env setenvironment variables of the functions, values are never handed back
connections / connections link / connections unlinkconnected accounts the functions can use, and their variables
logsbrowser errors from the released application
apps / apps get / apps deleteapps of the organization, one app card, deleting an app
skillsplatform instructions for an AI agent (Agent Skills format)
updateupdate the CLI itself, and the skill that ships inside it

Help for one command: xflow help <command>.

You write the application yourself or with your agent: the platform stays out of the code. xflow skills puts a description of the platform alongside it, which Claude Code, Codex and OpenClaw pick up on their own when a task touches XFlow. Your AGENTS.md and CLAUDE.md are left alone. The description ships inside the package and shares its version, so xflow update brings both.

The key is stored in ~/.xflow/credentials.json, the app configuration in xflow.json. For CI, pass the key in the XFLOW_TOKEN variable.

A project of CLI 1 with several apps stays on the previous major: npx -y @getxflow/cli@1 <command>.

版本与发布记录

@getxflow/cli 共发布 107 个版本,首次发布于 2026/08/03;过去 12 个月发布了 107 个版本。

版本发布日期距今
2.0.5latest2026/11/16今天
2.0.42026/11/124 天前
2.0.32026/11/106 天前
2.0.22026/11/0511 天前
2.0.12026/11/0411 天前
2.0.02026/11/0411 天前

关于 @getxflow/cli 的常见问题

@getxflow/cli 是什么?

CLI for the XFlow platform: projects with apps, functions and a database; source sync, deployment and publishing

如何安装 @getxflow/cli?

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

@getxflow/cli 支持 TypeScript 吗?

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

@getxflow/cli 需要什么版本的 Node.js?

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

@getxflow/cli 可以商用吗?

@getxflow/cli 使用 UNLICENSED 许可。作者声明为 UNLICENSED,即不授予公开使用许可(与公共领域的 Unlicense 不同)。使用前需获得作者授权。以上为概括,不构成法律意见,请以许可原文为准。

@getxflow/cli 的下载量有多少?

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

@getxflow/cli 还在维护吗?

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