diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index 4e0b2ce49539..d6a71c774522 100644 --- a/documentation/docs/getting-started/installation.md +++ b/documentation/docs/getting-started/installation.md @@ -320,7 +320,7 @@ You can change your LLM provider and/or model or update your API key at any time 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. Choose to update your provider, switch models, or click `Reset Provider and Model` to clear your settings and return to the welcome screen. See details about these [configuration options](/docs/getting-started/providers#configure-provider). + 4. Choose to update your provider, switch models, or click `Reset Provider and Model` to clear your settings and return to the welcome screen. See details about these [configuration options](/docs/getting-started/providers#configure-provider-and-model). 1. Run the following command: diff --git a/documentation/docs/getting-started/providers.md b/documentation/docs/getting-started/providers.md index 4e09519bae96..1356d0f77afb 100644 --- a/documentation/docs/getting-started/providers.md +++ b/documentation/docs/getting-started/providers.md @@ -56,10 +56,9 @@ goose also supports special "pass-through" providers that work with existing CLI CLI providers are cost-effective alternatives that use your existing subscriptions. They work differently from API providers as they execute CLI commands and integrate with the tools' native capabilities. See the [CLI Providers guide](/docs/guides/cli-providers) for detailed setup instructions. ::: - -## Configure Provider +## Configure Provider and Model -To configure your chosen provider or see available options, visit the `Models` tab in goose Desktop or run `goose configure` in the CLI. +To configure your chosen provider, see available options, or select a model, visit the `Models` tab in goose Desktop or run `goose configure` in the CLI. @@ -128,72 +127,101 @@ To configure your chosen provider or see available options, visit the `Models` t 1. In your terminal, run the following command: - ```sh - goose configure - ``` + ```sh + goose configure + ``` + + 2. Select `Configure Providers` from the menu and press `Enter`. + + ``` + ┌ goose-configure + │ + ◆ What would you like to configure? + // highlight-start + │ ● Configure Providers (Change provider or update credentials) + // highlight-end + │ ○ Custom Providers + │ ○ Add Extension + │ ○ Toggle Extensions + │ ○ Remove Extension + │ ○ goose Settings + └ + ``` + 3. Choose a model provider and press `Enter`. Use the arrow keys (↑/↓) to move through the options. + + ``` + ┌ goose-configure + │ + ◇ What would you like to configure? + │ Configure Providers + │ + ◆ Which model provider should we use? + │ ○ Amazon Bedrock + │ ○ Amazon SageMaker TGI + // highlight-start + │ ● Anthropic (Claude and other models from Anthropic) + // highlight-end + │ ○ Azure OpenAI + │ ○ Claude Code CLI + │ ○ ... + └ + ``` + 4. Enter your API key (and any other configuration details) when prompted. + + ``` + ┌ goose-configure + │ + ◇ What would you like to configure? + │ Configure Providers + │ + ◇ Which model provider should we use? + │ Anthropic + │ + ◆ Provider Anthropic requires ANTHROPIC_API_KEY, please enter a value + // highlight-start + │ ▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪ + // highlight-end + └ + ``` + + If you're just changing models, skip any prompts to update the provider configuration. + + 5. Enter your desired `ANTHROPIC_HOST` or press `Enter` to use the default. + + ``` + ◆ Provider Anthropic requires ANTHROPIC_HOST, please enter a value + // highlight-start + │ https://api.anthropic.com (default) + // highlight-end + ``` + 6. Choose the model you want to use. Depending on the provider, you can: + - Select the model from a list + - Search for the model by name + - Enter the model name directly + + ``` + │ + ◇ Model fetch complete + │ + ◇ Select a model: + // highlight-start + │ claude-sonnet-4-5 (default) + // highlight-end + │ + ◒ Checking your configuration... + └ Configuration saved successfully + ``` + + This change takes effect the next time you start a session. - 2. Select `Configure Providers` from the menu and press Enter. + :::tip + Set the model for an individual session using the [`run` command](/docs/guides/goose-cli-commands#run-options): - ``` - ┌ goose-configure - │ - ◆ What would you like to configure? - │ ● Configure Providers (Change provider or update credentials) - │ ○ Add Extension - │ ○ Toggle Extensions - │ ○ Remove Extension - │ ○ goose Settings - └ - ``` - 3. Choose a model provider and press Enter. - - ``` - ┌ goose-configure - │ - ◇ What would you like to configure? - │ Configure Providers - │ - ◆ Which model provider should we use? - │ ● Anthropic (Claude and other models from Anthropic) - │ ○ Azure OpenAI - │ ○ Amazon Bedrock - │ ○ Claude Code - │ ○ Databricks - │ ○ ... - └ - ``` - 4. Enter your API key (and any other configuration details) when prompted. - - ``` - ┌ goose-configure - │ - ◇ What would you like to configure? - │ Configure Providers - │ - ◇ Which model provider should we use? - │ Anthropic - │ - ◆ Provider Anthropic requires ANTHROPIC_API_KEY, please enter a value - │ ▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪ - └ - ``` - 5. Enter your desired `ANTHROPIC_HOST` or you can use the default one by hitting the `Enter` key. - - ``` - ◇ Enter new value for ANTHROPIC_HOST - │ https://api.anthropic.com (default) - ``` - 6. Enter the model you want to use or you can use the default one by hitting the `Enter` key. - ``` - │ - ◇ Model fetch complete - │ - ◇ Enter a model from that provider: - │ claude-sonnet-4-0 (default) - │ - ◓ Checking your configuration... - └ Configuration saved successfully + ```bash + goose run --model claude-sonnet-4-0 -t "initial prompt" ``` + ::: + diff --git a/documentation/docs/guides/environment-variables.md b/documentation/docs/guides/environment-variables.md index 00c9fa2e4b0e..0d5c6df44a11 100644 --- a/documentation/docs/guides/environment-variables.md +++ b/documentation/docs/guides/environment-variables.md @@ -16,8 +16,8 @@ These are the minimum required variables to get started with goose. | Variable | Purpose | Values | Default | |----------|---------|---------|---------| -| `GOOSE_PROVIDER` | Specifies the LLM provider to use | [See available providers](/docs/getting-started/providers#available-providers) | None (must be [configured](/docs/getting-started/providers#configure-provider)) | -| `GOOSE_MODEL` | Specifies which model to use from the provider | Model name (e.g., "gpt-4", "claude-sonnet-4-20250514") | None (must be configured) | +| `GOOSE_PROVIDER` | Specifies the LLM provider to use | [See available providers](/docs/getting-started/providers#available-providers) | None (must be [configured](/docs/getting-started/providers#configure-provider-and-model)) | +| `GOOSE_MODEL` | Specifies which model to use from the provider | Model name (e.g., "gpt-4", "claude-sonnet-4-20250514") | None (must be [configured](/docs/getting-started/providers#configure-provider-and-model)) | | `GOOSE_TEMPERATURE` | Sets the [temperature](https://medium.com/@kelseyywang/a-comprehensive-guide-to-llm-temperature-%EF%B8%8F-363a40bbc91f) for model responses | Float between 0.0 and 1.0 | Model-specific default | **Examples** 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 a8d431fca8e9..42bcdbd21efb 100644 --- a/documentation/docs/guides/handling-llm-rate-limits-with-goose.md +++ b/documentation/docs/guides/handling-llm-rate-limits-with-goose.md @@ -11,7 +11,7 @@ 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. -Since goose is working very quickly to implement your tasks, you may need to manage rate limits imposed by the provider. If you frequently hit rate limits, consider upgrading your LLM plan to access higher tier limits or [configure a provider](/docs/getting-started/providers#configure-provider) that has built-in rate limiting: +Since goose is working very quickly to implement your tasks, you may need to manage rate limits imposed by the provider. If you frequently hit rate limits, consider upgrading your LLM plan to access higher tier limits or [configure a provider](/docs/getting-started/providers#configure-provider-and-model) that has built-in rate limiting: :::info goose supports automatic setup for both providers that takes you through OAuth account creation and secure API key generation.