docs: Update docs for better installation and provider setups (#408)
Co-authored-by: Angie Jones <jones.angie@gmail.com>
This commit is contained in:
+46
-3
@@ -1,8 +1,10 @@
|
||||
# Installation
|
||||
|
||||
To install Goose, use `pipx`.First ensure [pipx][pipx] is installed:
|
||||
To install Goose, use `pipx` on macOS, Linux, or Windows.
|
||||
|
||||
``` sh
|
||||
First, ensure [pipx][pipx] is installed:
|
||||
|
||||
```sh
|
||||
brew install pipx
|
||||
pipx ensurepath
|
||||
```
|
||||
@@ -15,4 +17,45 @@ pipx install goose-ai
|
||||
|
||||
[pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx
|
||||
|
||||
You can then run `goose` from the command line with `goose session start`.
|
||||
### Configuration
|
||||
|
||||
#### Set up a provider
|
||||
Goose works with a set of [supported LLM providers][providers] that you can obtain an API key from if you don't already have one. You'll be prompted to set an API key if you haven't set one previously when you run Goose.
|
||||
|
||||
>[!TIP]
|
||||
> **Billing:**
|
||||
>
|
||||
> You will need to have credits in your LLM Provider account (when necessary) to be able to successfully make requests.
|
||||
>
|
||||
|
||||
#### Profiles
|
||||
|
||||
After installation, you can configure Goose anytime by editing your profile file located at `~/.config/goose/profiles.yaml`. You can set multiple profile configurations, use different LLM providers, and enable toolkits that customize Goose's functionality as well:
|
||||
|
||||
```yaml
|
||||
default:
|
||||
provider: openai
|
||||
processor: gpt-4o
|
||||
accelerator: gpt-4o-mini
|
||||
moderator: passive
|
||||
toolkits:
|
||||
- name: developer
|
||||
requires: {}
|
||||
```
|
||||
|
||||
|
||||
## Running Goose
|
||||
|
||||
You can run `goose` from the command line using:
|
||||
|
||||
```sh
|
||||
goose session start
|
||||
```
|
||||
|
||||
|
||||
## Additional Resources
|
||||
|
||||
Visit the [Configuration Guide][configuration-guide] for detailed instructions on configuring Goose.
|
||||
|
||||
[configuration-guide]: https://block.github.io/goose/configuration.html
|
||||
[providers]: https://block.github.io/goose/plugins/providers.html
|
||||
Reference in New Issue
Block a user