# Example plugins (repository reference templates)

## Personal plugins do **not** go here

**Installed plugins always live under `$FUROSHIKI_DATA/plugins/`** (default `~/.furoshiki/plugins/<name>/`). That is the only supported location for **your** integrations: anything with private API keys, host-specific paths, or personal workflows.

**This directory** (`furoshiki/examples/plugins/`) is **not** a second install location. It holds **curated, source-tree reference templates** meant for:

- **Loader / contract testing** and CI (`hook-test-suite`)
- **Reusable documentation samples** a maintainer **intends to ship in git** for every clone (policy samples, memory-recall, etc.)

**Do not commit** one-off, personal, or machine-specific plugins here. If it is not meant to be a **shared, reviewed template** for the project, keep it only under `$FUROSHIKI_DATA/plugins/`.

To copy a *published* example into your own install: `cp -r examples/plugins/hook-test-suite "$FUROSHIKI_DATA/plugins/"` (then adjust and `furoshiki extensions plugins reload`).

---

## Shipped reference plugins

**Canonical reference:** [`hook-test-suite/`](./hook-test-suite/) — exercises every hook type and is what maintainers use to verify the plugin loader.

**Policy / policy-adjacent samples:** [`profile-gap-policy-sample/`](./profile-gap-policy-sample/), [`post-inbound-policy-sample/`](./post-inbound-policy-sample/).

**Recall / memory tooling sample:** [`memory-deep-recall/`](./memory-deep-recall/) — callable using `read_user_facts`, **`read_memories`** (semantic `memories` search), optional Plugin LLM dossier, and dashboard **`settings_schema`** tunables.

See [`docs/PLUGIN-HOW-TO.md`](../../docs/PLUGIN-HOW-TO.md) and [`docs/PLUGIN-API.md`](../../docs/PLUGIN-API.md).
