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

docs: Update docs quickstart (#258)

Browse Source 
Co-authored-by: Rizel Scarlett <rizel@tbd.email>
Co-authored-by: Angie Jones <jones.angie@gmail.com>
This commit is contained in:
Adewale Abati
2024-11-16 03:01:07 +01:00
committed by GitHub
parent d30b524f45
commit da53dc1fdd
3 changed files with 130 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+14 -2
View File
@@ -137,10 +137,21 @@ 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❯`:
```
G❯ type your instructions here exactly as you would tell a developer.
G❯ type your instructions here exactly as you would speak to a developer.
```
Now you are interacting with Goose in conversational sessions - think of it as like giving direction to a junior developer. The default toolkit allows Goose to take actions through shell commands and file edits. You can interrupt Goose with `CTRL+D` or `ESC+Enter` at any time to help redirect its efforts.
@@ -171,7 +182,7 @@ If you are looking to exit, use `CTRL+D`, although Goose should help you figure
#### Resume a session
When you exit a session, it will save the history in `~/.config/goose/sessions` directory and you can resume it later on:
When you exit a session, it will save the history in `~/.config/goose/sessions` directory. You can then resume your last saved session later, using:
``` sh
goose session resume
@@ -254,6 +265,7 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`*
[providers]: https://block.github.io/goose/providers.html
[use-cases]: https://block.github.io/goose/guidance/applications.html
[getting-started]: https://block.github.io/goose/guidance/getting-started.html
[openai-key]: https://platform.openai.com/api-keys
[discord-invite]: https://discord.gg/7GaTvbDwga
[gh-issues]: https://github.com/block/goose/issues