From ecdc78a2114b5316865301836a49a4ced3937074 Mon Sep 17 00:00:00 2001 From: damienrj Date: Mon, 7 Oct 2024 22:39:57 -0700 Subject: [PATCH 01/25] Fix doc home page --- README.md | 7 ++++--- docs/reference/goose/utils/diff.md | 1 - docs/reference/index.md | 1 - 3 files changed, 4 insertions(+), 5 deletions(-) delete mode 100644 docs/reference/goose/utils/diff.md diff --git a/README.md b/README.md index 146dba12..7d0bf8d9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl

- Goose Drawing + Goose Drawing

Generated by Goose from its VincentVanCode toolkit. @@ -26,11 +26,12 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl

Unique features 🤖 • - Block Employees on Goose Block Emoji • + Block Employees on Goose Block Emoji • Quick start guide 🚀 • Getting involved! 👋 +

-> [!TIP] +>[!TIP] > **Quick install:** > ``` > pipx install goose-ai diff --git a/docs/reference/goose/utils/diff.md b/docs/reference/goose/utils/diff.md deleted file mode 100644 index 746fe963..00000000 --- a/docs/reference/goose/utils/diff.md +++ /dev/null @@ -1 +0,0 @@ -::: goose.utils.diff \ No newline at end of file diff --git a/docs/reference/index.md b/docs/reference/index.md index f5b5a17f..ac3905df 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -34,6 +34,5 @@ - [goose.utils](goose/utils/index.md) - [goose.utils.ask](goose/utils/ask.md) - [goose.utils.check_shell_command](goose/utils/check_shell_command.md) -- [goose.utils.diff](goose/utils/diff.md) - [goose.utils.file_utils](goose/utils/file_utils.md) - [goose.utils.session_file](goose/utils/session_file.md) \ No newline at end of file From ccb4c04478c7cc88d7da069a4ad88f304b77afcb Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 10:35:52 -0400 Subject: [PATCH 02/25] test changes render --- .github/workflows/deploy_docs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 792f24b2..aa7f43c9 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -4,9 +4,11 @@ on: push: branches: - main # Trigger deployment on pushes to main + - damien/fix-docs # TODO: remove paths: - 'docs/**' - 'mkdocs.yml' + - '.github/workflows/deploy_docs.yaml' jobs: deploy: From 5b4ed550394ce9a875ee984a82ccba2ad9082b33 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 10:42:14 -0400 Subject: [PATCH 03/25] pull damien's changes --- .github/workflows/deploy_docs.yaml | 28 ++++++---------------------- 1 file changed, 6 insertions(+), 22 deletions(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index aa7f43c9..1986602c 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -4,7 +4,8 @@ on: push: branches: - main # Trigger deployment on pushes to main - - damien/fix-docs # TODO: remove + - ldelalande/fix-deploy-docs # TODO: remove + paths: - 'docs/**' - 'mkdocs.yml' @@ -16,27 +17,10 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v3 - - - name: Set up Python - uses: actions/setup-python@v4 - with: - python-version: '3.x' + uses: actions/checkout@v4 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install \ - mkdocs \ - mkdocs-callouts \ - mkdocs-include-markdown-plugin \ - mkdocs-material + - name: Install UV + run: curl -LsSf https://astral.sh/uv/install.sh | sh - name: Build the documentation - run: mkdocs build - - - name: Deploy to GitHub Pages - uses: peaceiris/actions-gh-pages@v3 - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - publish_dir: ./site + run: uv run mkdocs build From 0cfd733ef3d148b9a77115bb915f343dc4687486 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Mon, 7 Oct 2024 14:15:32 -0400 Subject: [PATCH 04/25] try to install deps --- .github/workflows/deploy_docs.yaml | 3 +++ docs/scripts/gen_ref_pages.py | 10 ++++++++++ 2 files changed, 13 insertions(+) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 1986602c..edffa3c7 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -22,5 +22,8 @@ jobs: - name: Install UV run: curl -LsSf https://astral.sh/uv/install.sh | sh + - name: Install dependencies + run: uv venv && uv sync + - name: Build the documentation run: uv run mkdocs build diff --git a/docs/scripts/gen_ref_pages.py b/docs/scripts/gen_ref_pages.py index da964e59..853614b4 100644 --- a/docs/scripts/gen_ref_pages.py +++ b/docs/scripts/gen_ref_pages.py @@ -2,6 +2,12 @@ import mkdocs_gen_files +import logging + +# Set up logging +logging.basicConfig(level=logging.INFO, filename='mkdocs_gen_debug.log', filemode='w', format='%(name)s - %(levelname)s - %(message)s') + + nav = mkdocs_gen_files.Nav() root = Path(__file__).parent.parent.parent @@ -14,6 +20,10 @@ utils_modules = [] for path in sorted(src.rglob("*.py")): + logging.info("Processing file: {}".format(path)) + module_path = path.relative_to(src).with_suffix("") + if module_path.parts[-1] == "diff": # Specifically check for the 'diff' case + logging.info("Diff path found: {}".format(path)) module_path = path.relative_to(src).with_suffix("") # Removes the '.py' suffix doc_path = path.relative_to(src).with_suffix(".md") # Creates .md path From 44bec8d52143278350901844d06939e713d6a423 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Mon, 7 Oct 2024 14:23:55 -0400 Subject: [PATCH 05/25] activate venv --- .github/workflows/deploy_docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index edffa3c7..c41de7c4 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -23,7 +23,7 @@ jobs: run: curl -LsSf https://astral.sh/uv/install.sh | sh - name: Install dependencies - run: uv venv && uv sync + run: uv venv && source .venv/bin/activate && uv sync - name: Build the documentation run: uv run mkdocs build From 1e612a780ed2e726c4bb618349f7e5a251aaf155 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Mon, 7 Oct 2024 14:25:03 -0400 Subject: [PATCH 06/25] uv sync only --- .github/workflows/deploy_docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index c41de7c4..9a1335d5 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -23,7 +23,7 @@ jobs: run: curl -LsSf https://astral.sh/uv/install.sh | sh - name: Install dependencies - run: uv venv && source .venv/bin/activate && uv sync + run: uv sync - name: Build the documentation run: uv run mkdocs build From 187c9dcfd6a5780edc509a7fac724041f9d361c1 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Mon, 7 Oct 2024 14:26:12 -0400 Subject: [PATCH 07/25] try gh-deploy instead --- .github/workflows/deploy_docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 9a1335d5..774a71c1 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -26,4 +26,4 @@ jobs: run: uv sync - name: Build the documentation - run: uv run mkdocs build + run: uv run mkdocs gh-deploy From 4ec227986b7c057993530015c9b6778dd1573995 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Mon, 7 Oct 2024 14:29:12 -0400 Subject: [PATCH 08/25] back to build --- .github/workflows/deploy_docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 774a71c1..9a1335d5 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -26,4 +26,4 @@ jobs: run: uv sync - name: Build the documentation - run: uv run mkdocs gh-deploy + run: uv run mkdocs build From 308bba800571b504aa8a6974aa6d49da316cdd68 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 10:46:50 -0400 Subject: [PATCH 09/25] try gh-deploy --- .github/workflows/deploy_docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 9a1335d5..d58f4962 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -26,4 +26,4 @@ jobs: run: uv sync - name: Build the documentation - run: uv run mkdocs build + run: uv run mkdocs gh-deploy --force From e446227c6fc324554a8c085f92974b8a5642a14c Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 10:57:41 -0400 Subject: [PATCH 10/25] remove uv sync --- .github/workflows/deploy_docs.yaml | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index d58f4962..f5cf5f7b 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -22,8 +22,5 @@ jobs: - name: Install UV run: curl -LsSf https://astral.sh/uv/install.sh | sh - - name: Install dependencies - run: uv sync - - name: Build the documentation run: uv run mkdocs gh-deploy --force From f6bcc6f0c545f1f01aeca501f890d7582fb704b2 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:05:17 -0400 Subject: [PATCH 11/25] make readme a symlink of docs/index.md --- README.md | 195 +----------------------------------------------------- 1 file changed, 1 insertion(+), 194 deletions(-) mode change 100644 => 120000 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 7d0bf8d9..00000000 --- a/README.md +++ /dev/null @@ -1,194 +0,0 @@ -

-Goose is your on-machine developer agent, automating engineering tasks seamlessly within your IDE or terminal -

- -

- Goose Drawing -

-

- Generated by Goose from its VincentVanCode toolkit. -

- -

- - - - - - - - - - - Discord - -

- -

-Unique features 🤖 • - Block Employees on Goose Block Emoji • -Quick start guide 🚀 • -Getting involved! 👋 -

- ->[!TIP] -> **Quick install:** -> ``` -> pipx install goose-ai -> ``` - -**Goose** is a developer agent that supercharges your software development by automating an array of coding tasks directly within your terminal or IDE. Guided by you, it can intelligently assess your project's needs, generate the required code or modifications, and implement these changes on its own. Goose can **interact with a multitude of tools via external APIs** such as Jira, GitHub, Slack, infrastructure and data pipelines, and more -- if your task uses a **shell command or can be carried out by a Python script, Goose can do it for you too!** Like semi-autonomous driving, Goose handles the heavy lifting, allowing you to focus on other priorities. Simply set it on a task and return later to find it completed, boosting your productivity with less manual effort. - -

-

- - - -## Unique features of Goose compared to other AI assistants - -- **Autonomy**: A copilot should be able to also fly the plane at times, which in the development world means running code, debugging tests, installing dependencies, not just providing text output and autocomplete or search. Goose moves beyond just generating code snippets by (1) **using the shell** and (2) by seeing what happens with the code it writes and starting a feedback loop to solve harder problems, **refining solutions iteratively like a human developer**. Your code's best wingman. - -- **Extensibility**: Open-source and fully customizable, Goose integrates with your workflow and allows you to extend it for even more control. **Toolkits let you add new capabilities to Goose.** They are anything you can implement as a Python function (e.g. API requests, deployments, search, etc). We have a growing library of toolkits to use, but more importantly you can create your own. This gives Goose the ability to run these commands and decide if and when a tool is needed to complete your request! **Creating your own toolkits give you a way to bring your own private context into Goose's capabilities.** And you can use *any* LLM you want under the hood, as long as it supports tool use. - -## What Block employees have to say about Goose - -> With Goose, I feel like I am Maverick. -> -> Thanks a ton for creating this. 🙏 -> I have been having way too much fun with it today. - --- P, Machine Learning Engineer - - -> I wanted to construct some fake data for an API with a large request body and business rules I haven't memorized. So I told Goose which object to update and a test to run that calls the vendor. Got it to use the errors descriptions from the vendor response to keep correcting the request until it was successful. So good! - --- J, Software Engineer - - -> I asked Goose to write up a few Google Scripts that mimic Clockwise's functionality (particularly, creating blocks on my work calendar based on events in my personal calendar, as well as color-coding calendar entries based on type and importance). Took me under an hour. If you haven't tried Goose yet, I highly encourage you to do so! - --- 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. - --- A, Android Engineer - - -> Hi team, thank you for much for making Goose, it's so amazing. Our team is working on migrating Dashboard components to React components. I am working with Goose to help the migration. - --- K, Software Engineer - - -> Got Goose to update a dependency, run tests, make a branch and a commit... it was 🤌. Not that complicated but I was impressed it figured out how to run tests from the README. - --- J, Software Engineer - - -> Wanted to document what I had Goose do -- took about 30 minutes end to end! I created a custom CLI command in the `gh CLI` library to download in-line comments on PRs about code changes (currently they aren't directly viewable). I don't know Go *that well* and I definitely didn't know where to start looking in the code base or how to even test the new command was working and Goose did it all for me 😁 - --- L, Software Engineer - - -> Hi Team, just wanted to share my experience of using Goose as a non-engineer! ... I just asked Goose to ensure that my environment is up to date and copied over a guide into my prompt. Goose managed everything flawlessly, keeping me informed at every step... I was truly impressed with how well it works and how easy it was to get started! 😍 - --- M, Product Manager - -**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 - something like a natural language driven code interpreter. 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]. - -### 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 - -## Getting involved! - -There is a lot to do! If you're interested in contributing, a great place to start is picking a `good-first-issue`-labelled ticket from our [issues list][gh-issues]. More details on how to develop Goose can be found in our [Contributing Guide][contributing]. We are a friendly, collaborative group and look forward to working together![^1] - - -Check out and contribute to more experimental features in [Goose Plugins][goose-plugins]! - -Let us know what you think in our [Discussions][discussions] or the [**`#goose`** channel on Discord][goose-channel]. - -[^1]: Yes, Goose is open source and always will be. Goose is released under the ASL2.0 license meaning you are free to use it however you like. See [LICENSE.md][license] for more details. - - - -[goose-plugins]: https://github.com/block-open-source/goose-plugins - -[pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx -[contributing]: CONTRIBUTING.md -[license]: LICENSE.md - -[goose-docs]: https://block-open-source.github.io/goose/ -[toolkits]: https://block-open-source.github.io/goose/plugins/available-toolkits.html -[configuration]: https://block-open-source.github.io/goose/configuration.html -[cli]: https://block-open-source.github.io/goose/plugins/cli.html -[providers]: https://block-open-source.github.io/goose/providers.html -[use-cases]: https://block-open-source.github.io/goose/guidance/applications.html -[getting-started]: https://block-open-source.github.io/goose/guidance/getting-started.html - -[discord-invite]: https://discord.gg/7GaTvbDwga -[gh-issues]: https://github.com/block-open-source/goose/issues -[van-code]: https://github.com/block-open-source/goose-plugins/blob/de98cd6c29f8e7cd3b6ace26535f24ac57c9effa/src/goose_plugins/toolkits/artify.py -[discussions]: https://github.com/block-open-source/goose/discussions -[goose-channel]: https://discord.com/channels/1287729918100246654/1287729920319033345 -[goose-ai-pypi]: https://pypi.org/project/goose-ai/ - - diff --git a/README.md b/README.md new file mode 120000 index 00000000..e8923303 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +docs/index.md \ No newline at end of file From aa6086c97edd8adeda8642fa72898829b5d85b08 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:07:10 -0400 Subject: [PATCH 12/25] update docs yaml --- .github/workflows/deploy_docs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index f5cf5f7b..6db6c977 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -20,7 +20,7 @@ jobs: uses: actions/checkout@v4 - name: Install UV - run: curl -LsSf https://astral.sh/uv/install.sh | sh + uses: astral-sh/setup-uv@v3 - name: Build the documentation run: uv run mkdocs gh-deploy --force From 5c31a527fbf5689d25fca1b28031eb0b03b67eb9 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:15:14 -0400 Subject: [PATCH 13/25] just make index and readme independent --- .github/workflows/deploy_docs.yaml | 1 + README.md | 185 ++++++++++++++++++++++++++++- docs/index.md | 184 +++++++++++++++++++++++++++- 3 files changed, 368 insertions(+), 2 deletions(-) mode change 120000 => 100644 README.md mode change 120000 => 100644 docs/index.md diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 6db6c977..1b30d38a 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -9,6 +9,7 @@ on: paths: - 'docs/**' - 'mkdocs.yml' + - 'README.md' - '.github/workflows/deploy_docs.yaml' jobs: diff --git a/README.md b/README.md deleted file mode 120000 index e8923303..00000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -docs/index.md \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..a1c30473 --- /dev/null +++ b/README.md @@ -0,0 +1,184 @@ +

