heinzel-example

Show how a Heinzelmännchen plugin is built: one module with an operation, settings, a health check and a submodule.

A plugin for Heinzelmännchen, the open-source, AI-driven operating system for product development teams. It lives in heinzel-plugins. Its earlier history is preserved in heinzel-contrib and the archived heinzel-example repository.

Install

With Heinzelmännchen installed (uv tool install git+https://github.com/helmut-hoffer-von-ankershoffen/heinzel):

hz system plugin add "heinzel-example @ git+https://github.com/helmut-hoffer-von-ankershoffen/heinzel-plugins#subdirectory=plugins/heinzel-example"

Running hz system plugin add again upgrades; hz system plugin remove heinzel-example removes it.

Use

hz example info                 # this plugin, its version and the Heinzelmännchen it runs on
hz example hello --name Ada     # a submodule collapsed into a command
hz example info --json          # every command speaks JSON, for scripts and agents
hz system info                  # includes a section contributed by this plugin

Develop

From the repository root: make check-fast NAME=example runs this plugin's edit loop; make check NAME=example runs its full checks. make build NAME=example and make acceptance NAME=example verify its installed artifact. The modules live in src/heinzel_example/; read the root AGENTS.md before changing them.

Development and release commands: repository guide.

Migration provenance: heinzel-contrib, before the 0.9 plugin-boundary migration.