# @flow-engineer/flow 中文文档

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

版本：0\.19\.0
npm 元数据更新时间：2026-11-10T07:22:53.204Z
中文译文更新时间：2026-11-15T00:06:22.828Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：2.8 MB，216 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.18
- 运行依赖：6 个
- peer 依赖：marked 12\.0\.2，esbuild 0\.28\.2，oidc-provider 9\.12\.2，marked-terminal 7\.3\.0，@mariozechner/pi-tui 0\.73\.1
- 首次发布：2026-10-18T15:22:58.187Z
- 最新版本发布：2026-11-10T07:22:53.023Z
- 近 30 天下载量：11402（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：63（近 12 个月 63 个）

## 中文简介

对觉得自己像发回短信的人的聊天代理的开源运行时间.

## 安装

```sh
npm install @flow-engineer/flow
```

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

## README

# 流动框架

**盖一回. 每次聊天都要飞去.**

一个开源的TypeScript框架,将您的产品带到克洛德,ChatGPT,终端, WhatsApp, iMessage, Telegram 和你自己的应用程序. 将您的工具和技能写出一次; 用作 一个MCP服务器,一个插件,一个CLI和一个消息代理.

我们为第一个聊天世界而建设Flow:人们应该能够通过要求来使用产品 他们需要什么, 在那里他们已经聊天。 移动预订或放置命令应在 对话——不是以与形式的联系结束。 是否有人发短信或问他们 他们应该拥有同样的产品能力.

