# Where to Find Goose Project Documentation: Complete Guide to Repository and Hosted Resources

> Find Goose project documentation easily. Access comprehensive guides within the repository or on the hosted site at goose-docs.ai/docs for a complete overview.

- Repository: [goose/goose](https://github.com/aaif-goose/goose)
- Tags: documentation
- Published: 2026-04-07

---

**The Goose project documentation ships with the repository in the `documentation/` folder and is published on the hosted site at goose-docs.ai/docs.**

The `aaif-goose/goose` repository maintains comprehensive Goose project documentation both as markdown source files for offline reading and as a searchable web interface. Whether you prefer browsing GitHub directly or reading on the hosted documentation site, the content remains synchronized from the same source.

## Repository Documentation Structure

### The documentation/ Folder

The primary source for all guides lives in `documentation/docs/` at the repository root. This directory contains the complete reference guide, tutorials, troubleshooting articles, and API documentation as markdown files. You can access the full structure at `https://github.com/aaif-goose/goose/tree/main/documentation/docs`.

### README Quick Links

The top-level [`README.md`](https://github.com/aaif-goose/goose/blob/main/README.md) serves as a navigation hub, containing a "Quick links" section that points directly to installation guides and the hosted documentation. This file provides the fastest entry point for new users seeking orientation.

## Hosted Documentation Site

For a searchable browsing experience, the same markdown files render live at **https://goose-docs.ai/docs**. This hosted version offers an interactive web UI, searchable index, and formatted code snippets maintained in sync with the repository.

## Essential Documentation Files

The following key files provide structured learning paths:

- **[`documentation/docs/quickstart.md`](https://github.com/aaif-goose/goose/blob/main/documentation/docs/quickstart.md)** – Step-by-step tutorial covering installation, provider configuration, and launching your first session
- **[`documentation/docs/getting-started/installation.md`](https://github.com/aaif-goose/goose/blob/main/documentation/docs/getting-started/installation.md)** – Platform-specific setup instructions and PATH configuration notes
- **[`documentation/docs/getting-started/providers.md`](https://github.com/aaif-goose/goose/blob/main/documentation/docs/getting-started/providers.md)** – Supported LLM providers and authentication flows
- **`documentation/docs/extensions/`** – Individual markdown files for each built-in MCP extension
- **`documentation/docs/troubleshooting/`** – Diagnostic guides and known issue resolutions

## Quick Start Commands from the Documentation

The [`quickstart.md`](https://github.com/aaif-goose/goose/blob/main/quickstart.md) file and CLI source in [`crates/goose-cli/src/main.rs`](https://github.com/aaif-goose/goose/blob/main/crates/goose-cli/src/main.rs) demonstrate these essential workflows.

Install the CLI:

```bash
curl -fsSL https://github.com/aaif-goose/goose/releases/download/stable/download_cli.sh | bash

```

Run the interactive configuration wizard:

```bash
goose configure

```

The wizard prompts you to select a provider and securely stores your API key.

Start a new session:

```bash
mkdir goose-demo && cd goose-demo
goose session

```

Enable a built-in extension (e.g., Computer Controller):

```bash
goose configure

# Select: Add Extension → Built-in Extension → Computer Controller

# Set timeout (e.g., 300s) and confirm

```

## Core Implementation References

For developers investigating the source implementation alongside documentation:

- **[`crates/goose-cli/src/main.rs`](https://github.com/aaif-goose/goose/blob/main/crates/goose-cli/src/main.rs)** – CLI binary entry point
- **[`crates/goose/src/lib.rs`](https://github.com/aaif-goose/goose/blob/main/crates/goose/src/lib.rs)** – Agent runtime and session handling
- **[`crates/goose-mcp/src/lib.rs`](https://github.com/aaif-goose/goose/blob/main/crates/goose-mcp/src/lib.rs)** – Model Context Protocol extensions implementation

## Summary

- **Goose project documentation** exists both in `documentation/` and at goose-docs.ai/docs
- The [`README.md`](https://github.com/aaif-goose/goose/blob/main/README.md) provides quick entry points to essential resources
- Start with [`documentation/docs/quickstart.md`](https://github.com/aaif-goose/goose/blob/main/documentation/docs/quickstart.md) for installation and first steps
- Core source files in `crates/` demonstrate how documented features are implemented

## Frequently Asked Questions

### Is the Goose documentation available offline?

Yes. Clone the `aaif-goose/goose` repository and browse the `documentation/docs/` folder locally. The markdown files contain identical content to the hosted site, allowing offline reading and pull request contributions.

### What is the fastest way to start using Goose after reading the docs?

Run the installation script `curl -fsSL https://github.com/aaif-goose/goose/releases/download/stable/download_cli.sh | bash`, then execute `goose configure` to set up your provider, followed by `goose session` to begin your first coding session as described in [`documentation/docs/quickstart.md`](https://github.com/aaif-goose/goose/blob/main/documentation/docs/quickstart.md).

### Where are the extension configuration details documented?

Each built-in MCP extension has a dedicated markdown file in `documentation/docs/extensions/`, with specific implementations like the Computer Controller documented at [`documentation/docs/mcp/computer-controller-mcp.md`](https://github.com/aaif-goose/goose/blob/main/documentation/docs/mcp/computer-controller-mcp.md). These files detail parameters, timeout settings, and usage examples.

### How do I report documentation errors or contribute improvements?

Since the hosted site generates from the repository's `documentation/` folder, submit pull requests against the markdown files in `aaif-goose/goose`. The [`README.md`](https://github.com/aaif-goose/goose/blob/main/README.md) quick links and source files in `crates/` are also maintained in the same repository.