aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-17 22:24:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Goose on Windows Installation (#2990)

Browse Source 
no code changes
This commit is contained in:
Rizel Scarlett
2025-06-18 14:34:03 -04:00
committed by GitHub
parent f122c905dc
commit 59ee39f191
6 changed files with 131 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

77
documentation/docs/getting-started/installation.md
View File

@@ -5,8 +5,8 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import SupportedEnvironments from '@site/src/components/SupportedEnvironments';
import RateLimits from '@site/src/components/RateLimits';
import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
import MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons';
import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons';
# Install Goose
@@ -22,11 +22,11 @@ import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
Install Goose directly from the browser or with [Homebrew](https://brew.sh/).
<h3 style={{ marginTop: '1rem' }}>Option 1: Install via Download</h3>
<DesktopInstallButtons/>
<MacDesktopInstallButtons/>
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded zip file.
2. Run the executable file to launch the Goose desktop application.
2. Run the executable file to launch the Goose Desktop application.
:::tip Updating Goose
It's best to keep Goose updated by periodically running the installation steps again.
@@ -40,7 +40,7 @@ import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
---
<div style={{ marginTop: '1rem' }}>
:::note Permissions
If you're on an Apple Mac M3 and the Goose desktop app shows no window on launch, check and update the following:
If you're on an Apple Mac M3 and the Goose Desktop app shows no window on launch, check and update the following:
Ensure the `~/.config` directory has read and write access.
@@ -97,37 +97,58 @@ import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
</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).
Choose to install Goose on CLI and/or Desktop:
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:
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
Install Goose Desktop directly from the browser.
<h3 style={{ marginTop: '1rem' }}>Install via Download</h3>
<WindowsDesktopInstallButtons/>
```bash
wsl --install
```
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded zip file.
2. Run the executable file to launch the Goose Desktop application.
2. If prompted, restart your computer to complete the WSL installation. Once restarted, or if WSL is already installed, launch your Ubuntu shell by running:
:::tip Updating Goose
It's best to keep Goose updated by periodically running the installation steps again.
:::
</div>
</TabItem>
<TabItem value="cli" label="Goose CLI">
There isn't native installation support for Windows CLI, however you can run Goose using WSL (Windows Subsystem for Linux).
```bash
wsl -d Ubuntu
```
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:
3. 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
wsl --install
```
```bash
sudo apt update && sudo apt install bzip2 -y
```
:::
2. If prompted, restart your computer to complete the WSL installation. Once restarted, or if WSL is already installed, launch your Ubuntu shell by running:
If you'd like to install without interactive configuration, disable `CONFIGURE`:
```bash
wsl -d Ubuntu
```
```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
```
3. 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
```
:::
If you'd like to install without interactive configuration, disable `CONFIGURE`:
```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
```
</TabItem>
</Tabs>
</TabItem>
</Tabs>