goose/documentation/docs/installation.md

sidebar_position

sidebar_position
1

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Installation

#### Installing the Goose CLI To install Goose, run the following script on macOS or Linux.

```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | sh
```
This script will fetch the latest version of Goose and set it up on your system.

#### Installing the Goose UI

To install the Goose desktop UI, follow these steps: 
1. Visit the [Goose Releases page](https://github.com/block/goose/releases/tag/stable)
2. Download the `Goose.zip` file.
3. Open the downloaded `Goose.zip` file and launch the desktop application.

Set Up a 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.

The process will look similar to the example below:

  ### Update a Provider **To update your LLM provider and API key:** 1. Run the following command: ```sh goose configure ``` 2. Select `Configure Providers` from the menu. 3. Follow the prompts to choose your LLM privider and enter or update your API key.

**Example:**

To select an option during configuration, hover over it and press Enter.

```sh
What would you like to configure?
> Configure Providers
  Toggle Extensions
  Add Extension

Which Model provider should we use?
> OpenAI
  Databricks
  Ollama
.....

Enter Api Key:
>  sk-1234abcd5678efgh
```

**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.
2. Choose a provider from the list.
3. Click Edit, enter your API key, and click `Set as Active`.

:::info Billing You will need to have credits in your LLM Provider account (when necessary) to be able to successfully make requests. Some providers also have rate limits on API usage, which can affect your experience. Check out the Handling Rate Limits guide to learn how to efficiently manage these limits while using Goose. :::

Running Goose

From your terminal, navigate to the directory you'd like to start from and run: ```sh goose session ``` Starting a session in the Goose UI 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. 

    ![Install Extension](./assets/guides/ui-session-interface.png)
</TabItem>

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.