Skip to main content

Welcome to Goose Documentation

Learn how to build powerful AI agents that automate complex engineering tasks from start to finish with any LLM provider.

$ goose session
Starting goose session…
goose: What can I help you with?
you: Build a REST API with user auth
✓ Creating project structure…
✓ Writing authentication code…
✓ Running tests…

Quick Start

Get up and running with Goose in minutes

1

Install Goose

Choose your preferred installation method:
curl -fsSL https://github.com/block/goose/raw/main/download_cli.sh | bash
Or download the desktop app from the releases page.
2

Configure your provider

Set up your preferred LLM provider:
goose configure
Goose supports 30+ providers including OpenAI, Anthropic, Ollama, Databricks, and more. You can switch between providers using the GOOSE_PROVIDER environment variable.
3

Start a session

Launch your first AI agent session:
goose session
Goose will start an interactive session where you can describe tasks in natural language. The agent can write code, execute commands, debug failures, and interact with external tools autonomously.
$ goose session
Starting goose session...

goose: What can I help you with?
you: Create a simple web server in Python

goose: I'll create a simple Flask web server for you.

[Writing code to app.py...]
[Installing dependencies...]
[Testing the server...]

✓ Created app.py with Flask web server
✓ Server running on http://localhost:5000
4

Explore extensions

Extend Goose with Model Context Protocol (MCP) servers:
goose configure
# Select "Extensions" to add MCP servers
Browse available extensions in the MCP integration guide or build your own custom tools.

Explore by Topic

Learn about Goose’s core capabilities

Architecture

Understand how Goose’s framework enables extensible AI agents with multi-model support.

Providers

Connect to 30+ LLM providers including OpenAI, Anthropic, Ollama, and local inference.

Extensions

Extend agent capabilities with MCP servers and custom tool integrations.

Recipes

Automate complex workflows with reusable recipe definitions.

CLI Usage

Master the command-line interface for sessions, recipes, and project management.

Desktop App

Use the Electron desktop application for a rich visual experience.

Developer Resources

Build extensions, providers, and custom distributions

API Reference

Explore the complete API documentation for the Goose framework.

Extension Development

Create custom MCP servers and tools to extend agent capabilities.

Provider Development

Implement custom LLM provider integrations using the Provider trait.

Custom Distributions

Build white-labeled distributions with preconfigured providers and branding.

Community & Support

Get help and connect with other developers

Discord Community

Join our Discord server to ask questions, share projects, and connect with the community.

GitHub Discussions

Browse discussions, report issues, and contribute to the open source project.

Troubleshooting

Find solutions to common issues and learn how to diagnose problems.

Contributing Guide

Learn how to contribute code, documentation, and help improve Goose.

Ready to get started?

Install Goose and start building autonomous AI agents that can automate your entire development workflow.

Get Started Now

Build docs developers (and LLMs) love