Installation

Goose is an open-source AI agent designed for automating engineering tasks on local machines. This page outlines the steps to install and set up Goose on various platforms, ensuring users can quickly get started with its features. Proper installation allows Goose to integrate seamlessly into development workflows, enabling autonomous task execution, code generation, and more.

Why Install Goose?

Goose empowers developers to automate complex tasks, such as building projects, debugging code, and interacting with APIs, all while running locally. Installation is the foundational step, as it sets up the necessary binaries, dependencies, and configurations. This process supports multiple platforms to accommodate diverse user environments, reflecting Goose's design for flexibility and extensibility. For more on Goose's capabilities, refer to the Features page.

Prerequisites

Before installing Goose, ensure your system meets the following basic requirements:

• Operating System: A modern version of Linux, macOS, or Windows.
• Dependencies:
  • A compatible package manager (e.g., apt, brew, or choco).
  • At least 2 GB of RAM and 1 GB of free disk space for basic operations.
  • Access to a terminal or command prompt for CLI installations.
• Optional: If using Goose with language models, review the LLM Support page for additional setup, such as API keys or model downloads.

These prerequisites ensure smooth integration and prevent common issues, as discussed in the Troubleshooting page.

Installation Methods

Goose offers installation options for both CLI and desktop applications across major platforms. The following sections provide step-by-step instructions, including package manager installations and building from source. Choose the method that best fits your workflow.

CLI Installation

The CLI version of Goose is lightweight and ideal for developers who prefer terminal-based interactions. It supports automation scripts and integrates easily with existing tools.

For Linux (e.g., Ubuntu/Debian)

1. Update your package manager to ensure you have the latest repositories:

sudo apt update

1. Install Goose using the official repository or script:

curl -fsSL https://raw.githubusercontent.com/block/goose/main/install.sh | bash

This script handles dependencies like curl and sets up the binary in your PATH.

1. Verify the installation:

goose --version

Expected output: goose version X.Y.Z (replace with the latest version).

For macOS

1. Install Homebrew if you don't have it:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

1. Add the Goose tap and install:

brew tap block/goose
brew install goose

1. Verify the installation:

goose --version

For Windows

1. Use Chocolatey, a package manager for Windows:

choco install goose

If Chocolatey is not installed, install it first:

Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))

1. Verify the installation:

goose --version

Installing from Source

For users who want to build Goose from the source code, follow these steps. This method requires Git and pip.

1. Clone the Goose repository:

git clone https://github.com/block/goose.git

1. Navigate to the repository directory:

cd goose

1. Install the required dependencies:

pip install -r requirements.txt

1. Build and install the binary (refer to the repository's build instructions for platform-specific details).
2. Verify the installation by running:

goose --version

Desktop App Installation

The desktop app provides a graphical interface for Goose, making it accessible for users who prefer visual tools. It includes the same core functionality as the CLI with additional features like easy configuration management.

For macOS and Windows

1. Download the latest installer from the official Goose releases page on GitHub.
2. Run the downloaded installer:

• On macOS: Double-click the .dmg file and drag the app to your Applications folder.
• On Windows: Run the .exe file and follow the on-screen prompts.

1. Launch the app and complete the initial setup wizard.
2. Verify the installation by checking the version in the settings menu.

For Linux

1. Download the appropriate .deb or .rpm package from the Goose releases page.
2. Install the package using your distribution's package manager:

• For Debian-based systems: sudo dpkg -i goose-x.y.z.deb
• For RPM-based systems: sudo rpm -i goose-x.y.z.rpm

1. Launch the app via: goose-desktop.
2. Verify by checking the app's about section for the version.

Post-Installation Setup

After installation, configure Goose to suit your needs, including setting up language models, API integrations, and extensions.

• Run the initial setup command for CLI: goose init. This creates a configuration file (e.g., ~/.goose/config.yaml).
• For the desktop app, use the built-in setup wizard.
• Refer to the Configuration page for detailed instructions on customizing settings.

If you encounter issues, consult the Troubleshooting page for common solutions.

Next Steps

Once installed and configured, explore Goose's capabilities through the Tutorials or CLI Reference pages to learn how Goose fits into your development process. For advanced usage, check the Features page.