+Goose is your on-machine developer agent, automating engineering tasks seamlessly within your IDE or terminal +

+ +

+ Goose Drawing +

+

+ Generated by Goose from its VincentVanCode toolkit. +

+ +

+ + + + + + + + + + + Discord + +

+ +

+Unique features 🤖 • + Block Employees on Goose Block Emoji • +Quick start guide 🚀 • +Getting involved! 👋 +

+ +> [!TIP] +> **Quick install:** +> ``` +> pipx install goose-ai +> ``` + +**Goose** is a developer agent that supercharges your software development by automating an array of coding tasks directly within your terminal or IDE. Guided by you, it can intelligently assess your project's needs, generate the required code or modifications, and implement these changes on its own. Goose can **interact with a multitude of tools via external APIs** such as Jira, GitHub, Slack, infrastructure and data pipelines, and more -- if your task uses a **shell command or can be carried out by a Python script, Goose can do it for you too!** Like semi-autonomous driving, Goose handles the heavy lifting, allowing you to focus on other priorities. Simply set it on a task and return later to find it completed, boosting your productivity with less manual effort. + +

+

+ + + +## Unique features of Goose compared to other AI assistants + +- **Autonomy**: A copilot should be able to also fly the plane at times, which in the development world means running code, debugging tests, installing dependencies, not just providing text output and autocomplete or search. Goose moves beyond just generating code snippets by (1) **using the shell** and (2) by seeing what happens with the code it writes and starting a feedback loop to solve harder problems, **refining solutions iteratively like a human developer**. Your code's best wingman. + +- **Extensibility**: Open-source and fully customizable, Goose integrates with your workflow and allows you to extend it for even more control. **Toolkits let you add new capabilities to Goose.** They are anything you can implement as a Python function (e.g. API requests, deployments, search, etc). We have a growing library of toolkits to use, but more importantly you can create your own. This gives Goose the ability to run these commands and decide if and when a tool is needed to complete your request! **Creating your own toolkits give you a way to bring your own private context into Goose's capabilities.** And you can use *any* LLM you want under the hood, as long as it supports tool use. + +## What Block employees have to say about Goose + +> With Goose, I feel like I am Maverick. +> +> Thanks a ton for creating this. 🙏 +> I have been having way too much fun with it today. + +-- P, Machine Learning Engineer + + +> I wanted to construct some fake data for an API with a large request body and business rules I haven't memorized. So I told Goose which object to update and a test to run that calls the vendor. Got it to use the errors descriptions from the vendor response to keep correcting the request until it was successful. So good! + +-- J, Software Engineer + + +> I asked Goose to write up a few Google Scripts that mimic Clockwise's functionality (particularly, creating blocks on my work calendar based on events in my personal calendar, as well as color-coding calendar entries based on type and importance). Took me under an hour. If you haven't tried Goose yet, I highly encourage you to do so! + +-- 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. + +-- A, Android Engineer + + +> Hi team, thank you for much for making Goose, it's so amazing. Our team is working on migrating Dashboard components to React components. I am working with Goose to help the migration. + +-- K, Software Engineer + + +> Got Goose to update a dependency, run tests, make a branch and a commit... it was 🤌. Not that complicated but I was impressed it figured out how to run tests from the README. + +-- J, Software Engineer + + +> Wanted to document what I had Goose do -- took about 30 minutes end to end! I created a custom CLI command in the `gh CLI` library to download in-line comments on PRs about code changes (currently they aren't directly viewable). I don't know Go *that well* and I definitely didn't know where to start looking in the code base or how to even test the new command was working and Goose did it all for me 😁 + +-- L, Software Engineer + + +> Hi Team, just wanted to share my experience of using Goose as a non-engineer! ... I just asked Goose to ensure that my environment is up to date and copied over a guide into my prompt. Goose managed everything flawlessly, keeping me informed at every step... I was truly impressed with how well it works and how easy it was to get started! 😍 + +-- M, Product Manager + +**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 - something like a natural language driven code interpreter. 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]. + +### 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 + +## Getting involved! + +There is a lot to do! If you're interested in contributing, a great place to start is picking a `good-first-issue`-labelled ticket from our [issues list][gh-issues]. More details on how to develop Goose can be found in our [Contributing Guide][contributing]. We are a friendly, collaborative group and look forward to working together![^1] + + +Check out and contribute to more experimental features in [Goose Plugins][goose-plugins]! + +Let us know what you think in our [Discussions][discussions] or the [**`#goose`** channel on Discord][goose-channel]. + +[^1]: Yes, Goose is open source and always will be. Goose is released under the ASL2.0 license meaning you are free to use it however you like. See [LICENSE.md][license] for more details. + + + +[goose-plugins]: https://github.com/block-open-source/goose-plugins + +[pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx +[contributing]: CONTRIBUTING.md +[license]: LICENSE.md + +[goose-docs]: https://block-open-source.github.io/goose/ +[toolkits]: https://block-open-source.github.io/goose/plugins/available-toolkits.html +[configuration]: https://block-open-source.github.io/goose/configuration.html +[cli]: https://block-open-source.github.io/goose/plugins/cli.html +[providers]: https://block-open-source.github.io/goose/providers.html +[use-cases]: https://block-open-source.github.io/goose/guidance/applications. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 120000 index 32d46ee8..00000000 --- a/docs/index.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..bad6ce0d --- /dev/null +++ b/docs/index.md @@ -0,0 +1,183 @@ +

