tkmind/tkmind_go
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

docs: Update docs for better installation and provider setups (#408)

Browse Source 
Co-authored-by: Angie Jones <jones.angie@gmail.com>
This commit is contained in:
Adewale Abati
2024-12-05 13:39:51 +01:00
committed by GitHub
parent 2c9ad73281
commit 8531777aa0
4 changed files with 161 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/quickstart.md
+10 -9
View File
@@ -21,6 +21,16 @@ pipx install goose-ai
### Running Goose
#### 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.
>
#### Start a session
From your terminal, navigate to the directory you'd like to start from and run:
@@ -29,15 +39,6 @@ From your terminal, navigate to the directory you'd like to start from and run:
goose session start
```
#### Set up a provider
Goose works with your [preferred LLM][providers]. By default, it uses `openai` as the LLM provider. You'll be prompted to set an [API key][openai-key] if you haven't set one previously.
>[!TIP]
> **Billing:**
>
> You will need to have credits in your LLM Provider account to be able to successfully make requests.
>
#### Make Goose do the work for you
You will see the Goose prompt `G❯`: