EN

使用 Agent 操作 Func

了解如何让 Agent 创建 Func 项目、完成日常开发、优化结构或补充测试。

更新于

下面的任务覆盖项目创建、日常功能开发、结构整理和测试。Agent 组件会将完整提示词发送给所选应用,你也可以复制提示词并按项目需求修改。

创建一个新的 func 项目

适合的场景

这个场景适合第一次使用 func 的开发者,也适合希望在现有 monorepo 中快速建立独立 CLI package 的团队。只需要在编码 Agent 中打开目标仓库,无需手动逐项检查 Node.js、包管理器或 workspace 配置。

让 Agent 创建 Func 项目
在当前仓库创建并验证固定名为 func-example 的可运行项目。
请先阅读 https://func.witt.im/setup.txt 和当前仓库中的项目指引。 在当前仓库创建 func-example CLI 项目。选择合适的目录和包管理器,必要时安装环境和项目依赖,并运行默认命令验证。最后说明改动和结果。

常见开发场景

适合的场景

这个场景适合已经可以运行的 func 项目。把预期调用方式、必填字段、条件分支和测试要求写清楚,Agent 就可以按现有结构完成标准开发。下面两个任务以 ship create 为例,可以直接使用,也可以替换成自己的命令和业务行为。

让 Agent 添加 create 命令
添加 ship create --file document.txt,并将 file 声明为必填文件路径。
请先阅读 https://func.witt.im/rules.txt 和当前仓库中的项目指引。 为当前 Func CLI 添加 ship create --file document.txt。--file 必填;创建文件,并为无效路径或已有文件返回清晰错误。按现有结构实现,测试成功和缺少 --file 两种情况,然后运行相关检查。
让 Agent 添加 --ensure 选项
为 create 命令添加 --ensure,只有显式启用时才执行文件写入。
请先阅读 https://func.witt.im/rules.txt 和当前仓库中的项目指引。 为 create 添加 --ensure。传入时创建文件;未传入时只输出目标路径。测试两个分支,保持其他行为不变,并运行相关检查。

优化已有 func 项目结构

适合的场景

这个场景面向已经维护 func 项目的开发者。当命令越来越多、处理器中混入大量业务逻辑,或源码与生成产物混在一起时, 可以让 Agent 在不改变 CLI 行为的前提下整理结构。

让 Agent 优化 Func 项目结构
保持命令行为和输出不变,重新整理入口、模块、命令与服务的职责。
请先阅读 https://func.witt.im/rules.txt 和当前仓库中的项目指引。 在不改变命令、输出和 scripts 的前提下,按 rules.txt 整理当前 Func 项目的入口、模块、命令、服务和生成产物。同步修正 import、模块注册和测试路径,运行相关检查并说明结果。

为命令补充测试用例

适合的场景

这个场景适合正在增加命令、准备发布版本或完成结构调整的维护者。它关注你的 CLI 向使用者承诺的行为,而不是重新测试 func 框架内部实现,因此也适合作为团队合并代码前的回归保护。

让 Agent 补充 CLI 测试
从用户视角补齐命令、别名、选项约束与失败行为的验收覆盖。
请先阅读 https://func.witt.im/rules.txt 和当前仓库中的项目指引。 检查当前命令和测试,补齐命令路径、别名、成功输出、选项约束及应用错误的用户行为测试。优先使用 func/testing,断言退出码与稳定输出;运行相关测试并说明结果。

参考

你也可以直接让 AI 阅读 llms.txt,再根据其中的文档入口查找相关能力并完成开发。对于常见的项目创建、命令、选项、校验和测试需求,这通常可以解决绝大多数问题。