+Goose is your on-machine developer agent, automating engineering tasks seamlessly within your IDE or terminal +

+ +

+ Goose Drawing +

+

+ Generated by Goose from its VincentVanCode toolkit. +

+ +

+ + + + + + + + + + + Discord + +

+ +

+Unique features 🤖 • + Block Employees on Goose Block Emoji • +Quick start guide 🚀 • +Getting involved! 👋 + +> [!TIP] +> **Quick install:** +> ``` +> pipx install goose-ai +> ``` + +**Goose** is a developer agent that supercharges your software development by automating an array of coding tasks directly within your terminal or IDE. Guided by you, it can intelligently assess your project's needs, generate the required code or modifications, and implement these changes on its own. Goose can **interact with a multitude of tools via external APIs** such as Jira, GitHub, Slack, infrastructure and data pipelines, and more -- if your task uses a **shell command or can be carried out by a Python script, Goose can do it for you too!** Like semi-autonomous driving, Goose handles the heavy lifting, allowing you to focus on other priorities. Simply set it on a task and return later to find it completed, boosting your productivity with less manual effort. + +

+

+ + + +## Unique features of Goose compared to other AI assistants + +- **Autonomy**: A copilot should be able to also fly the plane at times, which in the development world means running code, debugging tests, installing dependencies, not just providing text output and autocomplete or search. Goose moves beyond just generating code snippets by (1) **using the shell** and (2) by seeing what happens with the code it writes and starting a feedback loop to solve harder problems, **refining solutions iteratively like a human developer**. Your code's best wingman. + +- **Extensibility**: Open-source and fully customizable, Goose integrates with your workflow and allows you to extend it for even more control. **Toolkits let you add new capabilities to Goose.** They are anything you can implement as a Python function (e.g. API requests, deployments, search, etc). We have a growing library of toolkits to use, but more importantly you can create your own. This gives Goose the ability to run these commands and decide if and when a tool is needed to complete your request! **Creating your own toolkits give you a way to bring your own private context into Goose's capabilities.** And you can use *any* LLM you want under the hood, as long as it supports tool use. + +## What Block employees have to say about Goose + +> With Goose, I feel like I am Maverick. +> +> Thanks a ton for creating this. 🙏 +> I have been having way too much fun with it today. + +-- P, Machine Learning Engineer + + +> I wanted to construct some fake data for an API with a large request body and business rules I haven't memorized. So I told Goose which object to update and a test to run that calls the vendor. Got it to use the errors descriptions from the vendor response to keep correcting the request until it was successful. So good! + +-- J, Software Engineer + + +> I asked Goose to write up a few Google Scripts that mimic Clockwise's functionality (particularly, creating blocks on my work calendar based on events in my personal calendar, as well as color-coding calendar entries based on type and importance). Took me under an hour. If you haven't tried Goose yet, I highly encourage you to do so! + +-- 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. + +-- A, Android Engineer + + +> Hi team, thank you for much for making Goose, it's so amazing. Our team is working on migrating Dashboard components to React components. I am working with Goose to help the migration. + +-- K, Software Engineer + + +> Got Goose to update a dependency, run tests, make a branch and a commit... it was 🤌. Not that complicated but I was impressed it figured out how to run tests from the README. + +-- J, Software Engineer + + +> Wanted to document what I had Goose do -- took about 30 minutes end to end! I created a custom CLI command in the `gh CLI` library to download in-line comments on PRs about code changes (currently they aren't directly viewable). I don't know Go *that well* and I definitely didn't know where to start looking in the code base or how to even test the new command was working and Goose did it all for me 😁 + +-- L, Software Engineer + + +> Hi Team, just wanted to share my experience of using Goose as a non-engineer! ... I just asked Goose to ensure that my environment is up to date and copied over a guide into my prompt. Goose managed everything flawlessly, keeping me informed at every step... I was truly impressed with how well it works and how easy it was to get started! 😍 + +-- M, Product Manager + +**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 - something like a natural language driven code interpreter. 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]. + +### 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 + +## Getting involved! + +There is a lot to do! If you're interested in contributing, a great place to start is picking a `good-first-issue`-labelled ticket from our [issues list][gh-issues]. More details on how to develop Goose can be found in our [Contributing Guide][contributing]. We are a friendly, collaborative group and look forward to working together![^1] + + +Check out and contribute to more experimental features in [Goose Plugins][goose-plugins]! + +Let us know what you think in our [Discussions][discussions] or the [**`#goose`** channel on Discord][goose-channel]. + +[^1]: Yes, Goose is open source and always will be. Goose is released under the ASL2.0 license meaning you are free to use it however you like. See [LICENSE.md][license] for more details. + + + +[goose-plugins]: https://github.com/block-open-source/goose-plugins + +[pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx +[contributing]: CONTRIBUTING.md +[license]: LICENSE.md + +[goose-docs]: https://block-open-source.github.io/goose/ +[toolkits]: https://block-open-source.github.io/goose/plugins/available-toolkits.html +[configuration]: https://block-open-source.github.io/goose/configuration.html +[cli]: https://block-open-source.github.io/goose/plugins/cli.html +[providers]: https://block-open-source.github.io/goose/providers.html +[use-cases]: https://block-open-source.github.io/goose/guidance/applications. \ No newline at end of file From 32ad1c2790144487e09de18beab5ed81fc286693 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:19:47 -0400 Subject: [PATCH 14/25] add back links --- README.md | 10 +++++++++- docs/index.md | 12 ++++++++++-- 2 files changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a1c30473..7d7a8857 100644 --- a/README.md +++ b/README.md @@ -181,4 +181,12 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [configuration]: https://block-open-source.github.io/goose/configuration.html [cli]: https://block-open-source.github.io/goose/plugins/cli.html [providers]: https://block-open-source.github.io/goose/providers.html -[use-cases]: https://block-open-source.github.io/goose/guidance/applications. \ No newline at end of file +[use-cases]: https://block-open-source.github.io/goose/guidance/applications +[getting-started]: https://block-open-source.github.io/goose/guidance/getting-started.html + +[discord-invite]: https://discord.gg/7GaTvbDwga +[gh-issues]: https://github.com/block-open-source/goose/issues +[van-code]: https://github.com/block-open-source/goose-plugins/blob/de98cd6c29f8e7cd3b6ace26535f24ac57c9effa/src/goose_plugins/toolkits/artify.py +[discussions]: https://github.com/block-open-source/goose/discussions +[goose-channel]: https://discord.com/channels/1287729918100246654/1287729920319033345 +[goose-ai-pypi]: https://pypi.org/project/goose-ai/ \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index bad6ce0d..57933849 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,7 +30,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl Quick start guide 🚀 • Getting involved! 👋 -> [!TIP] +>[!TIP] > **Quick install:** > ``` > pipx install goose-ai @@ -180,4 +180,12 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [configuration]: https://block-open-source.github.io/goose/configuration.html [cli]: https://block-open-source.github.io/goose/plugins/cli.html [providers]: https://block-open-source.github.io/goose/providers.html -[use-cases]: https://block-open-source.github.io/goose/guidance/applications. \ No newline at end of file +[use-cases]: https://block-open-source.github.io/goose/guidance/applications +[getting-started]: https://block-open-source.github.io/goose/guidance/getting-started.html + +[discord-invite]: https://discord.gg/7GaTvbDwga +[gh-issues]: https://github.com/block-open-source/goose/issues +[van-code]: https://github.com/block-open-source/goose-plugins/blob/de98cd6c29f8e7cd3b6ace26535f24ac57c9effa/src/goose_plugins/toolkits/artify.py +[discussions]: https://github.com/block-open-source/goose/discussions +[goose-channel]: https://discord.com/channels/1287729918100246654/1287729920319033345 +[goose-ai-pypi]: https://pypi.org/project/goose-ai/ \ No newline at end of file From 6c5db3ce4700ce0faa3f9f860ece53f6a5788003 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:22:37 -0400 Subject: [PATCH 15/25] add html close --- docs/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/index.md b/docs/index.md index 57933849..a0d11c36 100644 --- a/docs/index.md +++ b/docs/index.md @@ -29,6 +29,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl Block Employees on Goose Block Emoji • Quick start guide 🚀 • Getting involved! 👋 +

