# @cascade-flow/runner 中文文档

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

版本：0\.2\.33
npm 元数据更新时间：2026-08-11T22:08:22.144Z
中文译文更新时间：2026-11-09T12:30:57.899Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1.3 MB，20 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：@cascade-flow/backend-interface ^0\.2\.17，typescript ^5
- 首次发布：2025-11-19T11:52:08.607Z
- 最新版本发布：2026-08-11T22:08:21.931Z
- 近 30 天下载量：2713（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：17（近 12 个月 17 个）

## 中文简介

具有依赖感的并行任务执行核心工作流程执行引擎

## 安装

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

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

## README

# 运行者

工人包使用的工作流程发现和步骤执行工具.

## 安装

```bash
bun install
```

## 出口

```typescript
// Step execution
executeStepInProcess(stepFile, stepId, dependencies, ctx, attemptNumber, backend, onLog?, options?): Promise<{ result, logs }>;

// Discovery
discoverWorkflows(dir?: string): Promise<WorkflowMetadata[]>;
discoverSteps(workflowDir: string): Promise<LoadedStep[]>;

// Versioning
calculateWorkflowHash(workflow): Promise<string>;
getGitInfo(dir): Promise<GitInfo | undefined>;

// Validation
getAllDependents(stepId, steps): string[];
validateWorkflowVersion(workflowSlug, runId, currentVersionId, backend, log): Promise<string>;

// Types
LoadedStep  // Step with resolved dependencies
```

## 关键特性

-   **工作流程发现** - 自动发现工作流程 `./workflows/` 目录
-   **步骤发现** - 装入和接线台阶依赖性,并附有完整的类型脚本推论
-   **子进程执行** - 执行孤立儿童过程中的步骤
-   **循环检测** - 外勤部验证防止循环依赖
-   **版本跟踪** - SHA-256散列工作流程版本比较

## 工作流程结构

```
workflows/my-workflow/
├── workflow.json       # {"name": "My Workflow"}
├── input-schema.ts     # Optional: Zod schema
└── steps/
    ├── step-1/step.ts                    # Flat step
    ├── step-2/step.ts                    # Flat step
    └── data-processing/                  # Optional: Group directory
        └── extract/
            └── fetch-data/step.ts        # Nested step
```

## 说明

用于工作流程编写 API(`defineStep`, (中文(简体) ), `baseDefineStep`, (中文(简体) ), `Skip`, (中文(简体) ), `optional`见 `@cascade-flow/workflow` 软件包.

## 常见问题

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

具有依赖感的并行任务执行核心工作流程执行引擎

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

在项目目录运行 npm install @cascade-flow/runner，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@cascade-flow/backend-interface（^0\.2\.17）、typescript（^5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

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

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

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

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

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

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

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

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

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

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