mirror of
https://github.com/aljazceru/goose.git
synced 2025-12-17 14:14:26 +01:00
9b605dbdd7
Co-authored-by: John Austin <jaustin@squareup.com> Co-authored-by: Kalvin C <kalvinnchau@users.noreply.github.com>
69 lines
2.7 KiB
Markdown
69 lines
2.7 KiB
Markdown
---
|
|
title: Prevent Goose from Accessing Files
|
|
sidebar_label: Using Gooseignore
|
|
sidebar_position: 14
|
|
---
|
|
|
|
|
|
`.gooseignore` is a text file that defines patterns for files and directories that Goose will not access. This means Goose cannot read, modify, delete, or run shell commands on these files when using the Developer extension's tools.
|
|
|
|
:::info Developer extension only
|
|
The .gooseignore feature currently only affects tools in the [Developer](/docs/tutorials/developer-mcp) extension. Other extensions are not restricted by these rules.
|
|
:::
|
|
|
|
This guide will show you how to use `.gooseignore` files to prevent Goose from changing specific files and directories.
|
|
|
|
## Creating your `.gooseignore` file
|
|
|
|
Goose supports two types of `.gooseignore` files:
|
|
- **Global ignore file** - Create a `.gooseignore` file in `~/.config/goose`. These restrictions will apply to all your sessions with Goose, regardless of directory.
|
|
- **Local ignore file** - Create a `.gooseignore` file at the root of the directory you'd like it applied to. These restrictions will only apply when working in a specific directory.
|
|
|
|
:::tip
|
|
You can use both global and local `.gooseignore` files simultaneously. When both exist, Goose will combine the restrictions from both files to determine which paths are restricted.
|
|
:::
|
|
|
|
## Example `.gooseignore` file
|
|
|
|
In your `.gooseignore` file, you can write patterns to match files you want Goose to ignore. Here are some common patterns:
|
|
|
|
```plaintext
|
|
# Ignore specific files by name
|
|
settings.json # Ignore only the file named "settings.json"
|
|
|
|
# Ignore files by extension
|
|
*.pdf # Ignore all PDF files
|
|
*.config # Ignore all files ending in .config
|
|
|
|
# Ignore directories and their contents
|
|
backup/ # Ignore everything in the "backup" directory
|
|
downloads/ # Ignore everything in the "downloads" directory
|
|
|
|
# Ignore all files with this name in any directory
|
|
**/credentials.json # Ignore all files named "credentials.json" in any directory
|
|
|
|
# Complex patterns
|
|
*.log # Ignore all .log files
|
|
!error.log # Except for error.log file
|
|
```
|
|
|
|
## Default patterns
|
|
|
|
By default, if you haven't created any `.gooseignore` files, Goose will not modify files matching these patterns:
|
|
|
|
```plaintext
|
|
**/.env
|
|
**/.env.*
|
|
**/secrets.*
|
|
```
|
|
|
|
## Common use cases
|
|
|
|
Here are some typical scenarios where `.gooseignore` is helpful:
|
|
|
|
- **Generated Files**: Prevent Goose from modifying auto-generated code or build outputs
|
|
- **Third-Party Code**: Keep Goose from changing external libraries or dependencies
|
|
- **Important Configurations**: Protect critical configuration files from accidental modifications
|
|
- **Version Control**: Prevent changes to version control files like `.git` directory
|
|
|