Frequently Asked Questions

# macOS/Linux
curl -fsSL https://github.com/block/goose/releases/latest/download/goose-install.sh | sh

# Windows (PowerShell)
irm https://github.com/block/goose/releases/latest/download/goose-install.ps1 | iex

git clone https://github.com/block/goose.git
cd goose
source bin/activate-hermit
cargo build --release

goose configure

export OPENAI_API_KEY="your-key-here"
export ANTHROPIC_API_KEY="your-key-here"

# Start a new interactive session
goose session

# Resume a previous session
goose session resume --session-id <id>

# Run a specific task
goose session --task "Add tests for user authentication"

# In ~/.config/goose/config.yaml
extensions:
  github:
    cmd: npx
    args: ["-y", "@modelcontextprotocol/server-github"]
    env:
      GITHUB_TOKEN: "your-token"

title: Add tests for a function
description: Generate comprehensive unit tests
instructions:
  - Analyze the function signature and implementation
  - Identify edge cases and boundary conditions
  - Write unit tests using the project's testing framework
  - Ensure 100% code coverage
  - Run tests and fix any failures

# CLI
goose recipe run my-recipe.yaml

# Desktop: File → Run Recipe

# Provider configuration
export GOOSE_PROVIDER="openai"
export GOOSE_MODEL="gpt-4"
export OPENAI_API_KEY="your-key"

# Lead/Worker models
export GOOSE_LEAD_MODEL="gpt-4"
export GOOSE_WORKER_MODEL="gpt-3.5-turbo"

# Network configuration
export HTTPS_PROXY="http://proxy.company.com:8080"
export NO_PROXY="localhost,127.0.0.1"

# Development
export GOOSE_PATH_ROOT="/tmp/goose-test"  # Isolated environment
export GOOSE_DISABLE_KEYRING=1  # Force file-based secrets

# ~/.bashrc or ~/.zshrc
export GOOSE_PROVIDER="anthropic"
export ANTHROPIC_API_KEY="your-key"

export GOOSE_LEAD_MODEL="claude-3-5-sonnet-20241022"
export GOOSE_WORKER_MODEL="claude-3-5-haiku-20241022"

# Switch for a single session
GOOSE_PROVIDER=openai GOOSE_MODEL=gpt-4 goose session

# Or reconfigure
goose configure

# Project: My Web App

## Tech Stack
- Frontend: React + TypeScript
- Backend: Node.js + Express
- Database: PostgreSQL
- Testing: Jest + React Testing Library

## Code Style
- Use functional components with hooks
- Prefer async/await over promises
- All functions must have JSDoc comments
- Test coverage must be >80%

## Important Files
- API routes: `src/routes/`
- Components: `src/components/`
- Tests: `src/__tests__/`

## Don't modify
- `config/production.json`
- `scripts/deploy.sh`

// my-extension.js
import { Server } from '@modelcontextprotocol/sdk/server/index.js';
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';

const server = new Server({
  name: 'my-extension',
  version: '1.0.0',
}, {
  capabilities: {
    tools: {},
  },
});

server.setRequestHandler('tools/list', async () => ({
  tools: [{
    name: 'my_tool',
    description: 'Does something useful',
    inputSchema: {
      type: 'object',
      properties: {
        input: { type: 'string' },
      },
    },
  }],
}));

server.setRequestHandler('tools/call', async (request) => {
  // Handle tool execution
});

const transport = new StdioServerTransport();
await server.connect(transport);

extensions:
  my-extension:
    cmd: node
    args: ["/path/to/my-extension.js"]

goose session diagnostics --session-id <id>

# macOS/Linux
tail -f ~/.local/state/goose/logs/cli/$(date +%Y-%m-%d)/goose.jsonl

# Windows
Get-Content "$env:LOCALAPPDATA\Block\goose\logs\cli\$(Get-Date -Format yyyy-MM-dd)\goose.jsonl" -Wait

cat ~/.local/state/goose/logs/cli/*/goose.jsonl | jq 'select(.level=="ERROR")'

# Check if npx is installed (for Node.js extensions)
npx --version

# Check if uvx is installed (for Python extensions)
uvx --version

# Incorrect
extensions:
  github:
    command: npx  # Wrong key

# Correct
extensions:
  github:
    cmd: npx
    args: ["-y", "@modelcontextprotocol/server-github"]

# Instead of:
"Build a full e-commerce website"

# Try:
"Create a product listing page with search and filters"

name: goose Code Review
on: [pull_request]

jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Install goose
        run: |
          curl -fsSL https://github.com/block/goose/releases/latest/download/goose-install.sh | sh

      - name: Run goose review
        env:
          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
        run: |
          goose recipe run review-pr.yaml

goose schedule create \
  --recipe daily-tests.yaml \
  --cron "0 9 * * *" \
  --name "Daily Test Run"

goose schedule list

goose schedule remove --name "Daily Test Run"

export GOOSE_SERVER__SECRET_KEY="your-secret-key"
goosed agent  # or: just run-server

# Set server URL
export GOOSE_SERVER_URL="http://localhost:3000"
just debug-ui

git clone https://github.com/your-org/goose.git
cd goose

source bin/activate-hermit
just release-binary
just bundle-desktop