diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index 48924fba..80ca0408 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 53e0334e..32801aad 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: + + ```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 + ``` + + - - 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 - ``` + + + + :::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 da725c82..0c158081 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/SupportedEnvironments.js b/documentation/src/components/SupportedEnvironments.js index 1f7a5d00..b1645cee 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{" "} { + return ( +
+

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

+
+ + Windows + +
+
+ ); +}; + +export default WindowsDesktopInstallButtons;