@@ -65,7 +65,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl
-- M, Software Engineer
-- M, Software Engineer
> If anyone was looking for another reason to check it out: I just asked Goose to break a string-array into individual string resources across eleven localizations, and it performed amazingly well and saved me a bunch of time doing it manually or figuring out some way to semi-automate it.
> If anyone was looking for another reason to check it out: I just asked Goose to break a string-array into individual string resources across eleven localizations, and it performed amazingly well and saved me a bunch of time doing it manually or figuring out some way to semi-automate it.
-- A, Android Engineer
-- A, Android Engineer
@@ -101,7 +101,7 @@ To install Goose, use `pipx`. First ensure [pipx][pipx] is installed:
brew install pipx
brew install pipx
pipx ensurepath
pipx ensurepath
```
```
You can also place `.goosehints` in `~/.config/goose/.goosehints` if you like for always loaded hints personal to you.
You can also place `.goosehints` in `~/.config/goose/.goosehints` if you like for always loaded hints personal to you.
Then install Goose:
Then install Goose:
@@ -111,7 +111,7 @@ pipx install goose-ai
### Running Goose
### Running Goose
#### Start a session
#### Start a session
From your terminal, navigate to the directory you'd like to start from and run:
From your terminal, navigate to the directory you'd like to start from and run:
@@ -127,11 +127,11 @@ 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.
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
#### Exit the session
If you are looking to exit, use `CTRL+D`, although Goose should help you figure that out if you forget.
If you are looking to exit, use `CTRL+D`, although Goose should help you figure that out if you forget.
#### Resume a session
#### 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 and you can resume it later on:
@@ -143,7 +143,7 @@ To see more documentation on the CLI commands currently available to Goose check
### Running a goose tasks (one off)
### 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:
You can run goose to do things just as a one off, such as tidying up, and then exiting:
```sh
```sh
goose run instructions.md
goose run instructions.md
@@ -162,10 +162,10 @@ This will run until completion as best it can. You can also pass `--resume-sessi
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].
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?**
**Want to move out of the terminal and into an IDE?**
We have some experimental IDE integrations for VSCode and JetBrains IDEs:
We have some experimental IDE integrations for VSCode and JetBrains IDEs:
* https://github.com/square/goose-vscode
* https://github.com/square/goose-vscode
* https://github.com/Kvadratni/goose-intellij
* https://github.com/Kvadratni/goose-intellij
## Other ways to run goose
## Other ways to run goose
@@ -178,7 +178,7 @@ We have some experimental IDE integrations for VSCode and JetBrains IDEs:
**Goose as a Github Action**
**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):
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):
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Lam Chau