> ## 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.

# Installation

> Install the goose CLI or desktop application on your system

Goose is available in two forms: a command-line interface (CLI) for terminal users and a desktop application for those who prefer a graphical interface.

## CLI Installation

The CLI is the fastest way to get started with goose and provides the full feature set.

### Quick Install

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

  ```powershell Windows (PowerShell) theme={null}
  irm https://github.com/block/goose/raw/main/download_cli.ps1 | iex
  ```
</CodeGroup>

<Info>
  The install scripts will download the appropriate binary for your system architecture and place it in your PATH. On first run, goose will guide you through provider configuration.
</Info>

### Install from Source (Cargo)

If you have Rust installed, you can build and install from source:

```bash theme={null}
cargo install goose-cli
```

This will compile goose locally and install the binary to `~/.cargo/bin/`.

### Manual Installation

<Steps>
  <Step title="Download the binary">
    Visit the [GitHub releases page](https://github.com/block/goose/releases) and download the appropriate archive for your platform:

    * macOS (ARM): `goose-aarch64-apple-darwin.tar.gz`
    * macOS (Intel): `goose-x86_64-apple-darwin.tar.gz`
    * Linux: `goose-x86_64-unknown-linux-gnu.tar.gz`
    * Windows: `goose-x86_64-pc-windows-msvc.zip`
  </Step>

  <Step title="Extract the archive">
    <Tabs>
      <Tab title="macOS/Linux">
        ```bash theme={null}
        tar -xzf goose-*.tar.gz
        ```
      </Tab>

      <Tab title="Windows">
        ```powershell theme={null}
        Expand-Archive -Path goose-*.zip -DestinationPath .
        ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="Move to your PATH">
    <Tabs>
      <Tab title="macOS/Linux">
        ```bash theme={null}
        sudo mv goose /usr/local/bin/
        # Or to install without sudo:
        mkdir -p ~/.local/bin
        mv goose ~/.local/bin/
        export PATH="$HOME/.local/bin:$PATH"
        ```
      </Tab>

      <Tab title="Windows">
        Move `goose.exe` to a directory in your PATH, or add the current directory to your PATH:

        ```powershell theme={null}
        $env:Path += ";$PWD"
        ```
      </Tab>
    </Tabs>
  </Step>

  <Step title="Verify installation">
    ```bash theme={null}
    goose --version
    ```

    You should see the version number printed to the console.
  </Step>
</Steps>

## Desktop Application

The desktop app provides a rich graphical interface with session management, extension configuration, and visual feedback.

### Download

Visit the [GitHub releases page](https://github.com/block/goose/releases) and download the installer for your platform:

* **macOS**: `goose-<version>.dmg`
* **Windows**: `goose-<version>.msi` or `goose-<version>.exe`
* **Linux**: `goose-<version>.AppImage` or `goose-<version>.deb`

### Install

<Tabs>
  <Tab title="macOS">
    1. Open the `.dmg` file
    2. Drag the goose app to your Applications folder
    3. Open goose from Applications (you may need to allow the app in System Preferences > Security & Privacy)
  </Tab>

  <Tab title="Windows">
    1. Run the `.msi` or `.exe` installer
    2. Follow the installation wizard
    3. Launch goose from the Start Menu
  </Tab>

  <Tab title="Linux">
    **AppImage:**

    ```bash theme={null}
    chmod +x goose-*.AppImage
    ./goose-*.AppImage
    ```

    **Debian/Ubuntu (.deb):**

    ```bash theme={null}
    sudo dpkg -i goose-*.deb
    sudo apt-get install -f  # Install dependencies if needed
    ```
  </Tab>
</Tabs>

### First Launch

On first launch, the desktop app will guide you through:

1. Selecting your LLM provider
2. Entering API credentials
3. Configuring optional extensions

You can modify these settings later in the app's settings panel.

## Platform-Specific Notes

### macOS

<Warning>
  On macOS, you may see a security warning when first running goose. To allow the app:

  1. Go to System Preferences > Security & Privacy
  2. Click "Open Anyway" next to the goose message
  3. Alternatively, right-click the app and select "Open"
</Warning>

### Linux (WSL)

For Windows Subsystem for Linux (WSL) users:

```bash theme={null}
sudo apt update
sudo apt install build-essential libxcb1-dev
```

These packages are required for certain dependencies.

### Windows

<Info>
  Windows users may need to install the [Visual C++ Redistributable](https://aka.ms/vs/17/release/vc_redist.x64.exe) if not already present.
</Info>

## Verifying Installation

### CLI

After installation, verify the CLI is working:

```bash theme={null}
goose --version
goose --help
```

You should see version information and a list of available commands.

### Desktop App

Launch the desktop app and verify you can:

1. Open the settings panel
2. See available providers
3. Create a new session

## Next Steps

Now that goose is installed, configure your LLM provider:

<Card title="Configuration Guide" icon="gear" href="/configuration" horizontal>
  Set up your LLM provider and customize goose's behavior
</Card>

Or jump straight to running your first session:

<Card title="Quickstart" icon="rocket" href="/quickstart" horizontal>
  Run your first AI agent session in minutes
</Card>

## Troubleshooting

If you encounter issues during installation:

<AccordionGroup>
  <Accordion title="Command not found (CLI)">
    The goose binary is not in your PATH. Add the installation directory to your PATH:

    ```bash theme={null}
    # Add to ~/.bashrc or ~/.zshrc
    export PATH="$HOME/.local/bin:$PATH"
    ```

    Then restart your terminal or run `source ~/.bashrc`.
  </Accordion>

  <Accordion title="Permission denied (macOS/Linux)">
    The binary may not be executable:

    ```bash theme={null}
    chmod +x /usr/local/bin/goose
    # Or wherever you installed it
    ```
  </Accordion>

  <Accordion title="Desktop app won't open">
    Try these steps:

    1. Check that you downloaded the correct version for your platform
    2. On macOS, allow the app in Security & Privacy settings
    3. On Linux, ensure you've made the AppImage executable: `chmod +x goose-*.AppImage`
    4. Check the logs in the [diagnostics](/troubleshooting/diagnostics) for error messages
  </Accordion>
</AccordionGroup>

For more troubleshooting help, see the [Troubleshooting guide](/troubleshooting/diagnostics) or join our [Discord community](https://discord.gg/goose-oss).