docs: Update docs quickstart (#258)

Co-authored-by: Rizel Scarlett <rizel@tbd.email> Co-authored-by: Angie Jones <jones.angie@gmail.com>
2024-11-16 03:01:07 +01:00
parent d30b524f45
commit da53dc1fdd
3 changed files with 130 additions and 88 deletions
@@ -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