docs: adding update command to cli command guide (#1411)

This commit is contained in:
Rizel Scarlett
2025-02-27 11:19:25 -05:00
committed by GitHub
parent ebf1749f3e
commit 7c1bd2d5e7
3 changed files with 50 additions and 15 deletions

View File

@@ -31,6 +31,13 @@ import RateLimits from '@site/src/components/RateLimits';
```sh ```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash 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> </TabItem>
<TabItem value="ui" label="Goose Desktop"> <TabItem value="ui" label="Goose Desktop">
To install Goose, click the **button** below: To install Goose, click the **button** below:
@@ -47,6 +54,10 @@ import RateLimits from '@site/src/components/RateLimits';
1. Unzip the downloaded `Goose.zip` file. 1. Unzip the downloaded `Goose.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. To update, reperform installation steps.
:::
:::note Permissions :::note Permissions
If youre on an Apple Mac M3 and the Goose desktop app shows no window on launch, check and update the following: If youre on an Apple Mac M3 and the Goose desktop app shows no window on launch, check and update the following:
@@ -55,7 +66,6 @@ import RateLimits from '@site/src/components/RateLimits';
Goose needs this access to create the log directory and file. Once permissions are granted, the app should load correctly. For steps on how to do this, refer to the [Troubleshooting Guide](/docs/troubleshooting.md#macos-permission-issues-m3-macs) Goose needs this access to create the log directory and file. Once permissions are granted, the app should load correctly. For steps on how to do this, refer to the [Troubleshooting Guide](/docs/troubleshooting.md#macos-permission-issues-m3-macs)
::: :::
</div> </div>
</TabItem> </TabItem>
</Tabs> </Tabs>
</TabItem> </TabItem>
@@ -104,14 +114,8 @@ import RateLimits from '@site/src/components/RateLimits';
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | CONFIGURE=false bash
``` ```
</TabItem> </TabItem>
</Tabs> </Tabs>
:::tip Updating Goose
Its best to keep Goose updated. To update, reperform installation steps.
:::
## Set LLM Provider ## Set LLM Provider
Goose works with a set of [supported LLM providers][providers], and youll need an API key to get started. When you use Goose for the first time, youll be prompted to select a provider and enter your API key. Goose works with a set of [supported LLM providers][providers], and youll need an API key to get started. When you use Goose for the first time, youll be prompted to select a provider and enter your API key.

View File

@@ -106,6 +106,30 @@ goose --version
--- ---
### update [options]
Update the Goose CLI to a newer version.
**Options:**
- **`--canary, -c`**: Update to the canary (development) version instead of the stable version
- **`--reconfigure, -r`**: Forces Goose to reset configuration settings during the update process
**Usage:**
```bash
# Update to latest stable version
goose update
# Update to latest canary version
goose update --canary
# Update and reconfigure settings
goose update --reconfigure
```
---
### mcp ### mcp
Run an enabled MCP server specified by `<name>` (e.g. 'Google Drive') Run an enabled MCP server specified by `<name>` (e.g. 'Google Drive')

View File

@@ -9,18 +9,24 @@ import TabItem from '@theme/TabItem';
import { IconDownload } from "@site/src/components/icons/download"; import { IconDownload } from "@site/src/components/icons/download";
import Link from "@docusaurus/Link"; import Link from "@docusaurus/Link";
:::info
To update Goose to the latest stable version, reinstall using the instructions below
:::
<Tabs groupId="interface"> <Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default> <TabItem value="cli" label="Goose CLI" default>
You can update Goose by simply running: You can update Goose by running:
```sh ```sh
goose update 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: Or you can run the [installation](/docs/getting-started/installation) script again:
```sh ```sh
@@ -35,6 +41,9 @@ To update Goose to the latest stable version, reinstall using the instructions b
</TabItem> </TabItem>
<TabItem value="ui" label="Goose Desktop"> <TabItem value="ui" label="Goose Desktop">
:::info
To update Goose to the latest stable version, reinstall using the instructions below
:::
<div style={{ marginTop: '1rem' }}> <div style={{ marginTop: '1rem' }}>
1. To update Goose Desktop, click the button below: 1. To update Goose Desktop, click the button below:
<div className="pill-button"> <div className="pill-button">
@@ -53,5 +62,3 @@ To update Goose to the latest stable version, reinstall using the instructions b
</div> </div>
</TabItem> </TabItem>
</Tabs> </Tabs>
All configuration settings will remain the same, with Goose updated to the latest version.