>[!TIP] > **Quick install:** From 8e667f25bbfa0c8893a02bda84fa26033bc4fabe Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:31:09 -0400 Subject: [PATCH 16/25] try to fix broken video --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index a0d11c36..713a25d9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -40,7 +40,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl **Goose** is a developer agent that supercharges your software development by automating an array of coding tasks directly within your terminal or IDE. Guided by you, it can intelligently assess your project's needs, generate the required code or modifications, and implement these changes on its own. Goose can **interact with a multitude of tools via external APIs** such as Jira, GitHub, Slack, infrastructure and data pipelines, and more -- if your task uses a **shell command or can be carried out by a Python script, Goose can do it for you too!** Like semi-autonomous driving, Goose handles the heavy lifting, allowing you to focus on other priorities. Simply set it on a task and return later to find it completed, boosting your productivity with less manual effort.

-

From 09a6310e91e74fe6a27139a20ed1fa4654fda40d Mon Sep 17 00:00:00 2001 From: lily-de <119957291+lily-de@users.noreply.github.com> Date: Tue, 8 Oct 2024 11:33:23 -0400 Subject: [PATCH 17/25] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 7d7a8857..b241c979 100644 --- a/README.md +++ b/README.md @@ -181,7 +181,7 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [configuration]: https://block-open-source.github.io/goose/configuration.html [cli]: https://block-open-source.github.io/goose/plugins/cli.html [providers]: https://block-open-source.github.io/goose/providers.html -[use-cases]: https://block-open-source.github.io/goose/guidance/applications +[use-cases]: https://block-open-source.github.io/goose/guidance/applications.html [getting-started]: https://block-open-source.github.io/goose/guidance/getting-started.html [discord-invite]: https://discord.gg/7GaTvbDwga From d4e876110dadb905fdabafab55d86295a891e038 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:35:36 -0400 Subject: [PATCH 18/25] fix broken link --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 713a25d9..b3b963dc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -181,7 +181,7 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [configuration]: https://block-open-source.github.io/goose/configuration.html [cli]: https://block-open-source.github.io/goose/plugins/cli.html [providers]: https://block-open-source.github.io/goose/providers.html -[use-cases]: https://block-open-source.github.io/goose/guidance/applications +[use-cases]: https://block-open-source.github.io/goose/guidance/applications.html [getting-started]: https://block-open-source.github.io/goose/guidance/getting-started.html [discord-invite]: https://discord.gg/7GaTvbDwga From 9b0e4e182f74310d4ba36627b6be473efac5552a Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:47:17 -0400 Subject: [PATCH 19/25] remove video --- docs/index.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/index.md b/docs/index.md index b3b963dc..b8da0a9d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,12 +39,6 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl **Goose** is a developer agent that supercharges your software development by automating an array of coding tasks directly within your terminal or IDE. Guided by you, it can intelligently assess your project's needs, generate the required code or modifications, and implement these changes on its own. Goose can **interact with a multitude of tools via external APIs** such as Jira, GitHub, Slack, infrastructure and data pipelines, and more -- if your task uses a **shell command or can be carried out by a Python script, Goose can do it for you too!** Like semi-autonomous driving, Goose handles the heavy lifting, allowing you to focus on other priorities. Simply set it on a task and return later to find it completed, boosting your productivity with less manual effort. -

