From e1bdb1714d3980e73e967d0f5d7f948c08c063bf Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Wed, 18 Jun 2025 13:36:33 -0400 Subject: [PATCH 1/5] Docs: Goose on Windows Installation --- .../docs/getting-started/installation.md | 77 ++++++++++++------- documentation/docs/guides/updating-goose.md | 73 +++++++++++------- documentation/docs/quickstart.md | 12 ++- ...Buttons.js => MacDesktopInstallButtons.js} | 0 .../WindowsDesktopInstallButtons.js | 20 +++++ 5 files changed, 124 insertions(+), 58 deletions(-) rename documentation/src/components/{DesktopInstallButtons.js => MacDesktopInstallButtons.js} (100%) create mode 100644 documentation/src/components/WindowsDesktopInstallButtons.js diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index 48924fbad81b..80ca0408a093 100644 --- a/documentation/docs/getting-started/installation.md +++ b/documentation/docs/getting-started/installation.md @@ -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/).

Option 1: Install via Download

- +
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'; ---
:::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'; - 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: + + + Install Goose Desktop directly from the browser. + +

Install via Download

+ - ```bash - wsl --install - ``` +
+ 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. + ::: +
+ + + 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 + ``` + + diff --git a/documentation/docs/guides/updating-goose.md b/documentation/docs/guides/updating-goose.md index 53e0334e4fe5..e1c740bef565 100644 --- a/documentation/docs/guides/updating-goose.md +++ b/documentation/docs/guides/updating-goose.md @@ -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. - - + + + + :::info To update Goose to the latest stable version, reinstall using the instructions below :::
- 1. + 1. 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.
- - - You can update Goose by running: + + + You can update Goose by running: - ```sh - goose update - ``` + ```sh + goose update + ``` - Additional [options](/docs/guides/goose-cli-commands#update-options): - - ```sh - # Update to latest canary (development) version - goose update --canary + 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 - ``` + # Update and reconfigure settings + goose update --reconfigure + ``` - Or you can run the [installation](/docs/getting-started/installation) script again: + 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 - ``` + ```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: + To check your current Goose version, use the following command: - ```sh - goose --version - ``` + ```sh + goose --version + ``` + + + + + + + :::info + To update Goose to the latest stable version, reinstall using the instructions below + ::: +
+ 1. + 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. +
+ + \ No newline at end of file diff --git a/documentation/docs/quickstart.md b/documentation/docs/quickstart.md index da725c820fe7..0c158081d4b3 100644 --- a/documentation/docs/quickstart.md +++ b/documentation/docs/quickstart.md @@ -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 - +
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 - Desktop version is currently unavailable for Windows. + +
+ 1. Unzip the downloaded zip file. + 2. Run the executable file to launch the Goose Desktop application. +
There isn't native installation support for Windows, however you can run Goose using WSL (Windows Subsystem for Linux). diff --git a/documentation/src/components/DesktopInstallButtons.js b/documentation/src/components/MacDesktopInstallButtons.js similarity index 100% rename from documentation/src/components/DesktopInstallButtons.js rename to documentation/src/components/MacDesktopInstallButtons.js diff --git a/documentation/src/components/WindowsDesktopInstallButtons.js b/documentation/src/components/WindowsDesktopInstallButtons.js new file mode 100644 index 000000000000..08797d242a02 --- /dev/null +++ b/documentation/src/components/WindowsDesktopInstallButtons.js @@ -0,0 +1,20 @@ +import Link from "@docusaurus/Link"; +import { IconDownload } from "@site/src/components/icons/download"; + +const WindowsDesktopInstallButtons = () => { + return ( +
+

To download Goose Desktop for Windows, click the buttons below:

+
+ + Windows + +
+
+ ); +}; + +export default WindowsDesktopInstallButtons; From 36be9ad600fef2e0f233b29abbc4f3e788e6b193 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Wed, 18 Jun 2025 13:47:04 -0400 Subject: [PATCH 2/5] update Supported environments --- documentation/src/components/SupportedEnvironments.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/src/components/SupportedEnvironments.js b/documentation/src/components/SupportedEnvironments.js index 1f7a5d00c0a1..b1645cee987a 100644 --- a/documentation/src/components/SupportedEnvironments.js +++ b/documentation/src/components/SupportedEnvironments.js @@ -5,8 +5,7 @@ const SupportedEnvironments = () => { return ( The Goose CLI 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{" "} + On Windows, Goose CLI can run via WSL, and Goose Desktop is natively supported. If you'd like to request support for additional operating systems, please{" "} Date: Wed, 18 Jun 2025 13:55:27 -0400 Subject: [PATCH 3/5] link --- documentation/src/components/WindowsDesktopInstallButtons.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/src/components/WindowsDesktopInstallButtons.js b/documentation/src/components/WindowsDesktopInstallButtons.js index 08797d242a02..f837b2588711 100644 --- a/documentation/src/components/WindowsDesktopInstallButtons.js +++ b/documentation/src/components/WindowsDesktopInstallButtons.js @@ -8,7 +8,7 @@ const WindowsDesktopInstallButtons = () => {
Windows From 3015ae37832a0ad2e2606ad913236758fc534b85 Mon Sep 17 00:00:00 2001 From: Rizel Scarlett Date: Wed, 18 Jun 2025 14:04:47 -0400 Subject: [PATCH 4/5] singular button --- documentation/src/components/WindowsDesktopInstallButtons.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/src/components/WindowsDesktopInstallButtons.js b/documentation/src/components/WindowsDesktopInstallButtons.js index f837b2588711..7ef5c563f537 100644 --- a/documentation/src/components/WindowsDesktopInstallButtons.js +++ b/documentation/src/components/WindowsDesktopInstallButtons.js @@ -4,7 +4,7 @@ import { IconDownload } from "@site/src/components/icons/download"; const WindowsDesktopInstallButtons = () => { return (
-

To download Goose Desktop for Windows, click the buttons below:

+

To download Goose Desktop for Windows, click the button below:

Date: Wed, 18 Jun 2025 11:09:45 -0700 Subject: [PATCH 5/5] Update documentation/docs/guides/updating-goose.md --- documentation/docs/guides/updating-goose.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/docs/guides/updating-goose.md b/documentation/docs/guides/updating-goose.md index e1c740bef565..32801aad0e2c 100644 --- a/documentation/docs/guides/updating-goose.md +++ b/documentation/docs/guides/updating-goose.md @@ -69,7 +69,7 @@ The Goose CLI and desktop apps are under active and continuous development. To g 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. + 5. Run the executable file to launch the Goose Desktop application.