> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/block/goose/llms.txt
> Use this file to discover all available pages before exploring further.

# Goose Documentation

> An open source, extensible AI agent framework that automates engineering tasks with any LLM

<div className="relative overflow-hidden bg-gradient-to-br from-[#7B68EE] via-[#6B58DE] to-[#5B48CE] dark:from-[#5B48CE] dark:via-[#4B38BE] dark:to-[#3B28AE] py-20">
  <div className="max-w-7xl mx-auto px-6 lg:px-8">
    <div className="grid grid-cols-1 lg:grid-cols-12 gap-8 items-center">
      <div className="lg:col-span-7">
        <h1 className="text-4xl sm:text-5xl lg:text-6xl font-bold text-white mb-6">
          Welcome to Goose Documentation
        </h1>

        <p className="text-lg sm:text-xl text-white/90 max-w-2xl mb-8">
          Learn how to build powerful AI agents that automate complex engineering tasks from start to finish with any LLM provider.
        </p>

        <div className="flex flex-wrap gap-4">
          <a href="/quickstart" className="inline-flex items-center px-6 py-3 rounded-lg bg-white text-[#7B68EE] font-semibold hover:bg-gray-100 transition-colors no-underline">
            Get Started
          </a>

          <a href="/concepts/architecture" className="inline-flex items-center px-6 py-3 rounded-lg border-2 border-white/30 bg-white/10 text-white font-semibold hover:bg-white/20 transition-colors no-underline">
            Learn Concepts
          </a>
        </div>
      </div>

      <div className="lg:col-span-5 hidden lg:block">
        <div className="relative">
          <div className="absolute inset-0 bg-white/5 rounded-2xl backdrop-blur-sm" />

          <div className="relative p-6 text-white/80 font-mono text-sm">
            <div className="mb-2"><span className="text-[#9B88FF]">\$</span> goose session</div>
            <div className="mb-4 text-white/60">Starting goose session...</div>
            <div className="mb-2"><span className="text-white">goose:</span> What can I help you with?</div>
            <div className="mb-4"><span className="text-[#9B88FF]">you:</span> Build a REST API with user auth</div>
            <div className="text-white/60">✓ Creating project structure...</div>
            <div className="text-white/60">✓ Writing authentication code...</div>
            <div className="text-white/60">✓ Running tests...</div>
          </div>
        </div>
      </div>
    </div>
  </div>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  <h2 className="text-3xl font-bold text-gray-900 dark:text-white mb-4">
    Quick Start
  </h2>

  <p className="text-base text-gray-600 dark:text-gray-400 mb-8">
    Get up and running with Goose in minutes
  </p>

  <Steps>
    <Step title="Install Goose">
      Choose your preferred installation method:

      <CodeGroup>
        ```bash macOS/Linux theme={null}
        curl -fsSL https://github.com/block/goose/raw/main/download_cli.sh | bash
        ```

        ```powershell Windows theme={null}
        irm https://github.com/block/goose/raw/main/download_cli.ps1 | iex
        ```

        ```bash Cargo theme={null}
        cargo install goose-cli
        ```
      </CodeGroup>

      Or download the desktop app from the [releases page](https://github.com/block/goose/releases).
    </Step>

    <Step title="Configure your provider">
      Set up your preferred LLM provider:

      ```bash theme={null}
      goose configure
      ```

      Goose supports 30+ providers including OpenAI, Anthropic, Ollama, Databricks, and more. You can switch between providers using the `GOOSE_PROVIDER` environment variable.
    </Step>

    <Step title="Start a session">
      Launch your first AI agent session:

      ```bash theme={null}
      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.

      <Accordion title="Example session output">
        ```
        $ 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
        ```
      </Accordion>
    </Step>

    <Step title="Explore extensions">
      Extend Goose with Model Context Protocol (MCP) servers:

      ```bash theme={null}
      goose configure
      # Select "Extensions" to add MCP servers
      ```

      Browse available extensions in the [MCP integration guide](/guides/mcp-integration) or build your own custom tools.
    </Step>
  </Steps>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  <h2 className="text-3xl font-bold text-gray-900 dark:text-white mb-4">
    Explore by Topic
  </h2>

  <p className="text-base text-gray-600 dark:text-gray-400 mb-8">
    Learn about Goose's core capabilities
  </p>

  <CardGroup cols={3}>
    <Card title="Architecture" icon="sitemap" href="/concepts/architecture">
      Understand how Goose's framework enables extensible AI agents with multi-model support.
    </Card>

    <Card title="Providers" icon="plug" href="/concepts/providers">
      Connect to 30+ LLM providers including OpenAI, Anthropic, Ollama, and local inference.
    </Card>

    <Card title="Extensions" icon="puzzle-piece" href="/concepts/extensions">
      Extend agent capabilities with MCP servers and custom tool integrations.
    </Card>

    <Card title="Recipes" icon="book-bookmark" href="/concepts/recipes">
      Automate complex workflows with reusable recipe definitions.
    </Card>

    <Card title="CLI Usage" icon="terminal" href="/guides/cli-usage">
      Master the command-line interface for sessions, recipes, and project management.
    </Card>

    <Card title="Desktop App" icon="desktop" href="/guides/desktop-app">
      Use the Electron desktop application for a rich visual experience.
    </Card>
  </CardGroup>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  <h2 className="text-3xl font-bold text-gray-900 dark:text-white mb-4">
    Developer Resources
  </h2>

  <p className="text-base text-gray-600 dark:text-gray-400 mb-8">
    Build extensions, providers, and custom distributions
  </p>

  <CardGroup cols={2}>
    <Card title="API Reference" icon="code" href="/api/core/agent">
      Explore the complete API documentation for the Goose framework.
    </Card>

    <Card title="Extension Development" icon="hammer" href="/development/extension-development">
      Create custom MCP servers and tools to extend agent capabilities.
    </Card>

    <Card title="Provider Development" icon="server" href="/development/provider-interface">
      Implement custom LLM provider integrations using the Provider trait.
    </Card>

    <Card title="Custom Distributions" icon="box-open" href="/advanced/custom-distributions">
      Build white-labeled distributions with preconfigured providers and branding.
    </Card>
  </CardGroup>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  <h2 className="text-3xl font-bold text-gray-900 dark:text-white mb-4">
    Community & Support
  </h2>

  <p className="text-base text-gray-600 dark:text-gray-400 mb-8">
    Get help and connect with other developers
  </p>

  <CardGroup cols={2}>
    <Card title="Discord Community" icon="discord" href="https://discord.gg/goose-oss">
      Join our Discord server to ask questions, share projects, and connect with the community.
    </Card>

    <Card title="GitHub Discussions" icon="github" href="https://github.com/block/goose/discussions">
      Browse discussions, report issues, and contribute to the open source project.
    </Card>

    <Card title="Troubleshooting" icon="life-ring" href="/troubleshooting/diagnostics">
      Find solutions to common issues and learn how to diagnose problems.
    </Card>

    <Card title="Contributing Guide" icon="code-pull-request" href="/development/contributing">
      Learn how to contribute code, documentation, and help improve Goose.
    </Card>
  </CardGroup>
</div>

<div className="mt-20 mb-16 max-w-5xl mx-auto px-6">
  <div className="relative overflow-hidden rounded-2xl border border-gray-200 dark:border-[#27272a] bg-gray-50 dark:bg-[#1a1d27] p-8 lg:p-12">
    <div className="relative z-10">
      <h2 className="text-3xl font-bold text-gray-900 dark:text-white mb-4">
        Ready to get started?
      </h2>

      <p className="text-lg text-gray-600 dark:text-gray-400 mb-6 max-w-2xl">
        Install Goose and start building autonomous AI agents that can automate your entire development workflow.
      </p>

      <a href="/quickstart" className="inline-flex items-center px-6 py-3 rounded-lg bg-[#7B68EE] text-white font-semibold hover:bg-[#6B58DE] transition-colors no-underline">
        Get Started Now
      </a>
    </div>

    <div className="absolute right-0 bottom-0 opacity-10 dark:opacity-5">
      <svg width="300" height="300" viewBox="0 0 300 300" fill="currentColor" className="text-[#7B68EE]">
        <circle cx="250" cy="250" r="100" />

        <circle cx="200" cy="200" r="60" />

        <circle cx="280" cy="200" r="40" />
      </svg>
    </div>
  </div>
</div>