aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2025-12-17 22:24:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: restructure menu (#769)

Browse Source
This commit is contained in:
Angie Jones
2025-01-25 10:14:27 -06:00
committed by GitHub
parent 3f8ce5f816
commit b06e7f353b
17 changed files with 262 additions and 323 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
documentation/docs/guides/goose-cli-commands.md
View File

@@ -74,7 +74,7 @@ goose session --name <name> --with-extension <command>
- **`--with-builtin <NAME>`**
Starts the session with the specified [built-in extension](../configuration/managing-extensions.md#built-in-extensions) enabled. (e.g. 'developer')
Starts the session with the specified [built-in extension](/docs/getting-started/using-extensions#built-in-extensions) enabled. (e.g. 'developer')
```bash
goose session --with-builtin <name>

2
documentation/docs/guides/handling-llm-rate-limits-with-goose.md
View File

@@ -31,7 +31,7 @@ OpenRouter provides a unified interface for LLMs that allows you to select and s
2. Select `Configure Providers` from the menu.
3. Follow the prompts to choose OpenRouter as your provider and enter your OpenRouter API key when prompted.
</TabItem>
<TabItem value="ui" label="Goose UI">
<TabItem value="ui" label="Goose Desktop">
1. Click on the three dots in the top-right corner.
2. Select `Settings` from the menu.

24
documentation/docs/guides/managing-goose-sessions.md
View File

@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
A session is a single, continuous interaction between you and Goose, providing a space to ask questions and prompt action. In this guide, we'll cover how to start, exit, save, and resume.
## Starting a Session
## Start Session
<Tabs>
<TabItem value="cli" label="Goose CLI" default>
@@ -19,7 +19,7 @@ A session is a single, continuous interaction between you and Goose, providing a
goose session
```
</TabItem>
<TabItem value="ui" label="Goose UI">
<TabItem value="ui" label="Goose Desktop">
After choosing an LLM provider, you’ll see the session interface ready for use.
Type your questions, tasks, or instructions directly into the input field, and Goose will immediately get to work.
@@ -27,7 +27,7 @@ A session is a single, continuous interaction between you and Goose, providing a
</TabItem>
</Tabs>
## Naming a Session
## Name Session
<Tabs>
<TabItem value="cli" label="Goose CLI" default>
By default, Goose will provide a random string as the name of your session. If you'd like to provide a specific name, this is where you'd do so. For example to name your session `react-migration`, you would run:
@@ -43,15 +43,15 @@ A session is a single, continuous interaction between you and Goose, providing a
logging to ~/.config/goose/sessions/react-migration.json1
```
</TabItem>
<TabItem value="ui" label="Goose UI">
Session management features, such as **naming** and **resuming** sessions, are **not** currently available in the Goose UI. If you'd like to see these features added, please [open an issue on GitHub](https://github.com/block/goose/issues/new?template=Blank+issue) to let us know.
<TabItem value="ui" label="Goose Desktop">
Session management features, such as **naming** and **resuming** sessions, are **not** currently available in the Goose Desktop. If you'd like to see these features added, please [open an issue on GitHub](https://github.com/block/goose/issues/new?template=Blank+issue).
</TabItem>
</Tabs>
:::info
If this is your first session, Goose will prompt you for an API key to access an LLM (Large Language Model) of your choice. For more information on setting up your API key, see the [Installation Guide](/docs/installation#set-up-a-provider). Here is the list of [supported LLMs](/docs/configuration/providers).
If this is your first session, Goose will prompt you for an API key to access an LLM (Large Language Model) of your choice. For more information on setting up your API key, see the [Installation Guide](docs/getting-started/installation#set-up-a-provider). Here is the list of [supported LLMs](/docs/getting-started/providers).
:::
## Exiting a Session
## Exit Session
<Tabs>
<TabItem value="cli" label="Goose CLI" default>
@@ -59,12 +59,14 @@ A session is a single, continuous interaction between you and Goose, providing a
Your session will be stored locally in `~/.config/goose/sessions`.
</TabItem>
<TabItem value="ui" label="Goose UI">
<TabItem value="ui" label="Goose Desktop">
To exit a session, simply close the application.
</TabItem>
</Tabs>
## Resuming a Session
## Resume Session
<Tabs>
<TabItem value="cli" label="Goose CLI" default>
To resume your latest session, you can run the following command:
@@ -94,7 +96,7 @@ A session is a single, continuous interaction between you and Goose, providing a
goose session -r -n react-migration
```
</TabItem>
<TabItem value="ui" label="Goose UI">
Session management features, such as **naming** and **resuming** sessions, are **not** currently available in the Goose UI. If you'd like to see these features added, please [open an issue on GitHub](https://github.com/block/goose/issues/new?template=Blank+issue) to let us know.
<TabItem value="ui" label="Goose Desktop">
Session management features, such as **naming** and **resuming** sessions, are **not** currently available in the Goose Desktop. If you'd like to see these features added, please [open an issue on GitHub](https://github.com/block/goose/issues/new?template=Blank+issue).
</TabItem>
</Tabs>

2
documentation/docs/guides/tips.md
View File

@@ -44,7 +44,7 @@ You can tell Goose to run things for you continuously and it will iterate, try,
It doesn't have to be in a repo. Just ask Goose!
### Keep Goose updated
Regularly update Goose to benefit from the latest features, bug fixes, and performance improvements. For the CLI, the best way to keep it updated is by re-running the [Goose installation script][installation]. For Goose UI, check the [GitHub Releases page][ui-release] regularly for updates.
Regularly update Goose to benefit from the latest features, bug fixes, and performance improvements. For the CLI, the best way to keep it updated is by re-running the [Goose installation script][installation]. For Goose Desktop, check the [GitHub Releases page][ui-release] regularly for updates.
[installation]: https://block.github.io/goose/v1/docs/quickstart/#installation
[ui-release]: https://github.com/block/goose/releases/stable

4
documentation/docs/guides/using-goosehints.md
View File

@@ -8,13 +8,13 @@ sidebar_position: 3
`.goosehints` is a text file used to provide additional context about your project and improve the communication with Goose. The use of `goosehints` ensures that Goose understands your requirements better and can execute tasks more effectively.
:::info Developer extension required
To make use of the hints file, you need to have the `developer` extension [enabled](../configuration/managing-extensions).
To make use of the hints file, you need to have the `developer` extension [enabled](../configuration/using-extensions).
:::
This guide will walk you through creating and using your `.goosehints` file to streamline your workflow with custom instructions and context.
## Creating your `.goosehints` file
## Creating your hints file
Create a file named `.goosehints` and save the file in `~/.config/goose/.goosehints`. If saved here, Goose will use this file for every session with you.