Skip to main content

Providing Hints to Goose

.goosehints is a text file used to provide additional context about your project and improve the communication with Goose. The use of goosehints ensures that Goose understands your requirements better and can execute tasks more effectively.

Developer extension required

To make use of the hints file, you need to have the Developer extension enabled.

This guide will walk you through creating and using your .goosehints file to streamline your workflow with custom instructions and context.

Creating your hints file​

Goose supports two types of hint files:

  • Global hints file - Create a .goosehints file in ~/.config/goose. These hints will apply to all your sessions with Goose, regardless of directory.
  • Local hints file - Create a .goosehints file at the root of your project directory. These hints will only apply when working in that specific directory.
tip

You can use both global and local hints at the same time. When both exist, Goose will consider both your global preferences and project-specific requirements. If the instructions in your local hints file conflict with your global preferences, Goose will prioritize the local hints.

The .goosehints file can include any instructions or contextual details relevant to your projects.

A good time to consider adding a .goosehints file is when you find yourself repeating prompts, or providing the same kind of instructions multiple times. It's also a great way to provide a lot of context which might be better suited in a file.

Setting up hints​

The .goosehints file supports natural language.

Example global .goosehints file​

Always use TypeScript for new Next.js projects.

Follow the [Google Style Guide](https://google.github.io/styleguide/pyguide.html) for Python code.

Run unit tests before committing any changes.

Prefer functional programming patterns where applicable.

Example local .goosehints file​

This is a simple example JavaScript web application that uses the Express.js framework. View [Express documentation](https://expressjs.com/) for extended guidance.

Go through the README.md for information on how to build and test it as needed.

Make sure to confirm all changes with me before applying.

Run tests with `npm run test` ideally after each change.

Common use cases​

Here are some ways people have used hints to provide additional context to Goose:

  • Decision-Making: Specify if Goose should autonomously make changes or confirm actions with you first.

  • Validation Routines: Provide test cases or validation methods that Goose should perform to ensure changes meet project specifications.

  • Feedback Loop: Include steps that allow Goose to receive feedback and iteratively improve its suggestions.

  • Point to more detailed documentation: Indicate important files like README.md, CONTRIBUTING.md, or others that Goose should consult for detailed explanations.

Like prompts, this is not an extensive list to shape your .goosehints file. You can include as much context as you need.

Best practices​

  • Keep file updated: Regularly update the .goosehints file to reflect any changes in project protocols or priorities.
  • Be concise: Make sure the content is straightforward and to the point, ensuring Goose can quickly parse and act on the information.
  • Start small: Create a small set of clear, specific hints and gradually expand them based on your needs. This makes it easier to understand how Goose interprets and applies your instructions.