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

Updating docs to match new UI (#3552)

Browse Source
This commit is contained in:
Rizel Scarlett
2025-07-21 16:04:53 -04:00
committed by GitHub
parent 6c951d4881
commit e012e076f4
7 changed files with 79 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -7,7 +7,7 @@ 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';
import { PanelLeft } from 'lucide-react';
# Install Goose
@@ -291,10 +291,12 @@ Goose works with a set of [supported LLM providers][providers], and you'll need
<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`.
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
2. Click the `Settings` button on the sidebar.
3. Click the `Models` tab.
4. Click `Configure Providers`
5. Choose your provider
6. Click `Configure`, enter your API key, and click `Submit`.
</TabItem>
<TabItem value="cli" label="Goose CLI">
@@ -361,8 +363,8 @@ While core configurations are shared between interfaces, extensions have flexibi
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
Navigate to shared configurations through:
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
2. Click the `Settings` button on the sidebar.
</TabItem>
<TabItem value="cli" label="Goose CLI">
Use the following command to manage shared configurations:

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

@@ -5,6 +5,7 @@ title: Configure LLM Provider
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { PanelLeft } from 'lucide-react';
# Supported LLM Providers
@@ -57,16 +58,18 @@ To configure your chosen provider or see available options, run `goose configure
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
**To update your LLM provider and API key:**
1. Click the gear on the Goose Desktop toolbar
1. Click `Advanced Settings`
1. Under `Models`, click `Configure provider`
1. Click `Configure` on the LLM provider to update
1. Add additional configurations (API key, host, etc) then press `submit`
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
2. Click the `Settings` button on the sidebar
3. Click the `Models` tab
4. Click `Configure Providers`
5. Click `Configure` on the LLM provider to update
6. Add additional configurations (API key, host, etc) then press `submit`
**To change provider model**
1. Click the gear on the Goose Desktop toolbar
2. Click `Advanced Settings`
3. Under `Models`, click `Switch models`
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
2. Click the `Settings` button on the sidebar
3. Click the `Models` tab
4. Click `Switch models`
5. Select a Provider from drop down menu
6. Select a model from drop down menu
7. Press `Select Model`
@@ -204,8 +207,8 @@ Goose supports using custom OpenAI-compatible endpoints, which is particularly u
<Tabs groupId="interface">
<TabItem value="ui" label="Goose Desktop" default>
1. Click `...` in the upper right corner
2. Click `Advanced Settings`
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar
2. Click the `Settings` button on the sidebar
3. Next to `Models`, click the `browse` link
4. Click the `configure` link in the upper right corner
5. Press the `+` button next to OpenAI
@@ -252,10 +255,12 @@ To set up Google Gemini with Goose, follow these steps:
<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`.
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
2. Click the `Settings` button on the sidebar.
3. Click the `Models` tab.
4. Click `Configure Providers`
5. Choose `Google Gemini` as provider from the list.
6. Click `Configure`, enter your API key, and click `Submit`.
</TabItem>
<TabItem value="cli" label="Goose CLI">
@@ -507,8 +512,8 @@ ollama run michaelneale/deepseek-r1-goose
<Tabs groupId="interface">
<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.
3. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
4. Click `Settings` -> `Models` -> `Configure Providers` -> and select `Ollama` from the list.
5. Enter `michaelneale/deepseek-r1-goose` for the model name.
</TabItem>
<TabItem value="cli" label="Goose CLI">

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

@@ -5,6 +5,7 @@ title: Using Extensions
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import { PanelLeft } from 'lucide-react';
Extensions are add-ons that provide a way to extend the functionality of Goose by connecting with applications and tools you already use in your workflow. These extensions can be used to add new features, access data and resources, or integrate with other systems.
@@ -31,8 +32,8 @@ Here are the 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.
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
2. Click the `Extensions` button on the sidebar.
3. Under `Extensions`, you can toggle the built-in extensions on or off.
</TabItem>
@@ -115,8 +116,8 @@ See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/s
<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.
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
2. Click the `Extensions` button on the sidebar.
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
@@ -343,8 +344,8 @@ You can enable or disable installed extensions based on your workflow needs.
<Tabs groupId="interface">
<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.
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
2. Click the `Extensions` button on the sidebar.
2. Use the toggle switch next to each extension to enable or disable it.
</TabItem>
@@ -506,8 +507,8 @@ You can remove installed 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.
1. Click the <PanelLeft className="inline" size={16} /> button in the top-left to open the sidebar.
2. Click the `Extensions` button on the sidebar.
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`.