项目布局
最后更新 查看 Markdown 源文件
Flue 对文件和文件夹布局几乎没有必需的约定。以下示例展示了单智能体和多智能体项目的推荐结构。
示例智能体代码库
my-project/
├─ src/ # 源代码目录
│ ├─ app.ts # 服务器和路由器入口点(必需)
│ ├─ db.ts # 数据库配置(可选)
│ ├─ cloudflare.ts # Cloudflare 特定入口点(可选)
│ ├─ agent.ts
│ ├─ skills/...
│ ├─ tools/...
│ ├─ subagents/...
│ └─ channels/...
├─ package.json # npm 项目配置
├─ vite.config.ts # Vite 配置(可选)
└─ flue.config.ts # Flue 项目配置(可选)
示例多智能体代码库
my-project/
├─ src/ # 源代码目录
│ ├─ app.ts # 服务器和路由器入口点(必需)
│ ├─ db.ts # 数据库配置(可选)
│ ├─ cloudflare.ts # Cloudflare 特定入口点(可选)
│ └─ agents/
│ ├─ support-agent/
│ │ ├─ skills/...
│ │ ├─ tools/...
│ │ ├─ subagents/...
│ │ ├─ channels/...
│ │ └─ agent.ts
│ ├─ triage-agent/
│ └─ shared/
├─ package.json # npm 项目配置
├─ vite.config.ts # Vite 配置(可选)
└─ flue.config.ts # Flue 项目配置(可选)
顶层文件
| 路径 | 用途 |
|---|---|
flue.config.ts | Flue 项目配置。可选。 |
vite.config.ts | Vite 构建和开发服务器配置。可选。 |
src/app.ts | 应用路由映射和服务器入口点。必需。 |
src/db.ts | 数据库配置。可选。 |
src/cloudflare.ts | Cloudflare 入口点配置。可选。 |
源代码目录
src/ 是新 Flue 项目的规范源代码目录。将 Flue 集成到另一个应用或维护现有布局时,编写的模块可以改为放在 .flue/ 或项目根目录。Flue 按以下顺序选择一个源代码目录:
.flue/——较大应用内的独立 Flue 源代码区域。src/(推荐) ——新项目的推荐布局。- 项目根目录——小型专用项目的紧凑布局。
第一个匹配的目录获胜。Flue 不会合并布局:当 .flue/ 存在时,app.ts、db.ts、cloudflare.ts 和 'use agent' 扫描都从它解析,而非从 src/ 或项目根目录。编写的模块仍然可以从项目其他地方导入普通的辅助代码。
入口模块路径(app.ts、db.ts、cloudflare.ts)可以在 flue.config.ts 文件中显式配置。参见配置了解更多详情。
生成的输出
dist/ 是运行 vite build 时的默认构建输出目录。你可以在 vite.config.ts 文件中自定义它。