[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://npmcn.com/package/%40flow-engineer/flow/LICENSE) ![Node 22.18+](https://img.shields.io/badge/node-%3E%3D22.18-brightgreen.svg) ![TypeScript](https://img.shields.io/badge/TypeScript-yes-3178c6.svg)

[文档](https://flow.engineer/docs/framework) • 妇女 [快速启动](https://flow.engineer/docs/framework/quickstart) • 妇女 [编码代理](https://flow.engineer/docs/agents) • 妇女 [网站](https://flow.engineer/)

## 每个接口都有一个密码库

| 构建 | 到达 |
| --- | --- |
| [MCP 服务器](https://flow.engineer/docs/framework/mcp) | Claude、ChatGPT和其他MCP客户端 |
| [插件](https://flow.engineer/docs/plugins) | 装入本地技能和 MCP 连接的主机 |
| [国 际](https://flow.engineer/docs/cli) | 人、脚本、克洛德码、编码等编码代理 |
| [通讯代理](https://flow.engineer/docs/conversations) | WhatsApp, iMessage, Telegram, 短消息和你自己的网络或应用程序聊天 |
| [网络应用](https://flow.engineer/docs/framework/web-app) | 人们在自己的网站, 在旁边的面板上 |

工具是类型Script函数,可以调用您的API. 技能教他们周围的工作流程. Flow通过每个接口显示相同的能力,为您提供认证钩 用户和空间可以自定义生成的工具、命令和处理器.

在克洛德和ChatGPT中,主机的模型使用了你的MCP工具. 在信件中, Flow 运行 与你的模型对话, 处理双文本, 承认,背景工具, 频道规则,提醒,持续历史和代理商自己的记录. 从任意开始 接口.

## 快开始

节点22.18或后. 以咖啡馆为例创建项目 :

```sh
npx @flow-engineer/flow new my-agent --display-name "My agent"
cd my-agent
npm install
```

启动器包含一个MCP服务器,一个CLI和一个消息代理器中的相同工具.

### MCP和CLI 数据

启动服务器 :

```sh
npm run mcp
```

它打印出MCP URL和一个连接克洛德代码的命令. 在另一个终端,试试CLI:

```sh
npm run cli -- --help
npm run cli -- menu --json
```

要从当前聊天中测试任何 MCP 服务器, 请使用 `npx @flow-engineer/flow inspect <url> tools` 使用服务器打印的 URL. `call`, (中文(简体) ), `auth`, (中文(简体) ), `resources` 财务报告和审定财务报表 `prompts` 行使它的工具, 作为主机的登录和其他能力,不需要CLI配置.

这些工具呼叫不需要模型键. 要远程到达 Claude 或 ChatGPT, 请托管 MCP 服务器 HTTPS并在主机中连接. [MCP和登录](https://flow.engineer/docs/framework/mcp) • 妇女 [插件软件包](https://flow.engineer/docs/plugins)

### 通讯和操场

```sh
npx @flow-engineer/flow link --channel telegram
npm start
```

`link` 签入,设置试键并打印出电话链接. 使用 `--channel whatsapp` 或者说 `--channel imessage` 当这些平台可用时。 打开游乐场 URL from `npm start` 然后在运行时从手机上发短信 你也可以用自己的车 模式密钥和消息提供者. [全面设置和审判细节](https://flow.engineer/docs/framework/quickstart)

## 用您的编码代理构建

`flow new` 包括编码代理技能和 `AGENTS.md` 指着他们。 给克洛德代码, Codex或另一个编码代理您的产品代码库,并告诉它要构建哪个接口. 将咖啡馆工具替换为给您的 API 的电话,并通过技能来教授您的工作流程 .

读取 [编码代理指南](https://flow.engineer/docs/agents),或探索 [咖啡馆实例](https://npmcn.com/package/%40flow-engineer/flow/examples/cafe)。 。 。 .

## 测试、宿主和观察

检查工具、技能和 CLI 配置 `npx @flow-engineer/flow check`测试信件 有模拟对话的代理人,检查痕迹,并在自己的基础设施上部署,或 流经云. 游乐场模拟器跟踪每个应用程序的行为,包括频道特异性 控制、媒体和语音注释; 调试模式显示基本的平台有效载荷。 流程消息 通过一个 API 提供频道;您也可以带来自己的服务商。 一旦它被直播, `npx @flow-engineer/flow conversations --grade wrong` 列出答复为 分级错误, `flow conversations show <id>` 印出每个年级的规则和理由 `flow issues` 他们加起来的问题,以及 `flow insights` 人们放弃或得到 烦了,所以一个编码代理可以修复它们.

[部署](https://flow.engineer/docs/hosting) • 妇女 [自我接待](https://flow.engineer/docs/self-hosting) • 妇女 [测试](https://flow.engineer/docs/testing) • 妇女 [追踪](https://flow.engineer/docs/traces)

## 文档

这个 [文档网站](https://flow.engineer/docs) 涵盖框架和 [统一通讯API](https://flow.engineer/docs/unified-messaging-api)其来源存在于 私营 `flow-engineer/docs` 仓库。 公共行为改变 更新相关的指南 为人和编码代理;见 [一般事务人员(其他职等)](https://npmcn.com/package/%40flow-engineer/flow/AGENTS.md)。 。 。 .

[工具](https://flow.engineer/docs/build-agent) • 妇女 [技能](https://flow.engineer/docs/skills) • 妇女 [模式和备选方案](https://flow.engineer/docs/reference)

在此寄存器中: [频道选项](https://npmcn.com/package/%40flow-engineer/flow/docs/channels.md) • 妇女 [有效模式](https://npmcn.com/package/%40flow-engineer/flow/docs/patterns.md) (执行什么是最重要的 `beforeSend`,保持提示 判断,在代码中渲染,拒绝的原因 模型可以采取行动,测试一个长聊天.

一个频道的 `sendMessage` 当您的平台接受消息, 而拒绝消息时, 就会解决 拒绝 : 代理的下一封信件等待它, 拒绝信送达代理为不是 交付。 什么命令,什么发送一次,什么 `send()` 解决手段: [文件/担保](https://npmcn.com/package/%40flow-engineer/flow/docs/guarantees.md)。 。 。 .

现成 `beforeSend` 检查用 `guards(...)`,第一次拒绝获胜: `oncePerChat(line)` (每次谈话最多一次免责声明), `noRepeats()`, (中文(简体) ), `linkAllowlist(hosts)` 财务报告和审定财务报表 `noWriteButtons(actions)`他们宣读贮藏的经典 历史`context.sent`),所以在重启后它们会保持. `agent.resetHistory({ to, note })` 开始 模式从现在开始再次发送历史(没有删除)。 每个模式调用最多 24000个历史征兆,占模型的60% `contextTokens` 当它更少的时候 (单位:千美元)`createAgent({ history: { maxTokens } })` 以改变它.

代理人必须记住的天数和人(买方的问题等待 卖方的答复),它作为记录保存:JSON小文件收录于申报日期 `createAgent({ records })`,通过 id 读取或匹配在几个已宣布的字段上, 在同一商店中与其 对话,所以他们生存 重新启动,部署和工作 在操场, 由Flow主持。 忘记一个人删除了他们的名字记录 `flow records export` 全部打印出来。 规则:如果除了代理人之外还有别的东西读它,它 属于您自己的数据库. [文件/代理人](https://npmcn.com/package/%40flow-engineer/flow/docs/agents.md#the-agents-own-records)

## 稳定

Flow Framework是0.x:直到1.0它的API(导出,选项,文件格式,CLI的命令, `--json` 字段和退出代码)在版本之间可能会有变化. 每一个发行的笔记 呼唤每个 用一个移民说明来打破变化 说要改变什么。 API冻结为1.0. 钉入精确 版本在 `package.json` 在移动前读取注释。 冻得什么 1.0级: [文件/稳定性](https://npmcn.com/package/%40flow-engineer/flow/docs/stability.md)。 。 。 .

## 许可证

[阿帕奇 - 2.0](https://npmcn.com/package/%40flow-engineer/flow/LICENSE)

## 常见问题

### @flow-engineer/flow 是什么？

对觉得自己像发回短信的人的聊天代理的开源运行时间\.

### 如何安装 @flow-engineer/flow？

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

### @flow-engineer/flow 支持 TypeScript 吗？

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

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

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

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

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

### @flow-engineer/flow 可以商用吗？

@flow-engineer/flow 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

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

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

### @flow-engineer/flow 还在维护吗？

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