Community plugins repository for Goose 🧩

🎉 Hacktoberfest 2024 🎉

goose-plugins is a participating project in Hacktoberfest 2024! We’re so excited for your contributions, and have created a wide variety of issues so that anyone can contribute. Whether you're a seasoned developer or a first-time open source contributor, there's something for everyone.

To get started:

1. Read the contributing guide.
2. Read the code of conduct.
3. Choose a task from this project's Hacktoberfest issues in here and follow the instructions. Each issue has the 🏷️ hacktoberfest label.

Have questions? Connecting with us in our Discord community in the #hacktoberfest and #goose-toolkits project channel.

Installation

pipx install goose-plugins --include-deps

To check that the plugins are installed, run

goose toolkit list

You should see the artify plugin in the list of available toolkits.

Then to run Goose,

goose session start

Developing Plugins

Check out the Goose docs on plugins!

1. Clone the goose-plugins-exemplar repository and the goose repository

   git clone https://github.com/block-open-source/goose
   git clone https://github.com/block-open-source/goose-plugins

2. Create the virtual environment for Goose in the Goose repo

   uv sync
   uv venv

   Run the source ... activate command that is output by the uv venv command

3. Install the goose community plugins in editable mode

   uv add --editable ~/path/to/goose-plugins

4. Run goose via uv run to iteratively develop your plugin

   uv run goose session start