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.
```bash
wsl --install
```
<h3 style={{ marginTop: '1rem' }}>Install via Download</h3>
<WindowsDesktopInstallButtons/>
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:
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded zip file.
2. Run the executable file to launch the Goose Desktop application.
```bash
wsl -d Ubuntu
```
:::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).
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:
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
sudo apt update && sudo apt install bzip2 -y
```
:::
```bash
wsl --install
```
If you'd like to install without interactive configuration, disable `CONFIGURE`:
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:
```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
```
```bash
wsl -d Ubuntu
```
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>

85
documentation/docs/guides/updating-goose.md
View File

@@ -6,51 +6,72 @@ sidebar_label: Updating Goose
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
import MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons';
import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons';
The Goose CLI and desktop apps are under active and continuous development. To get the newest features and fixes, you should periodically update your Goose client using the following instructions.
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
<Tabs>
<TabItem value="mac" label="macOS" default>
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
:::info
To update Goose to the latest stable version, reinstall using the instructions below
:::
<div style={{ marginTop: '1rem' }}>
1. <DesktopInstallButtons/>
1. <MacDesktopInstallButtons/>
2. Unzip the downloaded zip file.
3. Run the executable file to launch the Goose Desktop application.
4. Overwrite the existing Goose application with the new version.
5. Run the executable file to launch the Goose desktop application.
</div>
</TabItem>
<TabItem value="cli" label="Goose CLI">
You can update Goose by running:
```sh
goose update
```
Additional [options](/docs/guides/goose-cli-commands#update-options):
```sh
# Update to latest canary (development) version
goose update --canary
# Update and reconfigure settings
goose update --reconfigure
```
Or you can run the [installation](/docs/getting-started/installation) script again:
```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
```
To check your current Goose version, use the following command:
```sh
goose --version
```
</TabItem>
</Tabs>
</TabItem>
<TabItem value="cli" label="Goose CLI">
You can update Goose by running:
```sh
goose update
```
Additional [options](/docs/guides/goose-cli-commands#update-options):
```sh
# Update to latest canary (development) version
goose update --canary
# Update and reconfigure settings
goose update --reconfigure
```
Or you can run the [installation](/docs/getting-started/installation) script again:
```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
```
To check your current Goose version, use the following command:
```sh
goose --version
```
<TabItem value="windows" label="Windows">
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
:::info
To update Goose to the latest stable version, reinstall using the instructions below
:::
<div style={{ marginTop: '1rem' }}>
1. <WindowsDesktopInstallButtons/>
2. Unzip the downloaded zip file.
3. Run the executable file to launch the Goose Desktop application.
4. Overwrite the existing Goose application with the new version.
5. Run the executable file to launch the Goose Desktop application.
</div>
</TabItem>
</Tabs>
</TabItem>
</Tabs>

12
documentation/docs/quickstart.md
View File

@@ -9,8 +9,8 @@ import { IconDownload } from "@site/src/components/icons/download";
import SupportedEnvironments from '@site/src/components/SupportedEnvironments';
import RateLimits from '@site/src/components/RateLimits';
import YouTubeShortEmbed from '@site/src/components/YouTubeShortEmbed';
import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
import MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons';
import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons';
# Goose in 5 minutes
@@ -28,7 +28,7 @@ Goose is an open source AI agent that supercharges your software development by
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
<DesktopInstallButtons/>
<MacDesktopInstallButtons/>
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded zip file.
2. Run the executable file to launch the Goose Desktop application.
@@ -62,7 +62,11 @@ Goose is an open source AI agent that supercharges your software development by
<TabItem value="windows" label="Windows">
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
Desktop version is currently unavailable for Windows.
<WindowsDesktopInstallButtons/>
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded zip file.
2. Run the executable file to launch the Goose Desktop application.
</div>
</TabItem>
<TabItem value="cli" label="Goose CLI">
There isn't native installation support for Windows, however you can run Goose using WSL (Windows Subsystem for Linux).

0
documentation/src/components/DesktopInstallButtons.js → documentation/src/components/MacDesktopInstallButtons.js
View File

3
documentation/src/components/SupportedEnvironments.js
View File

@@ -5,8 +5,7 @@ const SupportedEnvironments = () => {
return (
<Admonition type="info" title="Supported Environments">
The Goose CLI 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{" "}
On <strong>Windows</strong>, Goose CLI can run via WSL, and Goose Desktop is natively supported. If you'd like to request support for additional operating systems, please{" "}
<a
href="https://github.com/block/goose/discussions/867"
target="_blank"

20
documentation/src/components/WindowsDesktopInstallButtons.js Normal file
View File

@@ -0,0 +1,20 @@
import Link from "@docusaurus/Link";
import { IconDownload } from "@site/src/components/icons/download";
const WindowsDesktopInstallButtons = () => {
return (
<div>
<p>To download Goose Desktop for Windows, click the button below:</p>
<div className="pill-button">
<Link
className="button button--primary button--lg"
to="https://github.com/block/goose/releases/download/v1.0.29/Goose-win32-x64.zip"
>
<IconDownload /> Windows
</Link>
</div>
</div>
);
};
export default WindowsDesktopInstallButtons;