docs: Goose on Windows via WSL (#901)

Co-authored-by: Angie Jones <jones.angie@gmail.com>
This commit is contained in:
Adewale Abati
2025-01-30 05:37:39 +01:00
committed by GitHub
parent 6051021a8d
commit ccd1427624
2 changed files with 88 additions and 30 deletions

View File

@@ -13,48 +13,88 @@ import RateLimits from '@site/src/components/RateLimits';
<SupportedEnvironments /> <SupportedEnvironments />
<Tabs>
<TabItem value="mac-linux" label="macOS | Linux" default>
Choose to install Goose on CLI and/or Desktop:
<Tabs groupId="interface"> <Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default> <TabItem value="cli" label="Goose CLI" default>
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
Its best to keep Goose updated. You can update it by re-running the installation script.
:::
</TabItem>
<TabItem value="ui" label="Goose Desktop">
To install Goose, click the **button** below:
<div className="pill-button">
<Link
className="button button--primary button--lg"
to="https://github.com/block/goose/releases/download/stable/Goose.zip"
>
<IconDownload />
download goose desktop
</Link>
</div>
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded `Goose.zip` file.
2. Run the executable file to launch the Goose desktop application.
:::tip Best Practice
Its 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.
:::
</div>
</TabItem>
</Tabs>
</TabItem>
<TabItem value="windows" label="Windows">
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 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
If you encounter any issues on download, you might need to install `bzip2` to extract the downloaded file:
:::tip Best Practice
Its best to keep Goose updated. You can update it by re-running the installation script. ```bash
sudo apt update && sudo apt install bzip2 -y
```
::: :::
</TabItem> </TabItem>
<TabItem value="ui" label="Goose Desktop">
To install Goose, click the **button** below:
<div className="pill-button">
<Link
className="button button--primary button--lg"
to="https://github.com/block/goose/releases/download/stable/Goose.zip"
>
<IconDownload />
download goose desktop
</Link>
</div>
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded `Goose.zip` file.
2. Run the executable file to launch the Goose desktop application.
:::tip Best Practice
Its 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.
:::
</div>
</TabItem>
</Tabs> </Tabs>
### Set LLM Provider
## Set LLM Provider
Goose works with a set of [supported LLM providers][providers], and youll need an API key to get started. When you use Goose for the first time, youll be prompted to select a provider and enter your API key. Goose works with a set of [supported LLM providers][providers], and youll need an API key to get started. When you use Goose for the first time, youll be prompted to select a provider and enter your API key.
<Tabs groupId="interface"> <Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default> <TabItem value="cli" label="Goose CLI" default>
Upon installing, Goose will automatically enter its configuration screen. Here is where you can set up your LLM provider. 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 ┌ goose-configure
@@ -74,6 +114,22 @@ Goose works with a set of [supported LLM providers][providers], and youll nee
└ Configuration saved successfully └ 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
```
:::
</TabItem> </TabItem>
<TabItem value="ui" label="Goose Desktop"> <TabItem value="ui" label="Goose Desktop">
Upon installing, the Provider screen will appear. Here is where you can choose your LLM Provider. 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 youll nee
</TabItem> </TabItem>
</Tabs> </Tabs>
### Update a Provider ## Update Provider
<Tabs groupId="interface"> <Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default> <TabItem value="cli" label="Goose CLI" default>
**To update your LLM provider and API key:** **To update your LLM provider and API key:**

View File

@@ -4,7 +4,9 @@ import Admonition from "@theme/Admonition";
const SupportedEnvironments = () => { const SupportedEnvironments = () => {
return ( return (
<Admonition type="info" title="Supported Environments"> <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>, Goose CLI can run via WSL. If you'd like to request support for additional operating systems, please{" "}
<a <a
href="https://github.com/block/goose/discussions/867" href="https://github.com/block/goose/discussions/867"
target="_blank" target="_blank"