如何在 Goose 中使用'plan.md”创建自定义计划

Patricia Arquette
发布: 2024-11-20 12:40:18
原创
843 人浏览过

How to Create Custom Plans with “plan.md” in Goose

什么是鹅?
Goose 是一种开发人员代理,可通过在终端或 IDE 中自动执行编码任务来增强软件开发。在您输入的指导下,它会智能地分析您的项目需求,生成必要的代码,并自主实施更改。在与 Goose 合作时,采用结构化方法来指导其执行以实现特定目标至关重要。这就是 plan.md 文件的用武之地。 plan.md 文件允许您为 Goose 定义自定义计划,使用灵活的文本格式和 Jinja 模板的强大功能来创建动态、可重用且面向目标的计划。

如何设置 Goose
在创建自定义 plan.md 文件之前,您需要设置 Goose。

第 1 步: 在 GitHub 上分叉 Goose 和 Goose 插件存储库并克隆它们。

第2步:安装Homebrew — 访问brew.sh并按照安装步骤操作,或运行:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
登录后复制
登录后复制

第 3 步: 要安装 Goose,请使用 pipx。首先确保 pipx 已安装:

brew install pipx
pipx ensurepath
登录后复制
登录后复制

第四步:然后安装Goose:

pipx install goose-ai
登录后复制
登录后复制

第 5 步: 启动会话 — 从您的终端导航到您要启动的目录并运行:

goose session start
登录后复制
登录后复制

Goose 与您首选的法学硕士合作。默认情况下,它使用 openai 作为 LLM 提供者。系统会提示您设置 API 密钥。

什么是“plan.md”文件?

plan.md 文件是一个文本文件,用作 Goose 遵循的蓝图。它由两个基本组成部分组成:

A kickoff message that sets the context and overall goal
A structured list of tasks for Goose to execute.
登录后复制

为什么使用 plan.md 文件?

  • 定制:
    您可以针对特定任务或项目定制 Goose 的操作。

  • 可重复使用性:
    模板可以轻松地重复使用和修改类似目标的计划。

  • 清晰度:
    概述目标和步骤可确保更好的控制和可预测性。

创建您的第一个 plan.md 文件

假设您希望 Goose 帮助建立一个新的设计系统。以下是您的 plan.md 的示例:

Your goal is to set up a fresh design system for our app's redesign.

- Create folders for design components (buttons, forms, colors)
- Set up color palette based on brand guidelines
- Create typography styles for headings and body text
- Design basic button components with all states
- Create form elements (inputs, dropdowns)
登录后复制

看到任务中每行开头的那些破折号 (-) 了吗?超级重要! Goose 会寻找这些信息来了解它需要采取哪些步骤。要使用此计划运行 Goose:

goose session start --plan plan.md
登录后复制

在计划中使用 Jinja 模板
Jinja 是一个模板引擎,允许您直接在文本文件中嵌入变量、循环和条件。使用 Jinja,您可以使 plan.md 文件变得动态且适应性强。

Key Jinja 语法

  • 变量: {{ 变量 }}

  • 循环: {% for item in list %}...{% endfor %}

  • 条件: {% if condition %}...{% endif %}

记住我们的 plan.md 文件,这是使用 jinja 模板的增强版本的样子。

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
登录后复制
登录后复制

将参数传递给计划
执行期间可以将参数传递到 plan.md 文件中。例如,为了使我们的设计系统设置计划动态且可重用,我们使用 Jinja 模板,它允许我们传递根据特定项目、品牌或设计要求定制内容的参数。通过传递不同的参数集,我们可以轻松地为任何重新设计或产品生成个性化计划。

示例:与 Jinja 传递参数

定义数据:第一步是准备要传递到模板中的数据。这包括品牌名称、颜色、排版风格和其他设计特定细节等值。

brew install pipx
pipx ensurepath
登录后复制
登录后复制

要使用此计划和参数运行 Goose,您将运行以下命令:

pipx install goose-ai
登录后复制
登录后复制

Goose 将使用这些值填充 plan.md 中的占位符。

goose session start
登录后复制
登录后复制

最佳实践和提示

  • 定义明确的目标:确保每个计划都以明确的目标开始。
  • 使用可重用模板:创建可以针对不同项目自定义的通用模板。
  • 文档假设:添加注释或注释来解释占位符和结构。
  • 测试小更改:验证 plan.md 文件中的每个更改以确保正确渲染。

结论
plan.md 文件是一个多功能工具,用于指导 Goose 的执行以实现您的目标。通过结合明确的目标、结构化的步骤和动态 Jinja 模板,您可以创建可重用且高度可定制的计划。无论您是要改进移动应用程序的用户体验还是处理复杂的项目,plan.md 都可以帮助您为 Goose 提供清晰度、适应性和精确性。

以上是如何在 Goose 中使用'plan.md”创建自定义计划的详细内容。更多信息请关注PHP中文网其他相关文章!

来源:dev.to
本站声明
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板