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
50 changes: 38 additions & 12 deletions documentation/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@ sidebar_position: 1
---
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 MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons';
import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons';
import LinuxDesktopInstallButtons from '@site/src/components/LinuxDesktopInstallButtons';


# Install Goose

<SupportedEnvironments />

<Tabs>
<TabItem value="mac" label="macOS" default>
Choose to install Goose on CLI and/or Desktop:
Expand Down Expand Up @@ -82,18 +80,46 @@ import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopIns
</TabItem>

<TabItem value="linux" label="Linux" default>
Run the following command to install the Goose CLI on Linux:
Choose to install Goose on CLI and/or Desktop:

```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | bash
```
This script will fetch the latest version of Goose and set it up on your system.
<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>
<LinuxDesktopInstallButtons/>

If you'd like to install without interactive configuration, disable `CONFIGURE`:
<div style={{ marginTop: '1rem' }}>
1. Extract the downloaded tar.bz2 file.
2. Run the executable file to launch the Goose Desktop application.

```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
```
:::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">
Run the following command to install the Goose CLI on Linux:

```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | bash
```
This script will fetch the latest version of Goose and set it up on your system.

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
```

:::tip Updating Goose
It's best to keep Goose updated. To update Goose, run:
```sh
goose update
```
:::
</TabItem>
</Tabs>
</TabItem>

<TabItem value="windows" label="Windows">
Expand Down
104 changes: 104 additions & 0 deletions documentation/docs/guides/updating-goose.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons';
import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons';
import LinuxDesktopInstallButtons from '@site/src/components/LinuxDesktopInstallButtons';

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.

Expand Down Expand Up @@ -58,6 +59,52 @@ The Goose CLI and desktop apps are under active and continuous development. To g
</Tabs>
</TabItem>

<TabItem value="linux" label="Linux">
<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. <LinuxDesktopInstallButtons/>
2. Extract the downloaded tar.bz2 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="windows" label="Windows">
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
Expand All @@ -72,6 +119,63 @@ The Goose CLI and desktop apps are under active and continuous development. To g
5. Run the executable file to launch the Goose Desktop application.
</div>
</TabItem>
<TabItem value="cli" label="Goose CLI">
There isn't native CLI support for Windows. You can run Goose CLI using WSL (Windows Subsystem for Linux).

**If you haven't set up WSL yet:**

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
wsl --install
```

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:

```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 already have Goose CLI installed in WSL, you can update it:**

```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 within WSL:

```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
```

To check your current Goose version within WSL, use:

```sh
goose --version
```
</TabItem>
</Tabs>
</TabItem>
</Tabs>
11 changes: 6 additions & 5 deletions documentation/docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,14 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import Link from "@docusaurus/Link";
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 MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons';
import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons';
import LinuxDesktopInstallButtons from '@site/src/components/LinuxDesktopInstallButtons';

# Goose in 5 minutes

<SupportedEnvironments />


Goose is an open source AI agent that supercharges your software development by automating coding tasks. This quick tutorial will guide you through getting started with Goose!


Expand Down Expand Up @@ -47,7 +44,11 @@ Goose is an open source AI agent that supercharges your software development by
<TabItem value="linux" label="Linux">
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
Desktop version is currently unavailable for Linux.
<LinuxDesktopInstallButtons/>
<div style={{ marginTop: '1rem' }}>
1. Extract the downloaded tar.bz2 file.
2. Run the executable file to launch the Goose Desktop application.
</div>
</TabItem>
<TabItem value="cli" label="Goose CLI">
Run the following command to install the Goose CLI on Linux:
Expand Down
32 changes: 32 additions & 0 deletions documentation/src/components/LinuxDesktopInstallButtons.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
import Link from "@docusaurus/Link";
import { IconDownload } from "@site/src/components/icons/download";

const LinuxDesktopInstallButtons = () => {
return (
<div>
<p>To download Goose Desktop for Linux, choose the buttons below:</p>
<div className="pill-button" style={{ display: 'flex', gap: '0.5rem', flexWrap: 'wrap' }}>
<Link
className="button button--primary button--lg"
to="https://github.com/block/goose/releases/download/v1.0.29/goose-x86_64-unknown-linux-gnu.tar.bz2"
>
<IconDownload /> Linux x86_64
</Link>
<Link
className="button button--primary button--lg"
to="https://github.com/block/goose/releases/download/v1.0.29/goose-aarch64-unknown-linux-gnu.tar.bz2"
>
<IconDownload /> Linux ARM64
</Link>
<Link
className="button button--secondary button--lg"
to="https://github.com/block/goose/releases/download/v1.0.29/Goose-1.0.29-1.x86_64.rpm"
>
<IconDownload /> RPM Package
</Link>
</div>
</div>
);
};

export default LinuxDesktopInstallButtons;
Loading