Skip to content

docs: auto download updates #6163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dianed-square merged 3 commits into from
Dec 18, 2025
Merged

docs: auto download updates #6163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
39937c1
auto download updates
dianed-square Dec 18, 2025
f703cc7
two more notes
dianed-square Dec 18, 2025
341a108
remove dupe step
dianed-square Dec 18, 2025
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
6 changes: 3 additions & 3 deletions documentation/docs/getting-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import { PanelLeft } from 'lucide-react';
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.
It's best to periodically [update goose](/docs/guides/updating-goose).
:::
</div>
<h3>Option 2: Install via Homebrew</h3>
Expand Down Expand Up @@ -99,7 +99,7 @@ import { PanelLeft } from 'lucide-react';
4. Launch goose from the app menu

:::tip Updating goose
It's best to keep goose updated by periodically running the installation steps again.
It's best to periodically [update goose](/docs/guides/updating-goose).
:::
</div>
</TabItem>
Expand Down Expand Up @@ -142,7 +142,7 @@ import { PanelLeft } from 'lucide-react';
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.
It's best to periodically [update goose](/docs/guides/updating-goose).
:::
</div>
</TabItem>
Expand Down
65 changes: 31 additions & 34 deletions documentation/docs/guides/updating-goose.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ sidebar_label: Updating goose

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { DesktopAutoUpdateSteps } from '@site/src/components/DesktopAutoUpdateSteps';
import MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons';
import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons';
import LinuxDesktopInstallButtons from '@site/src/components/LinuxDesktopInstallButtons';
Expand All @@ -16,16 +17,16 @@ The goose CLI and desktop apps are under active and continuous development. To g
<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. <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>
Update goose to the latest stable version.

<DesktopAutoUpdateSteps />

**To manually download and install updates:**
1. <MacDesktopInstallButtons/>
2. Unzip the downloaded zip file
3. Drag the extracted `Goose.app` file to the `Applications` folder to overwrite your current version
4. Launch goose Desktop

</TabItem>
<TabItem value="cli" label="goose CLI">
You can update goose by running:
Expand Down Expand Up @@ -62,19 +63,17 @@ The goose CLI and desktop apps are under active and continuous development. To g
<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/>

**For Debian/Ubuntu-based distributions:**
2. Download the DEB file
3. Navigate to the directory where it is saved in a terminal
4. Run `sudo dpkg -i (filename).deb`
5. Launch goose from the app menu

</div>
Update goose to the latest stable version.

<DesktopAutoUpdateSteps />

**To manually download and install updates:**
1. <LinuxDesktopInstallButtons/>

#### For Debian/Ubuntu-based distributions
2. In a terminal, navigate to the downloaded DEB file
3. Run `sudo dpkg -i (filename).deb`
4. Launch goose from the app menu
</TabItem>
<TabItem value="cli" label="goose CLI">
You can update goose by running:
Expand Down Expand Up @@ -111,16 +110,14 @@ The goose CLI and desktop apps are under active and continuous development. To g
<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>
Update goose to the latest stable version.

<DesktopAutoUpdateSteps />

**To manually download and install updates:**
1. <WindowsDesktopInstallButtons/>
2. Unzip the downloaded zip file
3. Run the executable file to launch the goose Desktop app
Copy link

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Windows manual update instructions are incomplete compared to macOS and Linux. The instructions stop after "Run the executable file to launch the goose Desktop app" but don't clarify that this step should overwrite the existing installation. For consistency with macOS (which says "to overwrite your current version") and clarity, consider adding a note about overwriting the existing installation or restructuring steps to match the macOS pattern.

Suggested change
3. Run the executable file to launch the goose Desktop app
3. Replace your existing goose Desktop installation with the files from the unzipped folder (overwrite when prompted)
4. Run the executable file to launch the goose Desktop app

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@dianed-square dianed-square Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you just run the executable on Windows