- -

- - - ## Unique features of Goose compared to other AI assistants - **Autonomy**: A copilot should be able to also fly the plane at times, which in the development world means running code, debugging tests, installing dependencies, not just providing text output and autocomplete or search. Goose moves beyond just generating code snippets by (1) **using the shell** and (2) by seeing what happens with the code it writes and starting a feedback loop to solve harder problems, **refining solutions iteratively like a human developer**. Your code's best wingman. From cb4083734a66cee20c6fc776d941090519cc7a15 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 11:51:17 -0400 Subject: [PATCH 20/25] remove local branch for testing --- .github/workflows/deploy_docs.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/workflows/deploy_docs.yaml b/.github/workflows/deploy_docs.yaml index 1b30d38a..06cdfb82 100644 --- a/.github/workflows/deploy_docs.yaml +++ b/.github/workflows/deploy_docs.yaml @@ -4,12 +4,10 @@ on: push: branches: - main # Trigger deployment on pushes to main - - ldelalande/fix-deploy-docs # TODO: remove paths: - 'docs/**' - 'mkdocs.yml' - - 'README.md' - '.github/workflows/deploy_docs.yaml' jobs: From edced102f985d58872a7d4d1322f26cddaf6b85a Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 12:01:43 -0400 Subject: [PATCH 21/25] update some broken links --- README.md | 6 +++--- docs/index.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b241c979..8b56da03 100644 --- a/README.md +++ b/README.md @@ -173,8 +173,8 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [goose-plugins]: https://github.com/block-open-source/goose-plugins [pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx -[contributing]: CONTRIBUTING.md -[license]: LICENSE.md +[contributing]: https://github.com/block-open-source/goose/blob/main/CONTRIBUTING.md +[license]: https://github.com/block-open-source/goose/blob/main/LICENSE [goose-docs]: https://block-open-source.github.io/goose/ [toolkits]: https://block-open-source.github.io/goose/plugins/available-toolkits.html @@ -189,4 +189,4 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [van-code]: https://github.com/block-open-source/goose-plugins/blob/de98cd6c29f8e7cd3b6ace26535f24ac57c9effa/src/goose_plugins/toolkits/artify.py [discussions]: https://github.com/block-open-source/goose/discussions [goose-channel]: https://discord.com/channels/1287729918100246654/1287729920319033345 -[goose-ai-pypi]: https://pypi.org/project/goose-ai/ \ No newline at end of file +[goose-ai-pypi]: https://pypi.org/project/goose-ai \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index b8da0a9d..71dd2b40 100644 --- a/docs/index.md +++ b/docs/index.md @@ -167,8 +167,8 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [goose-plugins]: https://github.com/block-open-source/goose-plugins [pipx]: https://github.com/pypa/pipx?tab=readme-ov-file#install-pipx -[contributing]: CONTRIBUTING.md -[license]: LICENSE.md +[contributing]: https://github.com/block-open-source/goose/blob/main/CONTRIBUTING.md +[license]: https://github.com/block-open-source/goose/blob/main/LICENSE [goose-docs]: https://block-open-source.github.io/goose/ [toolkits]: https://block-open-source.github.io/goose/plugins/available-toolkits.html @@ -183,4 +183,4 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [van-code]: https://github.com/block-open-source/goose-plugins/blob/de98cd6c29f8e7cd3b6ace26535f24ac57c9effa/src/goose_plugins/toolkits/artify.py [discussions]: https://github.com/block-open-source/goose/discussions [goose-channel]: https://discord.com/channels/1287729918100246654/1287729920319033345 -[goose-ai-pypi]: https://pypi.org/project/goose-ai/ \ No newline at end of file +[goose-ai-pypi]: https://pypi.org/project/goose-ai \ No newline at end of file From ff61954d8d8ea2e3cf26e37344e92461b51d4ca0 Mon Sep 17 00:00:00 2001 From: Lily Delalande Date: Tue, 8 Oct 2024 12:05:56 -0400 Subject: [PATCH 22/25] use direct link for pypi badge --- README.md | 3 +-- docs/index.md | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8b56da03..3ec4631e 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl - + @@ -189,4 +189,3 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [van-code]: https://github.com/block-open-source/goose-plugins/blob/de98cd6c29f8e7cd3b6ace26535f24ac57c9effa/src/goose_plugins/toolkits/artify.py [discussions]: https://github.com/block-open-source/goose/discussions [goose-channel]: https://discord.com/channels/1287729918100246654/1287729920319033345 -[goose-ai-pypi]: https://pypi.org/project/goose-ai \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 71dd2b40..ec8e7e5e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -13,7 +13,7 @@ Goose is your on-machine developer agent, automating engineering tasks seamlessl - + @@ -183,4 +183,3 @@ Let us know what you think in our [Discussions][discussions] or the [**`#goose`* [van-code]: https://github.com/block-open-source/goose-plugins/blob/de98cd6c29f8e7cd3b6ace26535f24ac57c9effa/src/goose_plugins/toolkits/artify.py [discussions]: https://github.com/block-open-source/goose/discussions [goose-channel]: https://discord.com/channels/1287729918100246654/1287729920319033345 -[goose-ai-pypi]: https://pypi.org/project/goose-ai \ No newline at end of file From 385557a8a788f837cd7004da3804cc24b462173f Mon Sep 17 00:00:00 2001 From: lily-de <119957291+lily-de@users.noreply.github.com> Date: Tue, 8 Oct 2024 12:10:29 -0400 Subject: [PATCH 23/25] Update docs/scripts/gen_ref_pages.py --- docs/scripts/gen_ref_pages.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docs/scripts/gen_ref_pages.py b/docs/scripts/gen_ref_pages.py index 853614b4..54ffaea2 100644 --- a/docs/scripts/gen_ref_pages.py +++ b/docs/scripts/gen_ref_pages.py @@ -2,12 +2,6 @@ import mkdocs_gen_files -import logging - -# Set up logging -logging.basicConfig(level=logging.INFO, filename='mkdocs_gen_debug.log', filemode='w', format='%(name)s - %(levelname)s - %(message)s') - - nav = mkdocs_gen_files.Nav() root = Path(__file__).parent.parent.parent From 187257b247f9b9db8c7abb19827095e247b0b543 Mon Sep 17 00:00:00 2001 From: lily-de <119957291+lily-de@users.noreply.github.com> Date: Tue, 8 Oct 2024 12:10:35 -0400 Subject: [PATCH 24/25] Update docs/scripts/gen_ref_pages.py --- docs/scripts/gen_ref_pages.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/scripts/gen_ref_pages.py b/docs/scripts/gen_ref_pages.py index 54ffaea2..5cffb736 100644 --- a/docs/scripts/gen_ref_pages.py +++ b/docs/scripts/gen_ref_pages.py @@ -14,10 +14,7 @@ utils_modules = [] for path in sorted(src.rglob("*.py")): - logging.info("Processing file: {}".format(path)) module_path = path.relative_to(src).with_suffix("") - if module_path.parts[-1] == "diff": # Specifically check for the 'diff' case - logging.info("Diff path found: {}".format(path)) module_path = path.relative_to(src).with_suffix("") # Removes the '.py' suffix doc_path = path.relative_to(src).with_suffix(".md") # Creates .md path From b24e2f238f92e90a1ada55be34e6f9014fc9a6be Mon Sep 17 00:00:00 2001 From: lily-de <119957291+lily-de@users.noreply.github.com> Date: Tue, 8 Oct 2024 12:10:57 -0400 Subject: [PATCH 25/25] Update docs/scripts/gen_ref_pages.py --- docs/scripts/gen_ref_pages.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/scripts/gen_ref_pages.py b/docs/scripts/gen_ref_pages.py index 5cffb736..da964e59 100644 --- a/docs/scripts/gen_ref_pages.py +++ b/docs/scripts/gen_ref_pages.py @@ -14,7 +14,6 @@ utils_modules = [] for path in sorted(src.rglob("*.py")): - module_path = path.relative_to(src).with_suffix("") module_path = path.relative_to(src).with_suffix("") # Removes the '.py' suffix doc_path = path.relative_to(src).with_suffix(".md") # Creates .md path