--- title: Providing Hints to goose sidebar_position: 1 sidebar_label: Using goosehints --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import { PanelLeft } from 'lucide-react'; `.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.

goose Hints Video Walkthrough

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. This guide will walk you through creating and using `.goosehints` files to streamline your workflow with custom instructions and context. :::info Developer extension required To make use of the hints file, you need to have the `Developer` extension [enabled](/docs/getting-started/using-extensions). ::: ## Creating Your Hints File goose supports two types of hint files: - **Global hints file** - These hints will apply to all your sessions with goose, regardless of directory. Global hints are stored in `~/.config/goose/.goosehints`. - **Local hints files** - These hints will only apply when working in a specific directory or directory hierarchy. 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. :::tip Custom Context Files You can use other agent rule files with goose by using the [`CONTEXT_FILE_NAMES` environment variable](#custom-context-files). ::: #### Global hints file 1. Create a `.goosehints` file in `~/.config/goose` #### Local hints file 1. Click the directory path at the bottom of the app and open the directory where you want to create the file 2. Click the button in the top-left to open the sidebar 3. Click `Settings` in the sidebar 4. Click `Chat` 5. Scroll down to the `Project Hints (.goosehints)` section and click `Configure` 6. Enter your local hints in the text area 7. Click `Save` 8. Restart your session so goose can read the updated `.goosehints` If a `.goosehints` file already exists in the given directory, you can edit your existing hints. - **Global hints file** - Create a `.goosehints` file in `~/.config/goose`. - **Local hints file** - Create a `.goosehints` file at the root of your project and/or in any directory in the hierarchy. The `.goosehints` file can include any instructions or contextual details relevant to your projects. ## Setting Up Hints The `.goosehints` file supports natural language. Write clear, specific instructions using direct language that goose can easily understand and follow. Include relevant context about your project and workflow preferences, and prioritize your most important guidelines first. goose loads hints at the start of your session. As it accesses files in nested directories, it also loads the hint files for those directories. goose adds hints to the system prompt for every request. Because `.goosehints` content uses tokens, keeping it concise can reduce cost and improve performance. ### Example Global `.goosehints` File ``` Always use TypeScript for new Next.js projects. @coding-standards.md # Contains our coding standards docs/contributing.md # Contains our pull request process 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. ``` These examples show two ways to reference other files: - **`@` syntax**: Automatically includes the file content in goose's immediate context - **Plain reference**: Points goose to files to review when needed (use for optional or very large files) ### Nested `.goosehints` Files goose supports hierarchical local hints in git repositories. When your session starts, goose loads the configured context files from your working directory up to the repository root. As goose reads or modifies files in nested subdirectories, it can also discover and load additional hint files from those directories automatically. This is especially useful in monorepos or large projects where different parts of the codebase have different conventions. By default, goose looks for both `AGENTS.md` and `.goosehints` at each level. If you're using [custom context files](#custom-context-files), goose applies the same nested loading behavior to those filenames too. As a best practice, `.goosehints` at each level should only include hints relevant to that scope: - **Root level**: Include project-wide standards, build processes, and general guidelines - **Module/feature level**: Add specific requirements for that area of the codebase - **Directory level**: Include very specific context like local testing procedures or component patterns **Example Project Structure:** ```sh my-project/ ├── .git/ ├── .goosehints # Project-wide hints ├── frontend/ │ ├── .goosehints # Frontend-specific hints │ └── components/ │ ├── .goosehints # Component-specific hints │ └── Button.tsx └── backend/ ├── .goosehints # Backend-specific hints └── api/ └── routes.py ``` If you start goose in `my-project/`, the root-level hints are loaded immediately. Later, when goose accesses files under `frontend/components/`, it loads the nested hints for that path and combines them in the following order: 1.

`my-project/.goosehints` (project root)

``` This is a React + TypeScript project using Vite. @README.md # Project overview and setup instructions @docs/development-setup.md # Development environment configuration Always run tests before committing: `npm test` Use conventional commits for all changes. ```

`frontend/.goosehints`

``` This frontend uses React 18 with TypeScript and Tailwind CSS. @package.json # Dependencies and scripts @docs/frontend-architecture.md # Frontend structure and patterns ## Development Standards - Use functional components with hooks (no class components) - Implement proper TypeScript interfaces for all props - Follow the component structure: /components/ComponentName/index.tsx - Use Tailwind classes instead of custom CSS when possible ## Testing Requirements - Write unit tests for all components using React Testing Library - Test files should be co-located: ComponentName.test.tsx - Run `npm run test:frontend` before committing changes ## State Management - Use React Query for server state - Use Zustand for client state management - Avoid prop drilling - lift state appropriately Always confirm UI changes with design team before implementation. ```

`frontend/components/.goosehints` (current directory)

``` Components in this directory use our design system. @docs/component-api.md # Component interface standards and examples All components must: - Export a default component - Include TypeScript props interface - Have corresponding .test.tsx file - Follow naming convention: PascalCase ```

:::note After nested hints are loaded for a directory, they remain active for the rest of the session. If you update a hint file and want goose to pick up the new content reliably, restart the session. ::: ## 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`, `docs/setup-guide.md`, or others that goose should consult for detailed explanations. - **Organize with @-mentions**: For frequently-needed documentation, use `@filename.md` or `@relative/path/testing.md` to automatically include file content in your current context instead of just referencing it. This ensures goose has immediate access to important information. Include core documentation (like API schemas or coding standards) with @-mentions for immediate context, but use plain references (without `@`) for optional or very large files. 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 files updated**: Regularly update the `.goosehints` files 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. - **Reference other files**: Point goose to relevant files like /docs/style.md or /scripts/validation.js to reduce repetition and keep instructions lightweight. ## Custom Context Files goose looks for `AGENTS.md` then `.goosehints` files by default, but you can configure a different filename or multiple context files using the `CONTEXT_FILE_NAMES` environment variable. This is useful for: - **Tool compatibility**: Use conventions from other AI tools (e.g. `CLAUDE.md`) - **Organization**: Separate frequently-used rules into multiple files that load automatically - **Project conventions**: Use context files from your project's established toolchain (`.cursorrules`) Here's how it works: 1. goose looks for each configured filename in both global (`~/.config/goose/`) and local project locations 2. At session start, goose loads matching files from your working directory hierarchy 3. During the session, goose can load additional matching files when it accesses nested subdirectories 4. All found files are loaded and combined into the context ### Configuration Set the `CONTEXT_FILE_NAMES` environment variable to a JSON array of filenames. The default is `["AGENTS.md", ".goosehints"]`. ```bash # Single custom file export CONTEXT_FILE_NAMES='["AGENTS.md"]' # Project toolchain files export CONTEXT_FILE_NAMES='[".cursorrules", "AGENTS.md"]' # Multiple files export CONTEXT_FILE_NAMES='["CLAUDE.md", ".goosehints", "project_rules.txt"]' ```