diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index b6c0f99c..2c3e696c 100644 --- a/documentation/docs/getting-started/installation.md +++ b/documentation/docs/getting-started/installation.md @@ -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 **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 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`. @@ -361,8 +363,8 @@ While core configurations are shared between interfaces, extensions have flexibi Navigate to shared configurations through: - 1. Click `...` in the upper right corner - 2. Click `Advanced Settings` + 1. Click the button in the top-left to open the sidebar. + 2. Click the `Settings` button on the sidebar. Use the following command to manage shared configurations: diff --git a/documentation/docs/getting-started/providers.md b/documentation/docs/getting-started/providers.md index 68431109..fac23ce5 100644 --- a/documentation/docs/getting-started/providers.md +++ b/documentation/docs/getting-started/providers.md @@ -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 **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 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 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 - 1. Click `...` in the upper right corner - 2. Click `Advanced Settings` + 1. Click the 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: **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 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`. @@ -507,8 +512,8 @@ ollama run michaelneale/deepseek-r1-goose - 3. Click `...` in the top-right corner. - 4. Navigate to `Advanced Settings` -> `Browse Models` -> and select `Ollama` from the list. + 3. Click the 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. diff --git a/documentation/docs/getting-started/using-extensions.md b/documentation/docs/getting-started/using-extensions.md index 39a7b19e..71fec253 100644 --- a/documentation/docs/getting-started/using-extensions.md +++ b/documentation/docs/getting-started/using-extensions.md @@ -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: - 1. Click `...` in the top right corner of the Goose Desktop. - 2. Select `Advanced Settings` from the menu. + 1. Click the 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. @@ -115,8 +116,8 @@ See available servers in the **[MCP Server Directory](https://www.pulsemcp.com/s - 1. Click `...` in the top right corner of the Goose Desktop. - 2. Select `Advanced Settings` from the menu. + 1. Click the 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. - 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 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. @@ -506,8 +507,8 @@ You can remove installed extensions. - 1. Click `...` in the top right corner of the Goose Desktop. - 2. Select `Advanced Settings` from the menu. + 1. Click the 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`. diff --git a/documentation/docs/guides/handling-llm-rate-limits-with-goose.md b/documentation/docs/guides/handling-llm-rate-limits-with-goose.md index 27d43759..8b3fb6df 100644 --- a/documentation/docs/guides/handling-llm-rate-limits-with-goose.md +++ b/documentation/docs/guides/handling-llm-rate-limits-with-goose.md @@ -6,6 +6,7 @@ sidebar_position: 8 import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import { PanelLeft } from 'lucide-react'; Rate limiting is the process of restricting the number of requests a user or application can send to an LLM API within a specific timeframe. LLM providers enforce this with the purpose of managing resources and preventing abuse. @@ -21,12 +22,13 @@ OpenRouter provides a unified interface for LLMs that allows you to select and s - 1. Click on the three dots in the top-right corner. - 2. Select `Advanced Settings` from the menu. - 3. Click on "Browse" in the `Models` section. - 4. Click on `Configure` - 5. Select `OpenRouter` from the list of available providers. - 6. Enter your OpenRouter API key in the dialog that appears. + 1. Click the button in the top-left to open the sidebar. + 2. Click the `Settings` button on the sidebar. + 3. Click the `Models` tab. + 3. Click `Configure Providers`. + 5. Click `Configure` under `OpenRouter` to edit your OpenRouter settings. + 6. Enter your OpenRouter API key. + 7. Click `Submit`. 1. Run the Goose configuration command: diff --git a/documentation/docs/guides/recipes/storing-recipes.md b/documentation/docs/guides/recipes/storing-recipes.md index b7588226..99c1f862 100644 --- a/documentation/docs/guides/recipes/storing-recipes.md +++ b/documentation/docs/guides/recipes/storing-recipes.md @@ -6,6 +6,7 @@ sidebar_label: Saving Recipes import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import { PanelLeft, Bot } from 'lucide-react'; This guide covers storing, organizing, and finding Goose recipes when you need to access them again later. @@ -42,18 +43,22 @@ Before saving recipes, it's important to understand where they can be stored and **Save New Recipe:** + 1. To create a recipe from your chat session, see: [Create Recipe](/docs/guides/recipes/session-recipes#create-recipe) 2. Once in the Recipe Editor, click **Save Recipe** to save it to your Recipe Library **Save Modified Recipe:** If you're already using a recipe and want to save a modified version: -1. Click the gear icon ⚙️ in the top right corner -2. Click **Save recipe** -3. Enter a name for the recipe -4. [Choose to save globally or locally](#recipe-storage-locations) to your current project +1. Click the button with your current model at the bottom of the window +2. Click **View Recipe** +3. Make any desired edits to the description, instructions, or initial prompts 5. Click **Save Recipe** +:::note +When you modify and save a recipe with a new name, a new recipe and new link are generated. You can still run the original recipe from the recipe library, or using the original link. If you edit a recipe without changing its name, the version in the recipe library is updated, but you can still run the original recipe via link. +::: + @@ -73,9 +78,9 @@ If you're already using a recipe and want to save a modified version: **Access Recipe Library:** -1. Click the gear icon ⚙️ in the top right corner -2. Click **Recipe Library** -3. Browse your saved recipes in a list view +1. Click the button in the top-left to open the sidebar +2. Click `Recipes` +3. Browse the list of your saved recipes 4. Each recipe shows its title, description, and whether it's global or local @@ -102,20 +107,17 @@ Set up [custom recipe paths](/docs/guides/recipes/session-recipes#configure-reci - - - ## Using Saved Recipes -1. Click the gear icon ⚙️ in the top right corner -2. Click **Recipe Library** +1. Click the button in the top-left to open the sidebar +2. Click `Recipes` 3. Find your recipe in the Recipe Library 4. Choose one of the following: - - Click **Use Recipe** to run it immediately - - Click **Preview** to see details first, then click **Load Recipe** to run it + - Click `Use` to run it immediately + - Click `Preview` to see the recipe details first, then click **Load Recipe** to run it diff --git a/documentation/docs/guides/smart-context-management.md b/documentation/docs/guides/smart-context-management.md index ae332f3b..4483dee6 100644 --- a/documentation/docs/guides/smart-context-management.md +++ b/documentation/docs/guides/smart-context-management.md @@ -7,6 +7,7 @@ sidebar_label: Smart Context Management import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import { ScrollText } from 'lucide-react'; +import { PanelLeft } from 'lucide-react'; When working with [Large Language Models (LLMs)](/docs/getting-started/providers), there are limits to how much conversation history they can process at once. Goose provides smart context management features to help handle context and conversation limits so you can maintain productive sessions. Here are some key concepts: @@ -48,10 +49,14 @@ When you reach the context limit in Goose Desktop: You can proactively summarize your conversation before reaching context limits: -1. Click the scroll text icon () in the chat interface +1. Click the scroll text icon in the chat interface 2. Confirm the summarization in the modal 3. View or edit the generated summary if needed +:::note +Before the scroll icon appears, you must send at least one message in the chat. Simply starting a new session won't trigger it. +::: + @@ -151,9 +156,10 @@ This setting is stored as the `GOOSE_MAX_TURNS` environment variable in your [co - 1. Click the gear icon `⚙️` on the top toolbar - 2. Click `Advanced settings` - 3. Scroll to `Conversation Limits` and enter a value for `Max Turns` + 1. Click the button in the top-left to open the sidebar + 2. Click the `Settings` button on the sidebar + 3. Click the `Chat` tab + 4. Scroll to `Conversation Limits` and enter a value for `Max Turns` @@ -349,9 +355,10 @@ Display estimated real-time costs of your session at the bottom of the Goose Des To manage live cost tracking: - 1. Click the gear icon `⚙️` on the top toolbar - 2. Click `Advanced settings` - 3. Scroll to `App Settings` and toggle `Cost Tracking` on or off + 1. Click the button in the top-left to open the sidebar + 2. Click the `Settings` button on the sidebar + 3. Click the `App` tab + 4. Toggle `Cost Tracking` on/off The session cost updates dynamically as tokens are consumed. Hover over the cost to see a detailed breakdown of token usage. If multiple models are used in the session, this includes a cost breakdown by model. Ollama and local deployments always show a cost of $0.00. diff --git a/documentation/docs/guides/using-goosehints.md b/documentation/docs/guides/using-goosehints.md index 305f5e93..9b69bcdf 100644 --- a/documentation/docs/guides/using-goosehints.md +++ b/documentation/docs/guides/using-goosehints.md @@ -6,6 +6,7 @@ sidebar_label: Using Goosehints import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import { FolderKey } from 'lucide-react'; `.goosehints` is a text file used to provide additional context about your project and improve the communication with Goose. The use of `goosehints` ensures that Goose understands your requirements better and can execute tasks more effectively. @@ -36,7 +37,7 @@ You can use both global and local hints at the same time. When both exist, Goose #### Local hints file 1. Change the directory to where you'd like to set up the file. You can do this by clicking the directory path on the bottom of the Goose window. - 2. Click the `Configure goosehints` icon on the bottom right of the Goose window. + 2. Click the icon on the bottom right of the Goose window. 4. Enter your local tips into the text area. 5. Click `Save`. 6. Restart your session so Goose can read the updated `.goosehints`.