跳转到内容

输入关键词开始搜索文档。

CLI

最后更新 查看 Markdown 源文件

flue CLI 以 @flue/cli 包的形式发布,作为一个单独的 flue 二进制文件。它用于初始化项目、在本地运行单个智能体模块、获取集成蓝图,以及阅读随安装版本捆绑的文档。

CLI 不是构建工具。开发服务器和生产构建由 Vite 管理:vite dev 和 vite build,配合 vite.config.ts 中来自 @flue/vite 的 flue() 插件。

调用方式

@flue/cli 需要 Node.js 22.19 或更高版本。flue init 会将其作为 devDependency 进行初始化,入门指南 会将其与 @flue/runtime 一起安装:

npm install @flue/runtime @flue/cli

然后可以通过包管理器的运行器(npx flue、pnpm flue、yarn flue)或 package.json 脚本来使用 flue 二进制文件:

npx flue run src/agents/assistant.ts -m "Say hello"

命令

  • flue init [directory] — 初始化一个 Flue 项目脚手架,省略标志时会提示选择构建目标和服务器设置。
  • flue run <path> — 在本地运行单个智能体模块,无需服务器:提交一条消息,流式传输轮次,打印回复,然后退出。
  • flue add [kind] [name|url] — 获取蓝图实现指南供编码智能体遵循;不带参数时,列出可用的蓝图。
  • flue update <kind> <name|url> — 获取更新现有集成的蓝图指南。
  • flue docs [read|search] — 列出捆绑的文档页面,将某个页面以 markdown 形式打印,或进行搜索。

每个命令页面都是该命令的参数、标志和输出的参考文档。每个命令将其主要内容打印到 stdout,其他所有内容(提示、流式输出、错误)打印到 stderr,因此管道传输 stdout 始终是安全的。

全局标志

标志描述
--help, -h将用法说明打印到 stdout 并以退出码 0 退出。可全局使用,也可按命令使用(flue run --help)。
--version, -v将 @flue/cli 版本号打印到 stdout 并以退出码 0 退出。

没有其他全局标志;每个命令会拒绝未声明的标志。