Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Goose on Windows via WSL #901

Merged
merged 9 commits into from
Jan 30, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 82 additions & 0 deletions documentation/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,88 @@ import RateLimits from '@site/src/components/RateLimits';
</TabItem>
</Tabs>

#### Installing on Windows via WSL

While Goose Desktop and CLI doesn't work on Windows directly atm, It is possible to run Goose CLI on Windows using the Windows Subsystem for Linux (WSL).
acekyd marked this conversation as resolved.
Show resolved Hide resolved

<details>

<summary>Installing Goose on WSL</summary>

#### Install WSL
Open PowerShell as Administrator and install WSL and the default Ubuntu distribution:
acekyd marked this conversation as resolved.
Show resolved Hide resolved

```bash
wsl --install
```

Restart your computer if prompted.

#### Update and install required packages
acekyd marked this conversation as resolved.
Show resolved Hide resolved
Open the Ubuntu app from the start menu, complete the initial setup and update
angiejones marked this conversation as resolved.
Show resolved Hide resolved

```bash
sudo apt update && sudo apt upgrade -y
```

#### Install Goose CLI
angiejones marked this conversation as resolved.
Show resolved Hide resolved
Run the Goose installation script:
```bash
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | bash
```
:::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
```
:::

On initial run, you might encounter errors about keyrings when setting your API Keys. Set the needed environment variables manually, e.g:

```bash
export GOOGLE_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 GOOGLE_API_KEY=your_google_api_key' >> ~/.bashrc
source ~/.bashrc

```

#### Configure Goose
Run `goose configure` to set up your LLM provider and model from the set environment variables. Choose to not store to keyring when prompted.


```bash
┌ goose-configure
◇ Which model provider should we use?
│ Google Gemini
● GOOGLE_API_KEY is set via environment variable
◇ Would you like to save this value to your keyring?
│ No
◇ Enter a model from that provider:
│ gemini-2.0-flash-exp
◇ Hello! You're all set and ready to go with this agent, so please don't hesitate to ask me anything.

└ Configuration saved successfully

Tip: Run 'goose configure' again to adjust your config or add extensions.
```

Run `goose session` to start a session.
</details>


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

Expand Down
4 changes: 3 additions & 1 deletion documentation/src/components/SupportedEnvironments.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import Admonition from "@theme/Admonition";
const SupportedEnvironments = () => {
return (
<Admonition type="info" title="Supported Environments">
Goose currently works on <strong>macOS</strong> and <strong>Linux</strong> systems and supports both <strong>ARM</strong> and <strong>x86</strong> architectures. If you'd like to request support for additional operating systems, please{" "}
Goose currently works on <strong>macOS</strong> and <strong>Linux</strong> systems and supports both <strong>ARM</strong> and <strong>x86</strong> architectures.

On <strong>Windows</strong>, you can run Goose CLI using WSL to run it via Ubuntu. If you'd like to request support for additional operating systems, please{" "}
acekyd marked this conversation as resolved.
Show resolved Hide resolved
<a
href="https://github.com/block/goose/discussions/867"
target="_blank"
Expand Down