aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-17 22:24:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: switching Goose Desktop and Goose CLI tabs (#2384)

Browse Source
This commit is contained in:
Rizel Scarlett
2025-04-29 12:21:06 -04:00
committed by GitHub
parent 2dc2301fa4
commit 8f7fe26461
38 changed files with 552 additions and 556 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
documentation/docs/getting-started/installation.md
View File

@@ -18,28 +18,7 @@ import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
Choose to install Goose on CLI and/or Desktop:
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
Run the following command to install the latest version of Goose on macOS:
```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>
<TabItem value="ui" label="Goose Desktop">
<TabItem value="ui" label="Goose Desktop" default>
Install Goose directly from the browser or with [Homebrew](https://brew.sh/).
<h3 style={{ marginTop: '1rem' }}>Option 1: Install via Download</h3>
@@ -61,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.
@@ -69,6 +48,27 @@ import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
:::
</div>
</TabItem>
<TabItem value="cli" label="Goose CLI">
Run the following command to install the latest version of Goose on macOS:
```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>
@@ -119,10 +119,17 @@ import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons';
</Tabs>
## Set LLM Provider
Goose works with a set of [supported LLM providers][providers], and you’ll need an API key to get started. When you use Goose for the first time, you’ll be prompted to select a provider and enter your API key.
Goose works with a set of [supported LLM providers][providers], and you'll need an API key to get started. When you use Goose for the first time, you'll be prompted to select a provider and enter your API key.
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
Upon installing, the Provider screen will appear. Here is where you can choose your LLM Provider.
![Set Up a Provider UI](../assets/guides/set-up-provider-ui.png)
Once selecting your provider, you'll be prompted to enter an API key if applicable. Do so, and click `Submit`.
</TabItem>
<TabItem value="cli" label="Goose CLI">
Upon installing, Goose will automatically enter its configuration screen. Here is where you can set up your LLM provider.
:::tip Windows Users
@@ -167,18 +174,20 @@ Goose works with a set of [supported LLM providers][providers], and you’ll nee
```
:::
</TabItem>
<TabItem value="ui" label="Goose Desktop">
Upon installing, the Provider screen will appear. Here is where you can choose your LLM Provider.
![Set Up a Provider UI](../assets/guides/set-up-provider-ui.png)
Once selecting your provider, you'll be prompted to enter an API key if applicable. Do so, and click `Submit`.
</TabItem>
</Tabs>
## Update Provider
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
**To update your LLM provider and API key:**
1. Click on the three dots in the top-right corner.
2. Select `Provider Settings` from the menu.
2. Choose a provider from the list.
3. Click Edit, enter your API key, and click `Set as Active`.
</TabItem>
<TabItem value="cli" label="Goose CLI">
**To update your LLM provider and API key:**
1. Run the following command:
```sh
@@ -211,15 +220,6 @@ Goose works with a set of [supported LLM providers][providers], and you’ll nee
└ Configuration saved successfully
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
**To update your LLM provider and API key:**
1. Click on the three dots in the top-right corner.
2. Select `Provider Settings` from the menu.
2. Choose a provider from the list.
3. Click Edit, enter your API key, and click `Set as Active`.
</TabItem>
</Tabs>
<RateLimits />
@@ -227,17 +227,17 @@ Goose works with a set of [supported LLM providers][providers], and you’ll nee
## Running Goose
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
Starting a session in the Goose Desktop is straightforward. After choosing your provider, you'll see the session interface ready for use.
Type your questions, tasks, or instructions directly into the input field, and Goose will get to work immediately.
</TabItem>
<TabItem value="cli" label="Goose CLI">
From your terminal, navigate to the directory you'd like to start from and run:
```sh
goose session
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
Starting a session in the Goose Desktop is straightforward. After choosing your provider, you’ll see the session interface ready for use.
Type your questions, tasks, or instructions directly into the input field, and Goose will get to work immediately.
</TabItem>
</Tabs>
## Shared Configuration Settings
@@ -249,17 +249,17 @@ While core configurations are shared between interfaces, extensions have flexibi
:::
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
Navigate to shared configurations through:
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
</TabItem>
<TabItem value="cli" label="Goose CLI">
Use the following command to manage shared configurations:
```sh
goose configure
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
Navigate to shared configurations through:
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
</TabItem>
</Tabs>
## Additional Resources
@@ -269,4 +269,4 @@ You can also configure Extensions to extend Goose's functionality, including add
[using-extensions]: /docs/getting-started/using-extensions
[providers]: /docs/getting-started/providers
[handling-rate-limits]: /docs/guides/handling-llm-rate-limits-with-goose
[mcp]: https://www.anthropic.com/news/model-context-protocol
[mcp]: https://www.anthropic.com/news/model-context-protocol

98
documentation/docs/getting-started/providers.md
View File

@@ -37,7 +37,27 @@ Goose relies heavily on tool calling capabilities and currently works best with
To configure your chosen provider or see available options, run `goose configure` in the CLI or visit the `Provider Settings` page in the Goose Desktop.
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
**To update your LLM provider and API key:**
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
3. Next to `Models`, click `Browse`
4. Click `Configure` in the upper right corner
4. Press the `+` button next to the provider of your choice
5. Add additional configurations (API key, host, etc) then press `submit`
**To change provider model**
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
3. Next to `Models`, click `Browse`
4. Scroll down to `Add Model`
5. Select a Provider from drop down menu
6. Enter Model name
7. Press `+ Add Model`
You can explore more models by selecting a `provider` name under `Browse by Provider`. A link will appear, directing you to the provider's website. Once you've found the model you want, return to step 6 and paste the model name.
</TabItem>
<TabItem value="cli" label="Goose CLI">
1. Run the following command:
```sh
@@ -89,27 +109,6 @@ To configure your chosen provider or see available options, run `goose configure
└
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
**To update your LLM provider and API key:**
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
3. Next to `Models`, click `Browse`
4. Click `Configure` in the upper right corner
4. Press the `+` button next to the provider of your choice
5. Add additional configurations (API key, host, etc) then press `submit`
**To change provider model**
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
3. Next to `Models`, click `Browse`
4. Scroll down to `Add Model`
5. Select a Provider from drop down menu
6. Enter Model name
7. Press `+ Add Model`
You can explore more models by selecting a `provider` name under `Browse by Provider`. A link will appear, directing you to the provider's website. Once you've found the model you want, return to step 6 and paste the model name.
</TabItem>
</Tabs>
## Using Custom OpenAI Endpoints
@@ -171,17 +170,7 @@ Goose supports using custom OpenAI-compatible endpoints, which is particularly u
### Setup Instructions
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
1. Run `goose configure`
2. Select `Configure Providers`
3. Choose `OpenAI` as the provider
4. Enter your configuration when prompted:
- API key
- Host URL (if using custom endpoint)
- Organization ID (if using organization tracking)
- Project identifier (if using project management)
</TabItem>
<TabItem value="ui" label="Goose Desktop">
<TabItem value="ui" label="Goose Desktop" default>
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
3. Next to `Models`, click the `browse` link
@@ -194,6 +183,16 @@ Goose supports using custom OpenAI-compatible endpoints, which is particularly u
- Project (for resource management)
7. Press `submit`
</TabItem>
<TabItem value="cli" label="Goose CLI">
1. Run `goose configure`
2. Select `Configure Providers`
3. Choose `OpenAI` as the provider
4. Enter your configuration when prompted:
- API key
- Host URL (if using custom endpoint)
- Organization ID (if using organization tracking)
- Project identifier (if using project management)
</TabItem>
</Tabs>
:::tip Enterprise Deployment
@@ -217,7 +216,16 @@ Google Gemini provides a free tier. To start using the Gemini API with Goose, yo
To set up Google Gemini with Goose, follow these steps:
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
**To update your LLM provider and API key:**
1. Click on the three dots in the top-right corner.
2. Select `Provider Settings` from the menu.
2. Choose `Google Gemini` as provider from the list.
3. Click Edit, enter your API key, and click `Set as Active`.
</TabItem>
<TabItem value="cli" label="Goose CLI">
1. Run:
```sh
goose configure
@@ -246,16 +254,6 @@ To set up Google Gemini with Goose, follow these steps:
│
└ Configuration saved successfully
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
**To update your LLM provider and API key:**
1. Click on the three dots in the top-right corner.
2. Select `Provider Settings` from the menu.
2. Choose `Google Gemini` as provider from the list.
3. Click Edit, enter your API key, and click `Set as Active`.
</TabItem>
</Tabs>
@@ -375,7 +373,12 @@ ollama run michaelneale/deepseek-r1-goose
```
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
3. Click `...` in the top-right corner.
4. Navigate to `Advanced Settings` -> `Browse Models` -> and select `Ollama` from the list.
5. Enter `michaelneale/deepseek-r1-goose` for the model name.
</TabItem>
<TabItem value="cli" label="Goose CLI">
3. In a separate terminal window, configure with Goose:
```sh
@@ -451,11 +454,6 @@ ollama run michaelneale/deepseek-r1-goose
└ Configuration saved successfully
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
3. Click `...` in the top-right corner.
4. Navigate to `Advanced Settings` -> `Browse Models` -> and select `Ollama` from the list.
5. Enter `michaelneale/deepseek-r1-goose` for the model name.
</TabItem>
</Tabs>
---

87
documentation/docs/getting-started/using-extensions.md
View File

@@ -30,8 +30,13 @@ Here are the built-in extensions:
#### Toggling Built-in Extensions
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
1. Click `...` in the top right corner of the Goose Desktop.
2. Select `Advanced Settings` from the menu.
3. Under `Extensions`, you can toggle the built-in extensions on or off.
</TabItem>
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="cli" label="Goose CLI">
If you know the exact name of the extension you'd like to add, run:
@@ -46,7 +51,7 @@ Here are the built-in extensions:
goose configure
```
2. Select `Add Extension` from the menu.
3. Choose the type of extension you’d like to add:
3. Choose the type of extension you'd like to add:
- `Built-In Extension`: Use an extension that comes pre-installed with Goose.
- `Command-Line Extension`: Add a local command or script to run as an extension.
- `Remote Extension`: Connect to a remote system via SSE (Server-Sent Events).
@@ -78,11 +83,6 @@ Here are the built-in extensions:
└ Enabled jetbrains extension
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
1. Click `...` in the top right corner of the Goose Desktop.
2. Select `Advanced Settings` from the menu.
3. Under `Extensions`, you can toggle the built-in extensions on or off.
</TabItem>
</Tabs>
@@ -112,7 +112,25 @@ See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/s
:::
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
1. Click `...` in the top right corner of the Goose Desktop.
2. Select `Advanced Settings` from the menu.
3. Under `Extensions`, click `Add custom extension`.
4. On the `Add custom extension` modal, enter the necessary details
- If adding an environment variable, click `Add` button to the right of the variable
- The `Timeout` field lets you set how long Goose should wait for a tool call from this extension to complete
5. Click `Add` button
#### Example of adding the [Knowledge Graph Memory MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/memory):
* **Type**: `Standard IO`
* **ID**: `kgm-mcp` (_set this to whatever you want_)
* **Name**: `Knowledge Graph Memory` (_set this to whatever you want_)
* **Description**: `maps and stores complex relationships between concepts` (_set this to whatever you want_)
* **Command**: `npx -y @modelcontextprotocol/server-memory`
</TabItem>
<TabItem value="cli" label="Goose CLI">
1. Run the following command:
@@ -226,23 +244,6 @@ Note: Java and Kotlin extensions are only support on Linux and macOS
</Tabs>
</TabItem>
<TabItem value="ui" label="Goose Desktop">
1. Click `...` in the top right corner of the Goose Desktop.
2. Select `Advanced Settings` from the menu.
3. Under `Extensions`, click `Add custom extension`.
4. On the `Add custom extension` modal, enter the necessary details
- If adding an environment variable, click `Add` button to the right of the variable
- The `Timeout` field lets you set how long Goose should wait for a tool call from this extension to complete
5. Click `Add` button
#### Example of adding the [Knowledge Graph Memory MCP Server](https://github.com/modelcontextprotocol/servers/tree/main/src/memory):
* **Type**: `Standard IO`
* **ID**: `kgm-mcp` (_set this to whatever you want_)
* **Name**: `Knowledge Graph Memory` (_set this to whatever you want_)
* **Description**: `maps and stores complex relationships between concepts` (_set this to whatever you want_)
* **Command**: `npx -y @modelcontextprotocol/server-memory`
</TabItem>
</Tabs>
### Config Entry
@@ -266,7 +267,14 @@ extensions:
You can enable or disable installed extensions based on your workflow needs.
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
<TabItem value="ui" label="Goose Desktop" default>
1. Click the three dots in the top-right corner of the application.
2. Select `Advanced Settings` from the menu, scroll down to the `Extensions` section.
2. Use the toggle switch next to each extension to enable or disable it.
</TabItem>
<TabItem value="cli" label="Goose CLI">
1. Run the following command to open up Goose's configurations:
```sh
goose configure
@@ -289,12 +297,6 @@ You can enable or disable installed extensions based on your workflow needs.
└
```
</TabItem>
<TabItem value="ui" label="Goose Desktop">
1. Click the three dots in the top-right corner of the application.
2. Select `Advanced Settings` from the menu, scroll down to the `Extensions` section.
2. Use the toggle switch next to each extension to enable or disable it.
</TabItem>
</Tabs>
@@ -303,7 +305,16 @@ You can enable or disable installed extensions based on your workflow needs.
You can remove installed extensions.
<Tabs groupId="interface">
<TabItem value="cli" label="Config file" default>
<TabItem value="ui" label="Goose Desktop" default>
1. Click `...` in the top right corner of the Goose Desktop.
2. Select `Advanced Settings` from the menu.
3. Under `Extensions`, find the extension you'd like to remove and click on the settings icon beside it.
4. In the dialog that appears, click `Remove Extension`.
</TabItem>
<TabItem value="cli" label="Config file">
:::info
To remove an extension, you must [disable](#enablingdisabling-extensions) it first.
:::
@@ -327,14 +338,6 @@ You can remove installed extensions.
```
5. Press Enter to save
</TabItem>
<TabItem value="ui" label="Goose Desktop">
1. Click `...` in the top right corner of the Goose Desktop.
2. Select `Advanced Settings` from the menu.
3. Under `Extensions`, find the extension you'd like to remove and click on the settings icon beside it.
4. In the dialog that appears, click `Remove Extension`.
</TabItem>
</Tabs>
@@ -422,4 +425,4 @@ goose session --with-remote-extension "http://localhost:8080/sse"
Goose extensions are implemented with MCP, a standard protocol that allows AI models and agents to securely connect with local or remote resources. Learn how to build your own [extension as an MCP server](https://modelcontextprotocol.io/quickstart/server).
[extensions-directory]: https://block.github.io/goose/v1/extensions
[extensions-directory]: https://block.github.io/goose/v1/extensions