diff --git a/documentation/docs/assets/guides/set-up-provider-ui.png b/documentation/docs/assets/guides/set-up-provider-ui.png deleted file mode 100644 index ccd1ba7e1c32..000000000000 Binary files a/documentation/docs/assets/guides/set-up-provider-ui.png and /dev/null differ diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index 2c3e696c0603..b91c929d4fd8 100644 --- a/documentation/docs/getting-started/installation.md +++ b/documentation/docs/getting-started/installation.md @@ -3,7 +3,9 @@ sidebar_position: 1 --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import RateLimits from '@site/src/components/RateLimits'; +import { RateLimits } from '@site/src/components/RateLimits'; +import { DesktopProviderSetup } from '@site/src/components/DesktopProviderSetup'; +import { ModelSelectionTip } from '@site/src/components/ModelSelectionTip'; import MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons'; import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons'; import LinuxDesktopInstallButtons from '@site/src/components/LinuxDesktopInstallButtons'; @@ -13,11 +15,11 @@ import { PanelLeft } from 'lucide-react'; - Choose to install Goose on CLI and/or Desktop: + Choose to install the Desktop and/or CLI version of Goose: - Install Goose directly from the browser or with [Homebrew](https://brew.sh/). + Install Goose Desktop directly from the browser or with [Homebrew](https://brew.sh/).

Option 1: Install via Download

@@ -37,7 +39,7 @@ import { PanelLeft } from 'lucide-react'; ``` ---
- :::note Permissions + :::info Permissions 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. @@ -79,8 +81,8 @@ import { PanelLeft } from 'lucide-react'; - - Choose to install Goose on CLI and/or Desktop: + + Choose to install the Desktop and/or CLI version of Goose: @@ -126,7 +128,7 @@ import { PanelLeft } from 'lucide-react'; - Choose to install Goose on CLI and/or Desktop: + Choose to install the Desktop and/or CLI version of Goose: @@ -208,18 +210,14 @@ import { PanelLeft } from 'lucide-react'; ## 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 [supported LLM providers][providers]. On first use, you'll be prompted to configure your preferred provider. - 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`. + - Upon installing, Goose will automatically enter its configuration screen. Here is where you can set up your LLM provider. + The CLI automatically enters configuration mode on first run. You'll be prompted to select from [supported LLM providers][providers] and enter your API key. :::tip Windows Users When using the native Windows CLI, choose to not store to keyring when prompted during initial configuration. @@ -286,11 +284,15 @@ Goose works with a set of [supported LLM providers][providers], and you'll need +:::tip + +::: + ## Update Provider +You can change your LLM provider or update your API key at any time. + - **To update your LLM provider and API key:** - 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. @@ -300,7 +302,6 @@ Goose works with a set of [supported LLM providers][providers], and you'll need - **To update your LLM provider and API key:** 1. Run the following command: ```sh goose configure @@ -356,7 +357,7 @@ Goose works with a set of [supported LLM providers][providers], and you'll need The Goose CLI and Desktop UI share all core configurations, including LLM provider settings, model selection, and extension configurations. When you install or configure extensions in either interface, the settings are stored in a central location at `~/.config/goose/config.yaml`, making them available to both the Desktop application and CLI. This makes it convenient to switch between interfaces while maintaining consistent settings. -:::note +:::info While core configurations are shared between interfaces, extensions have flexibility in how they store authentication credentials. Some extensions may use the shared config file while others implement their own storage methods. ::: diff --git a/documentation/docs/getting-started/providers.md b/documentation/docs/getting-started/providers.md index 8ab1cf9f60b2..94d2b4d3f52b 100644 --- a/documentation/docs/getting-started/providers.md +++ b/documentation/docs/getting-started/providers.md @@ -6,13 +6,14 @@ title: Configure LLM Provider import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import { PanelLeft } from 'lucide-react'; +import { ModelSelectionTip } from '@site/src/components/ModelSelectionTip'; # Supported LLM Providers Goose is compatible with a wide range of LLM providers, allowing you to choose and integrate your preferred model. :::tip Model Selection -Goose relies heavily on tool calling capabilities and currently works best with Anthropic's Claude 3.5 Sonnet and OpenAI's GPT-4o (2024-11-20) model. + [Berkeley Function-Calling Leaderboard][function-calling-leaderboard] can be a good guide for selecting models. ::: diff --git a/documentation/docs/quickstart.md b/documentation/docs/quickstart.md index 9183c6d56472..ab457b137491 100644 --- a/documentation/docs/quickstart.md +++ b/documentation/docs/quickstart.md @@ -6,7 +6,9 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import Link from "@docusaurus/Link"; import { IconDownload } from "@site/src/components/icons/download"; -import RateLimits from '@site/src/components/RateLimits'; +import { RateLimits } from '@site/src/components/RateLimits'; +import { DesktopProviderSetup } from '@site/src/components/DesktopProviderSetup'; +import { ModelSelectionTip } from '@site/src/components/ModelSelectionTip'; import YouTubeShortEmbed from '@site/src/components/YouTubeShortEmbed'; import MacDesktopInstallButtons from '@site/src/components/MacDesktopInstallButtons'; import WindowsDesktopInstallButtons from '@site/src/components/WindowsDesktopInstallButtons'; @@ -30,7 +32,7 @@ Let's begin 🚀 - Choose to install Goose on CLI and/or Desktop: + Choose to install the Desktop and/or CLI version of Goose: @@ -51,6 +53,8 @@ Let's begin 🚀 + Choose to install the Desktop and/or CLI version of Goose: + @@ -74,7 +78,7 @@ Let's begin 🚀 - Choose to install Goose on CLI and/or Desktop: + Choose to install the Desktop and/or CLI version of Goose: @@ -101,14 +105,16 @@ Let's begin 🚀 ## Configure Provider -Goose works with [supported LLM providers][providers]. When you install Goose, you'll be prompted to choose your preferred LLM and supply an API key. +Goose works with [supported LLM providers][providers]. On first use, you'll be prompted to configure your preferred provider. - ![Set Up a Provider UI](./assets/guides/set-up-provider-ui.png) + - Use the up and down arrow keys to navigate the CLI menu, and press Enter once you've selected a choice. + Use the up and down arrow keys to navigate the CLI menu, and press Enter once you've selected a choice. Be ready to provide your API key. + + Example configuration flow: ``` ┌ goose-configure @@ -128,14 +134,14 @@ Goose works with [supported LLM providers][providers]. When you install Goose, y ◇ Hello! You're all set and ready to go, feel free to ask me anything! │ └ Configuration saved successfully - ``` + ``` + + - - -:::tip Model Selection -Goose relies heavily on tool calling capabilities and currently works best with Anthropic's Claude 3.5 Sonnet and OpenAI's GPT-4o (2024-11-20) model. +:::tip + ::: ## Start Session diff --git a/documentation/src/components/DesktopProviderSetup.js b/documentation/src/components/DesktopProviderSetup.js new file mode 100644 index 000000000000..ba6cb5aada64 --- /dev/null +++ b/documentation/src/components/DesktopProviderSetup.js @@ -0,0 +1,14 @@ +import React from "react"; + +export const DesktopProviderSetup = () => { + return ( + <> +

On the welcome screen, choose how to configure a provider:

+
    +
  • OpenRouter (recommended) - One-click OAuth authentication provides instant access to multiple AI models with built-in rate limiting.
    • +
  • Ollama - Free local AI that runs privately on your computer. If needed, the setup flow will guide you through installing Ollama and downloading the recommended model.
    • +
  • Other Providers - Choose from ~20 supported providers including OpenAI, Anthropic, Google Gemini, and others through manual configuration. Be ready to provide your API key.
    • +
+ + ); +}; diff --git a/documentation/src/components/LinuxDesktopInstallButtons.js b/documentation/src/components/LinuxDesktopInstallButtons.js index 2a7f335522a0..3de0445d109e 100644 --- a/documentation/src/components/LinuxDesktopInstallButtons.js +++ b/documentation/src/components/LinuxDesktopInstallButtons.js @@ -57,7 +57,7 @@ const LinuxDesktopInstallButtons = () => { return (
-

To download Goose Desktop for Linux, choose the buttons below:

+

To download Goose Desktop for Linux, click one of the buttons below:

{ + return ( +

Goose relies heavily on tool calling capabilities and currently works best with Claude 4 models.

+ ); +}; diff --git a/documentation/src/components/RateLimits.js b/documentation/src/components/RateLimits.js index 453bef924888..5a996e209fc0 100644 --- a/documentation/src/components/RateLimits.js +++ b/documentation/src/components/RateLimits.js @@ -1,7 +1,7 @@ import React from "react"; import Admonition from "@theme/Admonition"; -const RateLimits = () => { +export const RateLimits = () => { return ( { ); }; - -export default RateLimits;