# @foldrun/core 中文文档

规范地址：https://npmcn.com/package/%40foldrun/core/

版本：24\.0\.0
npm 元数据更新时间：2026-11-15T12:57:08.681Z
中文译文更新时间：2026-11-15T04:03:00.757Z
软件包许可：FSL-1\.1-ALv2

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

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

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

- 包体积（解压后）：7.3 MB，497 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- 首次发布：2026-09-07T05:11:21.885Z
- 最新版本发布：2026-11-15T12:57:08.300Z
- 近 30 天下载量：27454（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：133（近 12 个月 133 个）

## 中文简介

代理只是文件夹。格式，运行程序，检查。

## 安装

```sh
npm install @foldrun/core
```

也可以使用：`pnpm add @foldrun/core`、`yarn add @foldrun/core`、`bun add @foldrun/core`

## README

# 折叠运行

[![npm](https://img.shields.io/npm/v/@foldrun/core)](https://www.npmjs.com/package/@foldrun/core)

**特工只是文件夹 写下来,检查一下,运行它们.**

代理是一个文件夹 。 其指示、技能、知识、记忆、工具和 测试是您可以读取、 diff 和 承诺的文件 。 没有SDK可以学习,没有 图表到线条——运行时间读取文件夹.

```bash
npx foldrun init my-desk
cd my-desk
foldrun check          # validate everything — costs nothing
foldrun run publish    # run the flow
```

```
my-desk/
├── AGENTS.md          what every agent here should know
├── agents/            who does the work
│   └── writer/agent.md
├── flows/             in what order
│   └── publish.md
├── skills/            how a task is done
├── knowledge/         what you gave them
├── memory/            what they learned
├── tools/             what they can call
├── scripts/           code
└── evals/             is it any good
```

**API 参考 :** docs/api.md——每一个路线,它的方法,以及它需要什么.

## 以别人的标准建造

这种形式大多不是我们的。 在有开放标准的地方,我们采用 而不是与之竞争:

| 层 | 标准 | 从 |
| --- | --- | --- |
| `AGENTS.md` | [一般事务人员(其他职等)](https://agents.md/) | Linux基金会 |
| `skills/` | [代理技能](https://agentskills.io/) | 安东尼 |
| 文档 `knowledge/`, (中文(简体) ), `memory/` | [开放知识格式v0.2](https://github.com/GoogleCloudPlatform/knowledge-catalog/tree/main/okf) | 谷歌云号 |
| `tools/` | [MCP 磁共振](https://modelcontextprotocol.io/) | 广泛采用 |
| `flows/`, (中文(简体) ), `evals/` | 无一存在——我们的 |  |

为 Claude Code 或 Cursor 所写的技能在此运行, 包括安装在交叉客户端中的技能 `.agents/skills/` 目录,运行时间将同时扫描 `skills/`. 知识 由任何 OKF 生产商导出的捆绑 直接掉入 。 代理前题也 接受Claude Code的子代理字段 所以那些文件大多是按原样运行.

## 流程是一个编号列表

```markdown
1. [[researcher]] — find one topic worth writing about
2. [[writer]]     — draft it
2. [[fixer]]      — fix the technical issues, in parallel
3. [[editor]]     — review both together
   verify: test -s outputs/post.md
```

同一个数字同时运行;不同的数字按顺序运行. 每一组 得到所有的东西,在小组生产之前. `verify:` 意思是贝壳 命令必须退出 0 - _已执行_ 应该是支票通过,不是说模型 停止说话.

## Evals,因为提示 悄悄地倒退

```markdown
## writes for farmers, not gardeners
task: Propose a topic and say who it is for.
expect:
  - not-contains: leverage
  - judge: the intended reader is a working farmer
```

决断主义的检查首先进行;只有模型才能判断他们存活下来的东西. `foldrun eval` 在CI中,你是如何发现一个快速编辑 使事情变得更糟.

除非有其他说法 否则每个Eval都会在每次部署后运行 eval of a(一个) 整个流量每次运行都要花费整个时间——而且可能触及真正的系统——所以标记 这个 `trigger: manual` 它只在一个人问——运行按钮时运行, aPI,或 `foldrun eval`。 。 。 .

## 哪个模特儿,有多难

两个把手,从一个整体的代理 降到一个流动的一步 最近的赢家,跑步追踪名胜者:

```yaml
model: fast        # a tier (fast | default | max), an exact id, or "@preset/…"
effort: high       # low | medium | high | xhigh | max
```

等级使模型重命名时的文件不会被腐烂;精确的id pines 1; 所有土地的同义词( e)`small`, (中文(简体) ), `cheap`, (中文(简体) ), `large`, (中文(简体) ), `best`努力就是我们 正弦轴 - `fast` + 键 `max` 是廉价的模型 告诉它需要时间.

A 类 `provider:` 块指向说 Anthropic 的任何终点的运行时间 Messages API — OpenRouter的Anthropic皮肤通过它运行了400+模型, a 前面的LiteLLM覆盖了其余部分——并重新描绘了这几层的含义:

```yaml
provider:
  base_url: https://openrouter.ai/api
  token: ${OPENROUTER_API_KEY}
  models:
    fast: google/gemini-2.5-flash
```

运行时询问网关每个模型实际能做什么,并使用 答案有三种方式: 其代理人需要工具的步骤失败 **开始时** 编号 无法调用它们的模型(一行,命名最近的可以); `effort:` 与每个模型的辅助水平相接,大声出 而不是一个卖家的桌子 索赔需要时 证明, `foldrun probe <model>` 运行一个真正的工具循环来对抗它- a unce 模型必须从一个工具中获取并回放——通过您的精确 提供者配置 。 该目录是网关的说法;探测器是地面 事实.

## 减记代理主机

**折叠云** 运行您的代理, 所以你不操作他们: 预定和 网路触发器 具有完整历史的持久运行 秘密商店 团队访问, 和你们从未接触过的容器。 按下文件夹,它运行.

CLI 和运行时间从 npm 免费安装, 以及主机 平台导入相同的核心而不是叉. 写作和检查 当地代理人不花费任何费用,也不需要任何账户,即: 宿主,不是它的竞争者.

两者不同的是行动,而不是能力。 本地跑步发生 您的终端; 主机, 它在重启后幸存下来, 重复失败的一步, 等待几天 并告诉你它的成本。 当地人什么也不能阻止 使主机值得购买.

## 这回电,还有其他人

这是 `foldrun-core`: 运行时间, 发布到 npm 为 `@foldrun/core`。 。 。 . 大多数人想要CLI,不是这个包裹.. `npm install -g foldrun`。 。 。 .

| 路径 | 什麽 |
| --- | --- |
| `src/` | 运行时间:剖析、运行、检查、评估 |
| `templates/` | 新工作空间的起点——见下文 |
| `SPEC.md` | 代理和流程格式 |
| `okf/PROFILE.md` | 哪些 OKF 部分已执行 |
| `okf/WHITE-PAPER.md` | 主机 OKF: spec 留给主机的内容 |
| `tests/` | 运行时间测试( e)`npm test`(中文(简体) ) |

命令行工具是它自己的软件包, [`foldrun`](https://www.npmjs.com/package/foldrun),并取决于 这个包裹。 参考文件为 [(原始内容存档于2017-09-26). docs.foldrun.io](https://docs.foldrun.io/)。折叠运行为可用源 根据功能源许可证(见下文"Licence").

### 模板和工作空间

有一个 **一个** 安置工作空间:无论你在哪里工作. `foldrun init` 在您命名的目录中创建一个; 主机平台在下面创建一个 `data/<tenant>/workspaces/<name>/`因为它握住你 秘密、日记和你的探员学到的.

`templates/` 不是第二个工作空间的家。 它坚持着 **起点** ——写出,执入,并运出——你把一个变成工作空间:

```bash
foldrun init my-desk --from templates/hello
foldrun check my-desk
foldrun run note --workspace my-desk
```

`templates/hello` 是两者中较小的,并练习整个格式:a 代理,一个流程,一个技能,一个作为文件夹的脚本工具(`tools/wordcount/` a 包括: `tool.md` 编辑 `run.py` 它召唤,知识 它可能只读,记忆它 写回,并声明它携带到下一个运行. `templates/blog-desk` 实值 真正的办公桌的双代理形状: 研究人员选题,作家 起草它,过 共享的房子风格在 `knowledge/` 以及一个保有 写作.

样板船,所以它必须是正确的,没有任何人运行它: 装入 `templates/` 在每次测试中检查是否符合标准,以及 生成 `index.md` 是被再造的,是比作犯罪的人 手动编辑的模板不能传送与自己的文件不一致的索引.

## 主办

这个软件包就是框架:读取工作空间和 运行它在你的机器上。 平台——仪表板,队列和 它的工人,每个步骤一个沙盒,一个金库,一个计量,一个团队——建在 它,在一个单独的包 插入通过 `src/platform.ts`无 在此仓库中导入它。 这个平台是 [折叠运行平台](https://github.com/foldrun-io/foldrun-platform) 财务报告和审定财务报表 [折叠运行网络](https://github.com/foldrun-io/foldrun-web): 自己运行 带有 Docker 编译器的服务器( S)`foldrun-web/self-hosting`),或使用折叠运行 主办一次; `foldrun deploy` 将工作空间从您的机器移动到任意一个 不变.

## 所需资源

节点22+. Docker或Podman 如果你的特工负责脚本. `foldrun check` 需求 完全没有证书.

改为: _运行_ 你需要的代理人之一:

-   **`ANTHROPIC_API_KEY`** API 密钥,来自 [control.harmanic.com (中文(简体) )](https://console.anthropic.com/)。 。 。 .
-   **`CLAUDE_CODE_OAUTH_TOKEN`** - 克劳德登录符号,来自 `claude setup-token`。当没有设置 API 密钥时使用.
-   **汝自供养.** 一个叫作 `provider:` 需要没有 Anthropic key:29个端点被取名,包括 `ollama`, (中文(简体) ), `lmstudio` 财务报告和审定财务报表 `vllm`,所以一个本地模型是一个完整的答案。 任何东西 不在此列表中以拼写方式工作 `base_url:`, (中文(简体) ), `format:` 财务报告和审定财务报表 `auth:`。见 [供应商](https://docs.foldrun.io/providers)。 。 。 .

第一套被使用, 每一个步骤记录什么。 登录 Claude 密码保存在机器上 永远不会被自己捡到 麻醉不会 除非 Anthropic已经批准了它们, 所以检查这些术语是否涵盖 您之前的使用 您依赖登录符号.

## 版本数

[语义版 2.0.0](https://semver.org/spec/v2.0.0.html): 一个补丁是 错误修复, 未成年人添加一些东西, 什么都没有打破, 重大中断 说点什么 承诺涵盖 **公开 API**,条目 点数 `package.json` 下级 `foldrun.publicApi`数字 : `@foldrun/core` 本身和子路径 `foldrun` 进口CLI。 其他模块 `@foldrun/core/*` 能够到达,因为跑动图像导入了自己的 抄取姓名,但它是内部的,任何发行都可能改变。 折旧 名字在医生评论中说 至少有一个未成年人在少校之前 把他们带走。 预发版在npm的 `next` 标签。 释放如何决定 编号: [捐款额](https://npmcn.com/package/%40foldrun/core/CONTRIBUTING.md#versions)。 。 。 .

## 状态

当地和东道主经营工作。 主机运行通过可耐用的磁盘 队列(幸存者重新启动,公园在批准大门),仪表板有 账户和会话(scrypt + 签名的 cookie; 首个注册是免费的, 然后 `FOLDRUN_OPEN_SIGNUP=1`),每个账户只花在附录中的土地上 分类账(`FOLDRUN_BILLING=1` 使空余额拒绝新运行),a `notify:` 当运行失败或等待时, 在 AGENTS. md 的 Webhokes 中 核准.

团队:一个账户拥有许多用户,加上7天邀请链接 设置。 Webhook URLs 每小时旋转( 生成计数器- 无) 每一件货物,包括被拒绝的,都放在了日志里. 卡片上盖是后面两个Frede REST的电话 `STRIPE_SECRET_KEY`,写 相同的分类账条目 API 操作.

与 `FOLDRUN_RUN_ISOLATION=container` (一个盒子)或 `=k8s` (分组-) 原生跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑跑 每一步都跑在一个硬化的扔出沙盒里 工作空间复制进去, 事件流出, 更改过滤回这样 `knowledge/`、秘密和 运行历史 : CLI 保持进程 运行——在一台笔记本电脑上,没有任何东西可以保护服务器进程不受伤害.

连接涵盖服务如何实际发放证书: API 密钥, API 有 Base URL + 头, SSH( 密钥或密码 ) —— 已实现为 a 准备就绪的包装, `"$NAME" 'uptime'`),浏览器 OAuth 与您自己 客户端、OAuth客户端证书、服务账户(RS256 JWT)和文件 秘密 (0600) (英语). 值在休息时被加密,永远不会到达模型.

内置工具廊船平台维护脚本——首个条目: 无头浏览器( e)`fetch_rendered`),用于制作 Java脚本. 在您的账户库或一个 工作空间;代理商仍然在自己的标记下明确选择.

已知差距:每个数据目录一个平台复制(网络/工人角色) 拆分需要 RWX 存储),和仪表盘运行列表重读运行文件 每个请求(数以千计).

## 许可证

资源来源 [功能源许可证1.1, Apache 2.0 未来 许可证](https://npmcn.com/package/%40foldrun/core/LICENSE) (单位:千美元)`FSL-1.1-ALv2`) (中文(简体) ). 随便怎么用,不给钱 其他作为竞争的商业产品或服务:个人使用和使用 在自己的公司里是免费的,无论大小。 每个版本变为 Apache 2. 0 释放两年后. [释](https://npmcn.com/package/%40foldrun/core/LICENSING.md) 解释什么是 允许和需要商业许可的[哈啰@ troldrun.io](mailto:hello@foldrun.io)),以及哪些 之前的版本运出.

## 常见问题

### @foldrun/core 是什么？

代理只是文件夹。格式，运行程序，检查。

### 如何安装 @foldrun/core？

在项目目录运行 npm install @foldrun/core，或使用 pnpm add / yarn add / bun add。

### @foldrun/core 支持 TypeScript 吗？

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

### @foldrun/core 支持 ESM 还是 CommonJS？

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

### @foldrun/core 需要什么版本的 Node\.js？

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

### @foldrun/core 可以商用吗？

@foldrun/core 使用 FSL-1\.1-ALv2 许可。声明的许可为 FSL-1\.1-ALv2，请阅读许可原文确认使用条件。以上为概括，不构成法律意见，请以许可原文为准。

### @foldrun/core 的下载量有多少？

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

### @foldrun/core 还在维护吗？

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