wehub-resource-sync
8a21a212f8
Deploy Documentation / deploy (push) Has been cancelled
Canary / build-cli (push) Has been skipped
Canary / Upload Install Script (push) Has been skipped
Canary / bundle-desktop (push) Has been skipped
Canary / bundle-desktop-intel (push) Has been skipped
Canary / bundle-desktop-linux (push) Has been skipped
Canary / bundle-desktop-windows (push) Has been skipped
Canary / bundle-desktop-windows-cuda (push) Has been skipped
Canary / Release (push) Has been skipped
Cargo Deny / deny (push) Has been skipped
Unused Dependencies / machete (push) Has been skipped
Canary / Prepare Version (push) Failing after 1s
Live Provider Tests / check-fork (push) Failing after 0s
Create Minor Release PR / check-version-bump-pr (push) Has been skipped
Publish Ask AI Bot Docker Image / docker (push) Failing after 1s
Live Provider Tests / changes (push) Has been skipped
Scorecard supply-chain security / Scorecard analysis (push) Has been skipped
Publish Docker Image / docker (push) Failing after 1s
CI / changes (push) Failing after 8s
Create Minor Release PR / release (push) Has been skipped
Live Provider Tests / Smoke Tests (push) Has been cancelled
Live Provider Tests / Smoke Tests (Code Execution) (push) Has been cancelled
Live Provider Tests / Compaction Tests (push) Has been cancelled
CI / Build Rust Project on Windows (push) Has been cancelled
Live Provider Tests / Build Binary (push) Has been cancelled
CI / Lint Rust Code (push) Has been cancelled
CI / Check Generated Schemas are Up-to-Date (push) Has been cancelled
CI / Test and Lint Electron Desktop App (push) Has been cancelled
CI / Check Rust Code Format (push) Has been cancelled
CI / Build and Test Rust Project (push) Has been cancelled
CI / Check MSRV (push) Has been cancelled
49 lines
1.5 KiB
Markdown
49 lines
1.5 KiB
Markdown
# hello-hooks
|
|
|
|
A tiny [Open Plugins](https://open-plugins.com) plugin that demonstrates goose's
|
|
hook system. It registers four event handlers — `SessionStart`,
|
|
`UserPromptSubmit`, `PreToolUse`, and `PostToolUse` (matched on
|
|
`developer__shell|developer__text_editor`) — that each shell out to
|
|
`scripts/announce.sh` to print a noticeable line to stderr and append the full
|
|
event payload to `last-event.log` next to the plugin.
|
|
|
|
## Layout
|
|
|
|
```
|
|
hello-hooks/
|
|
├── plugin.json
|
|
├── hooks/
|
|
│ └── hooks.json
|
|
└── scripts/
|
|
└── announce.sh
|
|
```
|
|
|
|
## Try it
|
|
|
|
Goose discovers plugins under `~/.agents/plugins/<name>/` (user scope) and
|
|
`<project-root>/.agents/plugins/<name>/` (project scope) per the Open Plugins
|
|
[installation spec](https://open-plugins.com/plugin-builders/installation#recommended-storage-paths).
|
|
|
|
```bash
|
|
mkdir -p ~/.agents/plugins
|
|
cp -R examples/plugins/hello-hooks ~/.agents/plugins/hello-hooks
|
|
chmod +x ~/.agents/plugins/hello-hooks/scripts/announce.sh
|
|
|
|
# Then run goose normally; you should see lines like
|
|
# 🚀 [hello-hooks] SessionStart
|
|
# 💬 [hello-hooks] UserPromptSubmit
|
|
# ⚡ [hello-hooks] PreToolUse tool=developer__shell
|
|
# ✅ [hello-hooks] PostToolUse tool=developer__shell
|
|
goose session
|
|
|
|
# Inspect the full payloads goose passed to the hook:
|
|
tail ~/.agents/plugins/hello-hooks/last-event.log
|
|
```
|
|
|
|
To turn the plugin off, add it to `disabledPlugins` in
|
|
`~/.config/goose/settings.json`:
|
|
|
|
```json
|
|
{ "disabledPlugins": ["hello-hooks"] }
|
|
```
|