Goose is a local AI agent developed by Block, Inc., designed to automate engineering and development workflows directly on your machine. | https://block.github.io/goose
1.1 Usage
Method 1: Built-in OpenAI Provider
Set environment variables to point Goose to your OpenAI-compatible endpoint:
export OPENAI_API_KEY="your-rygen-api-key"
export OPENAI_HOST="https://api.rygen.io/v1"
export GOOSE_PROVIDER="openai"
export GOOSE_MODEL="your-model-name"Restart Goose and verify:
goose info -vTo persist settings, edit:
- macOS/Linux:
~/.config/goose/config.yaml - Windows:
%APPDATA%\Block\goose\config\config.yaml
Method 2: Custom Provider
Create a custom provider file:
- macOS/Linux:
~/.config/goose/custom_providers/ - Windows:
%APPDATA%\Block\goose\config\custom_providers\
For Example:
{
"name": "rygen",
"engine": "openai",
"display_name": "Rygen API",
"api_key_env": "RYGEN_API_KEY",
"base_url": "https://api.rygen.io/v1",
"models": [
{
"name": "your-model-name",
"context_limit": 128000
}
]
}Then activate it:
export RYGEN_API_KEY="your-rygen-api-key"
export GOOSE_PROVIDER="rygen"
export GOOSE_MODEL="your-model-name"1.2 Notes
- You can add custom headers in CLI or by editing the provider file
- If using the built-in OpenAI provider (
OPENAI_HOST), keep:GOOSE_PROVIDER="openai"
- Use a custom provider name (e.g.,
rygen) only after creating a custom provider with that exact name.