Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 49 additions & 28 deletions documentation/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand All @@ -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.

Expand Down Expand Up @@ -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>

Expand Down
73 changes: 47 additions & 26 deletions documentation/docs/guides/updating-goose.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
</TabItem>
<TabItem value="cli" label="Goose CLI">
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
```
</TabItem>
</Tabs>
</TabItem>

<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 changes: 8 additions & 4 deletions documentation/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down Expand Up @@ -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).
Expand Down
3 changes: 1 addition & 2 deletions documentation/src/components/SupportedEnvironments.js
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
20 changes: 20 additions & 0 deletions documentation/src/components/WindowsDesktopInstallButtons.js
Original file line number Diff line number Diff line change
@@ -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;