tkmind/tkmind_go
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

docs: lowercase goose in getting-started and guides topics (#5857)

Browse Source 
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This commit is contained in:
dianed-square
2025-11-24 10:17:22 -08:00
committed by GitHub
parent 3e9d9c7b2c
commit b357e99b30
26 changed files with 279 additions and 279 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/docs/guides/using-gooseignore.md
+16 -16
View File
@@ -1,31 +1,31 @@
---
title: Prevent Goose from Accessing Files
sidebar_label: Using Gooseignore
title: Prevent goose from Accessing Files
sidebar_label: Using gooseignore
sidebar_position: 80
---
`.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.
`.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/mcp/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.
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.
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.
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:
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
@@ -48,7 +48,7 @@ downloads/ # Ignore everything in the "downloads" directory
```
## Ignore File Types and Priority
Goose respects ignore rules from three sources: global `.gooseignore`, local `.gooseignore`, and `.gitignore`. It uses a priority system to determine which files should be ignored.
goose respects ignore rules from three sources: global `.gooseignore`, local `.gooseignore`, and `.gitignore`. It uses a priority system to determine which files should be ignored.
### 1. Global `.gooseignore`
- Highest priority and always applied first
@@ -77,17 +77,17 @@ Project/
### 3. `.gitignore` Fallback
- Used when no local `.gooseignore` exists
- Goose automatically uses your `.gitignore` rules
- goose automatically uses your `.gitignore` rules
- If a global `.gooseignore` file exists, those rules will be applied in addition to the `.gitignore` patterns.
```
Project/
├── .gitignore ← Used by Goose (when no local .gooseignore)
├── .gitignore ← Used by goose (when no local .gooseignore)
└── src/
```
### 4. Default Patterns
By default, if you haven't created any .gooseignore files and no .gitignore file exists, Goose will not modify files matching these patterns:
By default, if you haven't created any .gooseignore files and no .gitignore file exists, goose will not modify files matching these patterns:
```plaintext
**/.env
**/.env.*
@@ -98,9 +98,9 @@ By default, if you haven't created any .gooseignore files and no .gitignore file
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
- **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
- **Existing Projects**: Most projects already have `.gitignore` files that work automatically as ignore patterns for Goose
- **Custom Restrictions**: Create `.gooseignore` when you need different patterns than your `.gitignore` (e.g., allowing Goose to read files that Git ignores)
- **Existing Projects**: Most projects already have `.gitignore` files that work automatically as ignore patterns for goose
- **Custom Restrictions**: Create `.gooseignore` when you need different patterns than your `.gitignore` (e.g., allowing goose to read files that Git ignores)