aljaz/goose
1
0
Fork 0
mirror of https://github.com/aljazceru/goose.git synced 2026-02-20 05:54:31 +01:00
Code Issues 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

16
README.md
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

87
docs/index.md
View File

@@ -91,91 +91,6 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl
**See more of our use-cases in our [docs][use-cases]!**
## Quick start guide
### Installation
To install Goose, use `pipx`. First ensure [pipx][pipx] is installed:
``` sh
brew install pipx
pipx ensurepath
```
You can also place `.goosehints` in `~/.config/goose/.goosehints` if you like for always loaded hints personal to you.
Then install Goose:
```sh
pipx install goose-ai
```
### Running Goose
#### Start a session
From your terminal, navigate to the directory you'd like to start from and run:
```sh
goose session start
```
You will see the Goose prompt `G❯`:
```
G❯ type your instructions here exactly as you would tell 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.
#### Exit the session
If you are looking to exit, use `CTRL+D`, although Goose should help you figure that out if you forget.
#### 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:
``` sh
goose session resume
```
To see more documentation on the CLI commands currently available to Goose check out the documentation [here][cli]. If you’d like to develop your own CLI commands for Goose, check out the [Contributing document][contributing].
### Running a goose tasks (one off)
You can run goose to do things just as a one off, such as tidying up, and then exiting:
```sh
goose run instructions.md
```
You can also use process substitution to provide instructions directly from the command line:
```sh
goose run <(echo "Create a new Python file that prints hello world")
```
This will run until completion as best it can. You can also pass `--resume-session` and it will re-use the first session it finds for context
### Next steps
Learn how to modify your Goose profiles.yaml file to add and remove functionality (toolkits) and providing context to get the most out of Goose in our [Getting Started Guide][getting-started].
**Want to move out of the terminal and into an IDE?**
We have some experimental IDE integrations for VSCode and JetBrains IDEs:
* https://github.com/square/goose-vscode
* https://github.com/Kvadratni/goose-intellij
**Goose as a Github Action**
There is also an experimental Github action to run goose as part of your workflow (for example if you ask it to fix an issue):
https://github.com/marketplace/actions/goose-ai-developer-agent
**With Docker**
There is also a `Dockerfile` in the root of this project you can use if you want to run goose in a sandboxed fashion.
## Getting involved!
@@ -202,7 +117,7 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`*
[cli]: https://block.github.io/goose/plugins/cli.html
[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
[discord-invite]: https://discord.gg/7GaTvbDwga
[gh-issues]: https://github.com/block/goose/issues

115
docs/quickstart.md Normal file
View File

@@ -0,0 +1,115 @@
# Goose in 5 minutes
## Quickstart guide
Goose is a developer agent that supercharges your software development by automating an array of coding tasks directly within your terminal or IDE. You can get it setup and running on your devices in only a few minutes.
### Installation
To install Goose, use `pipx`. First ensure [pipx][pipx] is installed:
``` sh
brew install pipx
pipx ensurepath
```
Then install Goose:
```sh
pipx install goose-ai
```
### Running Goose
#### Start a session
From your terminal, navigate to the directory you'd like to start from and run:
```sh
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 speak to a developer.
```
e.g
```
G❯ Create a JavaScript project that fetches and displays weather for a user specified city using a public API
```
Now you are interacting with Goose in conversational sessions. Think of it like you're giving directions 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.
#### Exit the session
If you are looking to exit, use `CTRL+D`.
#### Resume a session
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
```
To see more documentation on the available CLI commands, check out the [documentation][cli]. If you’d like to develop your own CLI commands for Goose, check out the [Contributing document][contributing].
### Running a Goose task
You can run Goose to do things just as a one off, such as tidying up, and then exiting:
```sh
goose run instructions.md
```
You can also use process substitution to provide instructions directly from the command line:
```sh
goose run <(echo "Create a new Python file that prints hello world")
```
This will run until completion as best it can. You can also pass `--resume-session` and it will re-use the first session it finds for context.
## Additional tips
You can place a `.goosehints` file in `~/.config/goose/.goosehints` for hints personal to you. Goose will automatically load these within your sessions.
### Next steps
Review the [Getting Started Guide][getting-started] to learn how to modify the Goose `profiles.yaml` file to add and remove functionality (toolkits) and provide additional context to get the most out of Goose.
**Want to move out of the terminal and into an IDE?**
We have some experimental IDE integrations for VSCode and JetBrains IDEs:
* https://github.com/square/goose-vscode
* https://github.com/Kvadratni/goose-intellij
**Goose as a Github Action**
There is also an experimental Github action to run Goose as part of your workflow (e.g., if you ask it to fix an issue):
https://github.com/marketplace/actions/goose-ai-developer-agent
**With Docker**
There is also a `Dockerfile` in the root of this project you can use if you want to run goose in a sandboxed fashion.
[pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx
[openai-key]: https://platform.openai.com/api-keys
[getting-started]: https://block.github.io/goose/guidance/getting-started.html
[providers]: https://block.github.io/goose/providers.html