Home Backend Development Python Tutorial How to Create Custom Plans with 'plan.md” in Goose

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

Nov 20, 2024 pm 12:40 PM

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

What is Goose?
Goose is a developer agent that enhances software development by automating coding tasks within your terminal or IDE. Guided by your input, it intelligently analyzes your project’s needs, generates the necessary code, and implements changes autonomously. When working with Goose, having a structured way to guide its execution toward specific goals is essential. This is where the plan.md file comes in. A plan.md file allows you to define a customized plan for Goose, using flexible text formatting and the power of Jinja templating to create dynamic, reusable, and goal-oriented plans.

How to Set Up Goose
Before creating your custom plan.md file, you need to set up Goose.

Step1: Fork the Goose and Goose Plugin repositories on GitHub and clone them.

Step2: Install Homebrew — Visit brew.sh and follow the installation steps, or run:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Copy after login
Copy after login

Step3: To install Goose, use pipx. First ensure pipx is installed:

brew install pipx
pipx ensurepath
Copy after login
Copy after login

Step4: Then install Goose:

pipx install goose-ai
Copy after login
Copy after login

Step 5: Start a session — From your terminal, navigate to the directory you’d like to start from and run:

goose session start
Copy after login
Copy after login

Goose works with your preferred LLM. By default, it uses openai as the LLM provider. You'll be prompted to set an API key.

What Are “plan.md”Files?

The plan.md file is a text file that serves as a blueprint for Goose to follow. It consists of two essential components:

A kickoff message that sets the context and overall goal
A structured list of tasks for Goose to execute.
Copy after login

Why Use plan.md file?

  • Customization:
    You can tailor Goose’s actions for specific tasks or projects.

  • Reusability:
    Templates make it easy to reuse and modify plans for similar goals.

  • Clarity:
    Outlining goals and steps ensures better control and predictability.

Creating Your First plan.md File

Let’s say you want Goose to help set up a new design system. Here’s an example of how your plan.md might look:

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)
Copy after login

See those dashes (-) at the start of each line in the tasks? Super important! Goose looks for these to understand what steps it needs to take. To run Goose with this plan:

goose session start --plan plan.md
Copy after login

Using Jinja Templating in Plans
Jinja is a templating engine that allows you to embed variables, loops, and conditionals directly in your text files. With Jinja, you can make plan.md files dynamic and adaptable.

Key Jinja Syntax

  • Variables: {{ variable }}

  • Loops: {% for item in list %}...{% endfor %}

  • Conditionals: {% if condition %}...{% endif %}

Remember our plan.md file, here’s what an enhanced version using jinja templating would look like.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
Copy after login
Copy after login

Passing Arguments to Plan
Arguments can be passed into a plan.md file during execution. For example, to make our design system setup plan dynamic and reusable, we use Jinja templating, which allows us to pass arguments that customize the content based on specific projects, brands, or design requirements. By passing different sets of arguments, we can easily generate personalized plans for any redesign or product.

Example: Passing Arguments with Jinja

Define the Data: The first step is to prepare the data you want to pass into the template. This includes values like the brand name, colors, typography styles, and other design-specific details.

brew install pipx
pipx ensurepath
Copy after login
Copy after login

To run Goose with this plan and arguments, you would run the following command:

pipx install goose-ai
Copy after login
Copy after login

Goose will populate the placeholders in plan.md with these values.

goose session start
Copy after login
Copy after login

Best Practices and Tips

  • Define Clear Goals: Ensure each plan starts with a clear objective.
  • Use Reusable Templates: Create general templates that can be customized for different projects.
  • Document Assumptions: Add comments or notes to explain placeholders and structure.
  • Test Small Changes: Validate each change in the plan.md file to ensure correct rendering.

Conclusion
The plan.md file is a versatile tool for guiding Goose's execution in achieving your goals. By combining clear objectives, structured steps, and dynamic Jinja templating, you can create reusable and highly customizable plans. Whether you're improving a mobile app's UX or tackling a complex project, plan.md empowers you to provide clarity, adaptability, and precision to Goose.

The above is the detailed content of How to Create Custom Plans with 'plan.md” in Goose. For more information, please follow other related articles on the PHP Chinese website!

Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
1 months ago By 尊渡假赌尊渡假赌尊渡假赌
R.E.P.O. Best Graphic Settings
1 months ago By 尊渡假赌尊渡假赌尊渡假赌
Will R.E.P.O. Have Crossplay?
1 months ago By 尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Notepad++7.3.1

Notepad++7.3.1

Easy-to-use and free code editor

SublimeText3 Chinese version

SublimeText3 Chinese version

Chinese version, very easy to use

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

How to solve the permissions problem encountered when viewing Python version in Linux terminal? How to solve the permissions problem encountered when viewing Python version in Linux terminal? Apr 01, 2025 pm 05:09 PM

Solution to permission issues when viewing Python version in Linux terminal When you try to view Python version in Linux terminal, enter python...

How to efficiently copy the entire column of one DataFrame into another DataFrame with different structures in Python? How to efficiently copy the entire column of one DataFrame into another DataFrame with different structures in Python? Apr 01, 2025 pm 11:15 PM

When using Python's pandas library, how to copy whole columns between two DataFrames with different structures is a common problem. Suppose we have two Dats...

How to teach computer novice programming basics in project and problem-driven methods within 10 hours? How to teach computer novice programming basics in project and problem-driven methods within 10 hours? Apr 02, 2025 am 07:18 AM

How to teach computer novice programming basics within 10 hours? If you only have 10 hours to teach computer novice some programming knowledge, what would you choose to teach...

How to avoid being detected by the browser when using Fiddler Everywhere for man-in-the-middle reading? How to avoid being detected by the browser when using Fiddler Everywhere for man-in-the-middle reading? Apr 02, 2025 am 07:15 AM

How to avoid being detected when using FiddlerEverywhere for man-in-the-middle readings When you use FiddlerEverywhere...

What are regular expressions? What are regular expressions? Mar 20, 2025 pm 06:25 PM

Regular expressions are powerful tools for pattern matching and text manipulation in programming, enhancing efficiency in text processing across various applications.

What are some popular Python libraries and their uses? What are some popular Python libraries and their uses? Mar 21, 2025 pm 06:46 PM

The article discusses popular Python libraries like NumPy, Pandas, Matplotlib, Scikit-learn, TensorFlow, Django, Flask, and Requests, detailing their uses in scientific computing, data analysis, visualization, machine learning, web development, and H

How does Uvicorn continuously listen for HTTP requests without serving_forever()? How does Uvicorn continuously listen for HTTP requests without serving_forever()? Apr 01, 2025 pm 10:51 PM

How does Uvicorn continuously listen for HTTP requests? Uvicorn is a lightweight web server based on ASGI. One of its core functions is to listen for HTTP requests and proceed...

How to dynamically create an object through a string and call its methods in Python? How to dynamically create an object through a string and call its methods in Python? Apr 01, 2025 pm 11:18 PM

In Python, how to dynamically create an object through a string and call its methods? This is a common programming requirement, especially if it needs to be configured or run...

See all articles