From 5574c20ff2ce9c6a35e64757d98d65890446adfd Mon Sep 17 00:00:00 2001 From: Gary Zhou Date: Tue, 3 Jun 2025 18:14:26 -0400 Subject: [PATCH] Feat: Refined the documentation for Goose (#2751) Co-authored-by: Angie Jones Co-authored-by: Rizel Scarlett --- .../docs/getting-started/installation.md | 12 +++++++++++- .../docs/getting-started/providers.md | 19 ++++++++++++++++++- 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/documentation/docs/getting-started/installation.md b/documentation/docs/getting-started/installation.md index a4c5321f..25970aaa 100644 --- a/documentation/docs/getting-started/installation.md +++ b/documentation/docs/getting-started/installation.md @@ -96,7 +96,11 @@ import DesktopInstallButtons from '@site/src/components/DesktopInstallButtons'; wsl --install ``` - 2. Restart your computer if prompted. + 2. If prompted, restart your computer to complete the WSL installation. Once restarted, or if WSL is already installed, launch your Ubuntu shell by running: + + ```bash + wsl -d Ubuntu + ``` 3. Run the Goose installation script: ```bash @@ -165,6 +169,12 @@ Goose works with a set of [supported LLM providers][providers], and you'll need export OPENAI_API_KEY={your_api_key} ``` + Run `goose configure` again and proceed through the prompts. When you reach the step for entering the API key, Goose will detect that the key is already set as an environment variable and display a message like: + + ``` + ● OPENAI_API_KEY is set via environment variable + ``` + To make the changes persist in WSL across sessions, add the goose path and export commands to your `.bashrc` or `.bash_profile` file so you can load it later. ```bash diff --git a/documentation/docs/getting-started/providers.md b/documentation/docs/getting-started/providers.md index 3b133eb9..717201fa 100644 --- a/documentation/docs/getting-started/providers.md +++ b/documentation/docs/getting-started/providers.md @@ -92,7 +92,7 @@ To configure your chosen provider or see available options, run `goose configure │ ○ OpenRouter └ ``` - 4. Enter your API key (and any other configuration details) when prompted + 4. Enter your API key (and any other configuration details) when prompted. ``` ┌ goose-configure @@ -106,6 +106,23 @@ To configure your chosen provider or see available options, run `goose configure ◆ 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-3-5-sonnet-latest (default) + │ + ◓ Checking your configuration... + └ Configuration saved successfully ```