Files
tkmind_go/documentation/docs/getting-started/installation.md
T

159 lines
5.7 KiB
Markdown
Raw Normal View History

2025-01-24 13:04:43 -08:00
---
sidebar_position: 1
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2025-01-25 10:14:27 -06:00
import Link from "@docusaurus/Link";
import { IconDownload } from "@site/src/components/icons/download";
import SupportedEnvironments from '@site/src/components/SupportedEnvironments';
import RateLimits from '@site/src/components/RateLimits';
2025-01-24 13:04:43 -08:00
2025-01-25 10:14:27 -06:00
# Install Goose
2025-01-24 13:04:43 -08:00
<SupportedEnvironments />
2025-01-24 13:04:43 -08:00
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
2025-01-26 02:08:39 -06:00
Run the following command to install the latest version of Goose:
2025-01-24 13:04:43 -08:00
```sh
curl -fsSL https://github.com/block/goose/releases/download/stable/download_cli.sh | sh
```
This script will fetch the latest version of Goose and set it up on your system.
:::tip Best Practice
It’s best to keep Goose updated. You can update it by re-running the installation script.
:::
</TabItem>
2025-01-25 10:14:27 -06:00
<TabItem value="ui" label="Goose Desktop">
2025-01-24 13:04:43 -08:00
To install Goose, click the **button** below:
2025-01-25 10:14:27 -06:00
<div className="pill-button">
<Link
className="button button--primary button--lg"
to="https://github.com/block/goose/releases/download/stable/Goose.zip"
>
<IconDownload />
download goose desktop
</Link>
</div>
2025-01-24 13:04:43 -08:00
<div style={{ marginTop: '1rem' }}>
1. Unzip the downloaded `Goose.zip` file.
2. Run the executable file to launch the Goose desktop application.
:::tip Best Practice
It’s best to keep Goose updated. You can do this by checking the [Goose GitHub Release page](https://github.com/block/goose/releases/stable) and downloading updates when available.
:::
</div>
</TabItem>
</Tabs>
2025-01-26 02:08:39 -06:00
### Set LLM Provider
2025-01-24 13:04:43 -08:00
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.
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
2025-01-26 02:08:39 -06:00
Upon installing, Goose will automatically enter its configuration screen. Here is where you can set up your LLM provider.
```
┌ goose-configure
│
◇ What would you like to configure?
│ Configure Providers
│
◇ Which model provider should we use?
│ OpenAI
│
◇ Provider openai requires OPENAI_API_KEY, please enter a value
│▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪▪
│
◇ Enter a model from that provider:
│ gpt-4o
│
◇ Welcome aboard! You're all set to start using this agent—let's achieve great things together!
│
└ Configuration saved successfully
```
2025-01-24 13:04:43 -08:00
</TabItem>
2025-01-25 10:14:27 -06:00
<TabItem value="ui" label="Goose Desktop">
2025-01-26 02:08:39 -06:00
Upon installing, the Provider screen will appear. Here is where you can choose your LLM Provider.
2025-01-25 10:14:27 -06:00
![Set Up a Provider UI](../assets/guides/set-up-provider-ui.png)
2025-01-26 02:08:39 -06:00
Once selecting your provider, you'll be prompted to enter an API key if applicable. Do so, and click `Submit`.
2025-01-24 13:04:43 -08:00
</TabItem>
</Tabs>
### Update a Provider
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
**To update your LLM provider and API key:**
1. Run the following command:
```sh
goose configure
```
2. Select `Configure Providers` from the menu.
3. Follow the prompts to choose your LLM provider and enter or update your API key.
**Example:**
2025-01-26 02:08:39 -06:00
To select an option during configuration, use the up and down arrows to highlight your choice then press Enter.
2025-01-24 13:04:43 -08:00
2025-01-26 02:08:39 -06:00
```
┌ 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 there! You're all set to use me, so please ask away!
│
└ Configuration saved successfully
2025-01-24 13:04:43 -08:00
```
</TabItem>
2025-01-25 10:14:27 -06:00
<TabItem value="ui" label="Goose Desktop">
2025-01-24 13:04:43 -08:00
**To update your LLM provider and API key:**
1. Click on the three dots in the top-right corner.
2. Select `Provider Settings` from the menu.
2. Choose a provider from the list.
3. Click Edit, enter your API key, and click `Set as Active`.
</TabItem>
</Tabs>
<RateLimits />
2025-01-24 13:04:43 -08:00
## Running Goose
<Tabs groupId="interface">
<TabItem value="cli" label="Goose CLI" default>
From your terminal, navigate to the directory you'd like to start from and run:
```sh
goose session
```
</TabItem>
2025-01-25 10:14:27 -06:00
<TabItem value="ui" label="Goose Desktop">
Starting a session in the Goose Desktop is straightforward. After choosing your provider, you’ll see the session interface ready for use.
2025-01-24 13:04:43 -08:00
Type your questions, tasks, or instructions directly into the input field, and Goose will get to work immediately.
</TabItem>
</Tabs>
## Additional Resources
You can also configure Extensions to extend Goose's functionality, including adding new ones or toggling them on and off. For detailed instructions, visit the [Using Extensions Guide][using-extensions].
2025-01-25 10:14:27 -06:00
[using-extensions]: /docs/getting-started/using-extensions
[providers]: /docs/getting-started/providers
2025-01-24 13:04:43 -08:00
[handling-rate-limits]: /docs/guides/handling-llm-rate-limits-with-goose
[mcp]: https://www.anthropic.com/news/model-context-protocol