# @cascade-flow/cli 中文文档

规范地址：https://npmcn.com/package/%40cascade-flow/cli/

版本：0\.2\.32
npm 元数据更新时间：2026-08-11T20:36:36.002Z
中文译文更新时间：2026-11-09T10:57:17.245Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：357 MB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- Node.js 要求：\>=18
- 运行依赖：1 个
- peer 依赖：typescript ^5
- 首次发布：2025-11-20T09:55:34.122Z
- 最新版本发布：2026-08-11T20:36:35.722Z
- 近 30 天下载量：2843（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：32（近 12 个月 32 个）

## 中文简介

CascadeFlow 工作流程管弦乐手的命令行界面

## 安装

```sh
npm install @cascade-flow/cli
```

也可以使用：`pnpm add @cascade-flow/cli`、`yarn add @cascade-flow/cli`、`bun add @cascade-flow/cli`

## README

# 国 际

基于队列的工作流程执行的命令行界面.

## 安装

```bash
bun install
```

## 捆绑二进制

CLI 可以编译为独立的二进制 :

```bash
bun run build:current  # Build for current platform
bun run build          # Build for all platforms
```

**运行时间要求 :** 当使用捆绑的二进制时, `bun` 必须在系统上安装工作流程步骤执行。 这是因为工作流程步骤是TypeScript文件,需要在运行时被转录和执行.

```dockerfile
# Example Dockerfile
FROM oven/bun:1.2 AS runner
# bun is available from the base image
```

## 图标

### 工人

```bash
cf worker start [--mode unified|executor|scheduler] [--concurrency n] [--workflows-dir path]
```

### 提交和管理( M)

```bash
cf submit <workflow> [--input '{}' | --input-file path] [--priority n] [--timeout ms]
cf status <runId>
cf cancel <runId> [--reason text]
cf retry <runId> [--reason text]
```

### 工作流程( R)

```bash
cf workflows list
cf runs list [--workflow slug] [--status pending|running|completed|failed] [--all]
```

## 工人模式

-   **统一** (默认) - 所有循环在一个过程中
-   **执行者** - 只执行步骤(需要单独的调度器)
-   **调度器** - 只安排步骤(需要单独的执行者)

## 超时

**三级倒计时 :**

1.  步骤级别 : `defineStep({ timeoutMs })`
2.  提交级别 : `--timeout` 旗帜
3.  系统默认: 300 000 ms (5分钟)

**螺旋阈值 :** `--stale-threshold` (默认30s) - 探测到工人通过心跳缺失坠毁

## 实例

```bash
# Start worker
cf worker start --concurrency 5                    # Terminal 1

# Submit and manage workflows
cf submit my-workflow --input '{}' --timeout 60000 # Terminal 2
cf status <runId>

# Scaled deployment
cf worker start --mode scheduler                   # Terminal 1
cf worker start --mode executor --concurrency 10   # Terminal 2-4 (multiple)
```

## 常见问题

### @cascade-flow/cli 是什么？

CascadeFlow 工作流程管弦乐手的命令行界面

### 如何安装 @cascade-flow/cli？

在项目目录运行 npm install @cascade-flow/cli，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 cf，可以用 npx cf 直接运行。

### @cascade-flow/cli 支持 TypeScript 吗？

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

### @cascade-flow/cli 支持 ESM 还是 CommonJS？

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

### @cascade-flow/cli 需要什么版本的 Node\.js？

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

### @cascade-flow/cli 可以商用吗？

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

### @cascade-flow/cli 的下载量有多少？

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

### @cascade-flow/cli 还在维护吗？

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