docs: update quickstart and install topics (#4378)
This commit is contained in:
dianed-square
@@ -7,7 +7,6 @@ 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 { 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';
|
||||
@@ -98,6 +97,12 @@ Let's begin 🚀
|
||||
|
||||
Learn about prerequisites in the [installation guide](/docs/getting-started/installation).
|
||||
|
||||
:::info PATH Warning And Keyring
|
||||
If you see a PATH warning after installation, you'll need to add Goose to your PATH before running `goose configure`. See the [Windows CLI installation instructions](/docs/getting-started/installation) for detailed steps.
|
||||
|
||||
If prompted during configuration, choose to not store to keyring. If you encounter keyring errors, see the [Windows setup instructions](/docs/getting-started/installation#set-llm-provider) for more information.
|
||||
:::
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
</TabItem>
|
||||
@@ -105,51 +110,43 @@ Let's begin 🚀
|
||||
|
||||
## Configure Provider
|
||||
|
||||
Goose works with [supported LLM providers][providers]. On first use, you'll be prompted to configure your preferred provider.
|
||||
Goose works with [supported LLM providers][providers] that give Goose the AI intelligence it needs to understand your requests. On first use, you'll be prompted to configure your preferred provider.
|
||||
|
||||
<Tabs groupId="interface">
|
||||
<TabItem value="ui" label="Goose Desktop" default>
|
||||
<DesktopProviderSetup />
|
||||
|
||||
On the welcome screen, choose `Automatic setup with Tetrate Agent Router`.
|
||||
|
||||
Goose will open a browser for you to authenticate.
|
||||
|
||||
:::info Free Credits Offer
|
||||
You'll receive $10 in free credits the first time you automatically authenticate with Tetrate through Goose. This offer is available to both new and existing Tetrate users and is valid through October 2, 2025.
|
||||
:::
|
||||
|
||||
Tetrate provides access to multiple AI models with built-in rate limiting and automatic failover. If you prefer a different provider, choose automatic setup with OpenRouter or manually configure a provider.
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli" label="Goose CLI">
|
||||
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
|
||||
│
|
||||
◇ What would you like to configure?
|
||||
│ Configure Providers
|
||||
│
|
||||
◇ Which model provider should we use?
|
||||
│ Google Gemini
|
||||
│
|
||||
◇ Provider Google Gemini requires GOOGLE_API_KEY, please enter a value
|
||||
│▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪
|
||||
│
|
||||
◇ Enter a model from that provider:
|
||||
│ gemini-2.0-flash-exp
|
||||
│
|
||||
◇ Hello! You're all set and ready to go, feel free to ask me anything!
|
||||
│
|
||||
└ Configuration saved successfully
|
||||
```
|
||||
|
||||
<RateLimits />
|
||||
On the welcome screen, choose `Tetrate Agent Router Service Login`. Use the up and down arrow keys to navigate the options, then press `Enter` to select.
|
||||
|
||||
Goose will open a browser for you to authenticate.
|
||||
|
||||
:::info Free Credits Offer
|
||||
You'll receive $10 in free credits the first time you automatically authenticate with Tetrate through Goose. This offer is available to both new and existing Tetrate users and is valid through October 2, 2025.
|
||||
:::
|
||||
|
||||
Tetrate provides access to multiple AI models with built-in rate limiting and automatic failover. If you prefer a different provider, choose automatic setup with OpenRouter or manually configure a provider.
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip
|
||||
<ModelSelectionTip />
|
||||
:::
|
||||
|
||||
## Start Session
|
||||
Sessions are single, continuous conversations between you and Goose. Let's start one.
|
||||
|
||||
<Tabs groupId="interface">
|
||||
<TabItem value="ui" label="Goose Desktop" default>
|
||||
After choosing an LLM provider, you’ll see the session interface ready for use.
|
||||
After choosing an LLM provider, click the `Home` button in the sidebar.
|
||||
|
||||
Type your questions, tasks, or instructions directly into the input field, and Goose will immediately get to work.
|
||||
</TabItem>
|
||||
@@ -183,7 +180,7 @@ create an interactive browser-based tic-tac-toe game in javascript where a playe
|
||||
Goose will create a plan and then get right to work on implementing it. Once done, your directory should contain a JavaScript file as well as an HTML page for playing.
|
||||
|
||||
|
||||
## Install an Extension
|
||||
## Enable an Extension
|
||||
|
||||
While you're able to manually navigate to your working directory and open the HTML file in a browser, wouldn't it be better if Goose did that for you? Let's give Goose the ability to open a web browser by enabling the `Computer Controller` extension.
|
||||
|
||||
@@ -202,7 +199,7 @@ While you're able to manually navigate to your working directory and open the HT
|
||||
```sh
|
||||
goose configure
|
||||
```
|
||||
3. Choose `Add extension` > `Built-in Extension` > `Computer Controller`, and set timeout to 300s. This [extension](https://block.github.io/goose/v1/extensions/detail/nondeveloper) enables webscraping, file caching, and automations.
|
||||
3. Choose `Add Extension` > `Built-in Extension` > `Computer Controller`, and set the timeout to 300s. This [extension](/docs/mcp/computer-controller-mcp) enables webscraping, file caching, and automations.
|
||||
```
|
||||
┌ goose-configure
|
||||
│
|
||||
@@ -213,16 +210,12 @@ While you're able to manually navigate to your working directory and open the HT
|
||||
│ Built-in Extension
|
||||
│
|
||||
◇ Which built-in extension would you like to enable?
|
||||
│ ○ Developer Tools
|
||||
│ ● Computer Controller (controls for webscraping, file caching, and automations)
|
||||
│ ○ Google Drive
|
||||
│ ○ Memory
|
||||
│ ○ JetBrains
|
||||
│
|
||||
│ Computer Controller
|
||||
│
|
||||
◇ Please set the timeout for this tool (in secs):
|
||||
│ 300
|
||||
│
|
||||
└ Enabled Computer Controller extension
|
||||
└ Enabled computercontroller extension
|
||||
```
|
||||
4. Now that Goose has browser capabilities, let's resume your last session:
|
||||
```sh
|
||||
@@ -233,7 +226,7 @@ While you're able to manually navigate to your working directory and open the HT
|
||||
</Tabs>
|
||||
|
||||
```
|
||||
open index.html in a browser
|
||||
open the tic-tac-toe game in a browser
|
||||
```
|
||||
|
||||
Go ahead and play your game, I know you want to 😂 ... good luck!
|
||||
|
||||
Reference in New Issue
Block a user