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

Feat: Refined the documentation for Goose (#2751)

Browse Source 
Co-authored-by: Angie Jones <jones.angie@gmail.com>
Co-authored-by: Rizel Scarlett <rizel@squareup.com>
This commit is contained in:
Gary Zhou
2025-06-03 18:14:26 -04:00
committed by GitHub
parent d1dc6c3ff0
commit 5574c20ff2
2 changed files with 29 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -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

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

@@ -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
```
</TabItem>
</Tabs>