Skip to main content

Install Goose

Supported Environments
The Goose CLI currently works on macOS and Linux systems and supports both ARM and x86 architectures. On Windows, Goose CLI can run via WSL. If you'd like to request support for additional operating systems, please vote on GitHub.

Choose to install Goose on CLI and/or Desktop:

Install Goose directly from the browser or with Homebrew.

Option 1: Install via Download

To download Goose Desktop for macOS, click one of the buttons below:

macOS Silicon macOS Intel
  1. Unzip the downloaded zip file.
  2. Run the executable file to launch the Goose desktop application.
Updating Goose

It's best to keep Goose updated by periodically running the installation steps again.

Option 2: Install via Homebrew

Homebrew downloads the same app but can take care of updates too.

  brew install --cask block-goose
Permissions

If you're on an Apple Mac M3 and the Goose desktop app shows no window on launch, check and update the following:

Ensure the ~/.config directory has read and write access.

Goose needs this access to create the log directory and file. Once permissions are granted, the app should load correctly. For steps on how to do this, refer to the Troubleshooting Guide

Set LLM Provider​

Goose works with a set of supported LLM providers, and you'll need an API key to get started. When you use Goose for the first time, you'll be prompted to select a provider and enter your API key.

Upon installing, the Provider screen will appear. Here is where you can choose your LLM Provider.

Set Up a Provider UI

Once selecting your provider, you'll be prompted to enter an API key if applicable. Do so, and click Submit.

Update Provider​

To update your LLM provider and API key:

  1. Click on the three dots in the top-right corner.
  2. Select Provider Settings from the menu.
  3. Choose a provider from the list.
  4. Click Edit, enter your API key, and click Set as Active.
Billing
Google Gemini offers a free tier you can get started with. Otherwise, you'll need to ensure that you have credits available in your LLM Provider account to successfully make requests.

Some providers also have rate limits on API usage, which can affect your experience. Check out our Handling Rate Limits guide to learn how to efficiently manage these limits while using Goose.

Running Goose​

Starting a session in the Goose Desktop is straightforward. After choosing your provider, you'll see the session interface ready for use.

Type your questions, tasks, or instructions directly into the input field, and Goose will get to work immediately.

Shared Configuration Settings​

The Goose CLI and Desktop UI share all core configurations, including LLM provider settings, model selection, and extension configurations. When you install or configure extensions in either interface, the settings are stored in a central location at ~/.config/goose/config.yaml, making them available to both the Desktop application and CLI. This makes it convenient to switch between interfaces while maintaining consistent settings.

note

While core configurations are shared between interfaces, extensions have flexibility in how they store authentication credentials. Some extensions may use the shared config file while others implement their own storage methods.

Navigate to shared configurations through:

  1. Click ... in the upper right corner
  2. Click Advanced Settings

Additional Resources​

You can also configure Extensions to extend Goose's functionality, including adding new ones or toggling them on and off. For detailed instructions, visit the Using Extensions Guide.