</TabItem>
<TabItem value="cli" label="goose CLI">
You can update goose by running:
Expand Down Expand Up @@ -164,4 +161,4 @@ The goose CLI and desktop apps are under active and continuous development. To g
</TabItem>
</Tabs>
</TabItem>
</Tabs>
</Tabs>
2 changes: 1 addition & 1 deletion documentation/src/components/CLIExtensionInstructions.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ ${

<ol start={5}>
<li>
Enter the number of seconds Goose should wait for actions to complete before timing out. Default is{' '}
Enter the number of seconds goose should wait for actions to complete before timing out. Default is{' '}
<code>300</code> seconds.
</li>
</ol>
Expand Down
23 changes: 23 additions & 0 deletions documentation/src/components/DesktopAutoUpdateSteps.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import React from "react";
import { PanelLeft } from "lucide-react";

export const DesktopAutoUpdateSteps = () => {
return (
<>
<p><strong>To automatically download and install updates:</strong></p>
<ol>
<li>Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar</li>
<li>Click <code>Settings</code> in the sidebar</li>
<li>Click <code>App</code></li>
<li>Scroll down to the <code>Updates</code> section:
<ul>
<li>Check if your current version is "up to date" or if a newer version is available</li>
<li>To automatically download the newer version, click <code>Check for Updates</code></li>
Copy link

Copilot AI Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instruction states "To automatically download the newer version, click Check for Updates", but this is misleading. The button checks for updates and downloads them if available - it's not solely for downloading. Consider rephrasing to "Click Check for Updates to download the newer version" or "Click Check for Updates to check and download the newer version if available".

Suggested change
<li>To automatically download the newer version, click <code>Check for Updates</code></li>
<li>Click <code>Check for Updates</code> to check for and download the newer version if available</li>

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

@dianed-square dianed-square Dec 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The check happens on app startup and you see "up to date" or "-> 1.16.1 available" when you view the App tab so I don't think we need to mention a second check here

</ul>
</li>
<li>Click <code>Install & Restart</code> to immediately relaunch goose Desktop and apply the update<br />
<strong>Note:</strong> If the app can't be automatically updated, you'll be prompted to manually install the downloaded version</li>
</ol>
</>
);
};
2 changes: 1 addition & 1 deletion documentation/src/components/LinuxDesktopInstallButtons.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ const LinuxDesktopInstallButtons = () => {

return (
<div>
<p>To download Goose Desktop for Linux, click one of the buttons below:</p>
<p>Click one of the buttons below to download goose Desktop for Linux:</p>
<div className="pill-button" style={{ display: 'flex', gap: '0.5rem', flexWrap: 'wrap' }}>
<Link
className="button button--primary button--lg"
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/components/MacDesktopInstallButtons.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { IconDownload } from "@site/src/components/icons/download";
const DesktopInstallButtons = () => {
return (
<div>
<p>To download Goose Desktop for macOS, click one of the buttons below:</p>
<p>Click one of the buttons below to download goose Desktop for macOS:</p>
<div className="pill-button">
<Link
className="button button--primary button--lg"
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/components/ModelSelectionTip.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ import React from "react";

export const ModelSelectionTip = () => {
return (
<p>Goose relies heavily on tool calling capabilities and currently works best with Claude 4 models.</p>
<p>goose relies heavily on tool calling capabilities and currently works best with Claude 4 models.</p>
);
};
2 changes: 1 addition & 1 deletion documentation/src/components/OnboardingProviderSetup.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export const OnboardingProviderSetup = () => {
</h5>
</div>
<div className="admonition-content" style={{paddingBottom: '1rem'}}>
<p style={{marginBottom: '0'}}>You'll receive $10 in free credits the first time you automatically authenticate with Tetrate through Goose. This offer is available to both new and existing Tetrate users.</p>
<p style={{marginBottom: '0'}}>You'll receive $10 in free credits the first time you automatically authenticate with Tetrate through goose. This offer is available to both new and existing Tetrate users.</p>
</div>
</div>
</li>
Expand Down
2 changes: 1 addition & 1 deletion documentation/src/components/RateLimits.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export const RateLimits = () => {
<a href="/goose/docs/guides/handling-llm-rate-limits-with-goose" target="_blank">
Handling Rate Limits
</a>{" "}
guide to learn how to efficiently manage these limits while using Goose.
guide to learn how to efficiently manage these limits while using goose.
</Admonition>
);
};
4 changes: 2 additions & 2 deletions documentation/src/components/SupportedEnvironments.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import Admonition from "@theme/Admonition";
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, and Goose Desktop is natively supported. If you'd like to request support for additional operating systems, please{" "}
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, 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
2 changes: 1 addition & 1 deletion documentation/src/components/WindowsDesktopInstallButtons.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { IconDownload } from "@site/src/components/icons/download";
const WindowsDesktopInstallButtons = () => {
return (
<div>
<p>To download Goose Desktop for Windows, click the button below:</p>
<p>Click one of the buttons below to download goose Desktop for Windows:</p>
<div className="pill-button">
<Link
className="button button--primary button--lg"
Expand Down
4 changes: 2 additions & 2 deletions documentation/src/components/recipe-card.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ export function RecipeCard({ recipe }: { recipe: Recipe }) {
rel="noopener noreferrer"
onClick={(e) => e.stopPropagation()}
>
Launch in Goose Desktop →
Launch in goose Desktop →
</a>

<div className="relative group">
Expand Down Expand Up @@ -177,7 +177,7 @@ export function RecipeCard({ recipe }: { recipe: Recipe }) {
onClick={handleSubmitParams}
className="bg-purple-600 text-white px-4 py-2 rounded text-sm hover:bg-purple-700"
>
Copy Goose CLI Command
Copy goose CLI Command
</button>
</div>
</div>
Expand Down
Loading