docs: custom context files improvements (#4096)
This commit is contained in:
@@ -134,7 +134,7 @@ export GOOSE_MAX_TURNS=25
|
|||||||
export GOOSE_MAX_TURNS=100
|
export GOOSE_MAX_TURNS=100
|
||||||
|
|
||||||
# Use multiple context files
|
# Use multiple context files
|
||||||
export CONTEXT_FILE_NAMES='["CLAUDE.md", ".goosehints", "project_rules.txt"]'
|
export CONTEXT_FILE_NAMES='["CLAUDE.md", ".goosehints", ".cursorrules", "project_rules.txt"]'
|
||||||
|
|
||||||
# Set the ANSI theme for the session
|
# Set the ANSI theme for the session
|
||||||
export GOOSE_CLI_THEME=ansi
|
export GOOSE_CLI_THEME=ansi
|
||||||
|
|||||||
@@ -339,7 +339,7 @@ You can turn your current Goose session into a reusable recipe that includes the
|
|||||||
|
|
||||||
**Basic Usage** - Run once and exit (see [run options](/docs/guides/goose-cli-commands#run-options) and [recipe commands](/docs/guides/goose-cli-commands#recipe) for more):
|
**Basic Usage** - Run once and exit (see [run options](/docs/guides/goose-cli-commands#run-options) and [recipe commands](/docs/guides/goose-cli-commands#recipe) for more):
|
||||||
```sh
|
```sh
|
||||||
# Using recipe file in current directory or GOOSE_RECIPE_PATH directories
|
# Using recipe file in current directory or `GOOSE_RECIPE_PATH` directories
|
||||||
goose run --recipe recipe.yaml
|
goose run --recipe recipe.yaml
|
||||||
|
|
||||||
# Using full path
|
# Using full path
|
||||||
|
|||||||
@@ -37,8 +37,8 @@ Goose supports two types of hint files:
|
|||||||
|
|
||||||
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.
|
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 File
|
:::tip Custom Context Files
|
||||||
You can [customize context file names](#custom-context-files) using the `CONTEXT_FILE_NAMES` environment variable.
|
You can use other agent rule files with Goose by using the [`CONTEXT_FILE_NAMES` environment variable](#custom-context-files).
|
||||||
:::
|
:::
|
||||||
|
|
||||||
<Tabs groupId="interface">
|
<Tabs groupId="interface">
|
||||||
@@ -143,12 +143,15 @@ Here's how it works:
|
|||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
Set the `CONTEXT_FILE_NAMES` environment variable to a JSON array of filenames. If not set, it defaults to `[".goosehints"]`.
|
Set the `CONTEXT_FILE_NAMES` environment variable to a JSON array of filenames. The default is `[".goosehints"]`.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Single custom file
|
# Single custom file
|
||||||
export CONTEXT_FILE_NAMES='["AGENTS.md"]'
|
export CONTEXT_FILE_NAMES='["AGENTS.md"]'
|
||||||
|
|
||||||
# Multiple files (loaded in order)
|
# Project toolchain files
|
||||||
|
export CONTEXT_FILE_NAMES='[".cursorrules", "AGENTS.md"]'
|
||||||
|
|
||||||
|
# Multiple files
|
||||||
export CONTEXT_FILE_NAMES='["CLAUDE.md", ".goosehints", "project_rules.txt"]'
|
export CONTEXT_FILE_NAMES='["CLAUDE.md", ".goosehints", "project_rules.txt"]'
|
||||||
```
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user