diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md
index 333e0da2..319ef7a3 100644
--- a/documentation/docs/getting-started/installation.md
+++ b/documentation/docs/getting-started/installation.md
@@ -13,48 +13,88 @@ import RateLimits from '@site/src/components/RateLimits';
+
+
+ Choose to install Goose on CLI and/or Desktop:
-
-
- Run the following command to install the latest version of Goose:
+
+
+ Run the following command to install the latest version of Goose:
- ```sh
+ ```sh
+ curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | bash
+ ```
+ This script will fetch the latest version of Goose and set it up on your system.
+
+ :::tip Best Practice
+ It’s best to keep Goose updated. You can update it by re-running the installation script.
+ :::
+
+
+ To install Goose, click the **button** below:
+
+
+
+ download goose desktop
+
+
+
+ 1. Unzip the downloaded `Goose.zip` file.
+ 2. Run the executable file to launch the Goose desktop application.
+ :::tip Best Practice
+ It’s best to keep Goose updated. You can do this by checking the [Goose GitHub Release page](https://github.com/block/goose/releases/stable) and downloading updates when available.
+ :::
+
+
+
+
+
+
+
+
+ There isn't native installation support for Windows, however you can run Goose using WSL (Windows Subsystem for Linux).
+
+ 1. Open [PowerShell](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows) as Administrator and install WSL and the default Ubuntu distribution:
+
+ ```bash
+ wsl --install
+ ```
+
+ 2. Restart your computer if prompted.
+
+ 3. Run the Goose installation script:
+ ```bash
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | bash
```
- This script will fetch the latest version of Goose and set it up on your system.
-
- :::tip Best Practice
- It’s best to keep Goose updated. You can update it by re-running the installation script.
+ :::tip
+ If you encounter any issues on download, you might need to install `bzip2` to extract the downloaded file:
+
+ ```bash
+ sudo apt update && sudo apt install bzip2 -y
+ ```
:::
-
- To install Goose, click the **button** below:
-
-
-
- download goose desktop
-
-
-
- 1. Unzip the downloaded `Goose.zip` file.
- 2. Run the executable file to launch the Goose desktop application.
- :::tip Best Practice
- It’s best to keep Goose updated. You can do this by checking the [Goose GitHub Release page](https://github.com/block/goose/releases/stable) and downloading updates when available.
- :::
-
-
+
-### Set LLM Provider
+
+
+## Set LLM Provider
Goose works with a set of [supported LLM providers][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, Goose will automatically enter its configuration screen. Here is where you can set up your LLM provider.
+ :::tip Windows Users
+ Choose to not store to keyring when prompted.
+ :::
+
+ Example:
+
```
┌ goose-configure
│
@@ -74,6 +114,22 @@ Goose works with a set of [supported LLM providers][providers], and you’ll nee
│
└ Configuration saved successfully
```
+
+ :::info Windows Users
+ On initial run, you may encounter errors about keyrings when setting your API Keys. Set the needed environment variables manually, e.g.:
+
+ ```bash
+ export OPENAI_API_KEY={your_google_api_key}
+ ```
+
+ To make the changes persist in WSL across sessions, add the goose path and export commands to your `.bashrc` or `.bash_profile` file so you can load it later.
+
+ ```bash
+ echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
+ echo 'export OPENAI_API_KEY=your_google_api_key' >> ~/.bashrc
+ source ~/.bashrc
+ ```
+ :::
Upon installing, the Provider screen will appear. Here is where you can choose your LLM Provider.
@@ -84,7 +140,7 @@ Goose works with a set of [supported LLM providers][providers], and you’ll nee
-### Update a Provider
+## Update Provider
**To update your LLM provider and API key:**
diff --git a/documentation/src/components/SupportedEnvironments.js b/documentation/src/components/SupportedEnvironments.js
index 903f5ef7..cba9752a 100644
--- a/documentation/src/components/SupportedEnvironments.js
+++ b/documentation/src/components/SupportedEnvironments.js
@@ -4,7 +4,9 @@ import Admonition from "@theme/Admonition";
const SupportedEnvironments = () => {
return (
- Goose currently works on macOS and Linux systems and supports both ARM and x86 architectures. If you'd like to request support for additional operating systems, please{" "}
+ Goose 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{" "}