add-module
Skill2 starsChanged 16 days agoMITView on GitHub
Add a module or submodule to Heinzelmännchen (or to a Heinzelmännchen plugin) the idiomatic way, with service, operations, tests and docs. Use when asked for a new command group, a new area of functionality, or a submodule of an existing module.
10 other projects use a version of this.
Adopted by
Most recently taken up by
- testcontainers/testcontainers-javatheir own version, first seen Nov 16, 2026
- heytcass/claudeostheir own version, first seen Oct 29, 2026
- Cassius2584/claude-uni-workspacetheir own version, first seen Oct 22, 2026
- testcontainers/testcontainers-nodetheir own version, first seen Oct 17, 2026
- ai-erp-collab/deterministic-context-routing-plugintheir own version, first seen Oct 15, 2026
- shubhsha/ai-engineer-2030their own version, first seen Oct 15, 2026
Other versions10 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 10
- testcontainers/testcontainers-java★ 8.8ksame name
- fullstackhero/dotnet-starter-kit★ 6.9ksame name
- testcontainers/testcontainers-node★ 2.6ksame name
- Cassius2584/claude-uni-workspace★ 5same name
- serhii12/vault-os★ 2same name
- AURORA-NEURO/aurora-agent★ 1same name
- heytcass/claudeos★ 1same name
- ai-erp-collab/deterministic-context-routing-plugin★ 0same name
- alimranfakir/Claude_skills★ 0same name
- shubhsha/ai-engineer-2030★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository18 other files it gives its agents.
- AGENTS.mdAGENTS.md
- .github/AGENTS.mdAGENTS.md
- tests/AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- .github/CLAUDE.mdCLAUDE.md
- starter/CLAUDE.mdCLAUDE.md
- template/CLAUDE.mdCLAUDE.md
- tests/CLAUDE.mdCLAUDE.md
- add-operationSkill
- codifySkill
- raise-the-barSkill
- releaseSkill
- reviewSkill
- scaffold-pluginSkill
- self-auditSkill
- ship-smallSkill
- write-adrSkill
- write-testsSkill
The file
We split this skill into the rules it gives an agent
4 rules. 0 are common, 1 is distinctive, and 3 are very specific to this project.
0
Common
Most of the 9 edited versions we read keep these.
1
Distinctive
This author's own choices. Worth a look.
3
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 23
Keep operations thin: annotate parameters Annotated[T, Field(description=...)], take the service by type, return a model.
- Very specific: line 28
Check it shows up: uv run hz system modules, uv run hz <name> --help.
- Distinctive: line 29
Update README (usage) and ARCHITECTURE.md if the module is part of the core story.
- Very specific: line 38
If people must or may configure the module before using it, declare one setup step: @module.setup (or required=True) on a function that …
“Common” is measured: kept by at least 6 in 10 of the 9 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Add a module
A module is a package whose __init__.py declares module = Module(name, summary). The kernel discovers it; there
is no registry to edit. A package nested in a module's package that declares its own module is a submodule.
Process
- Decide where it lives:
src/heinzel/modules/<name>/for core (generic, company-neutral — see INTENT.md tenet 9), or a plugin for anything specific. A new top-level concept in the core warrants an ADR (write-adr). - Create the package:
<name>/ __init__.py # module = Module(...); module.service(...); @module.operation functions; __all__ _models.py # pydantic models the operations return _service.py # the logic, a class whose constructor asks for what it needs by type _render.py # optional: rich renderers used as render= hints - Keep operations thin: annotate parameters
Annotated[T, Field(description=...)], take the service by type, return a model. RaiseHeinzelErrorfor failures a user should read. - Tests (
write-tests): unit tests for the service intests/unit/modules/, integration tests through the CLI head intests/integration/(build the app withmake_kernel(builtins=True, ...)). - Regenerate the references with
make docs(make lintfails until you do). - Check it shows up:
uv run hz system modules,uv run hz <name> --help. - Update README (usage) and ARCHITECTURE.md if the module is part of the core story.
- Optional, for a built-in module or a first-party plugin under plugins/ worth showing in the README demo: add a
demo.tapenext to its__init__.pywith a few realhzcommands (Type,Enter,Wait,Sleep,Hide,Show;Requirefor other programs it pipes into), runmake fixto regenerate docs/assets/demo.tape andmake demoto render the GIF; look at its last frames before committing it. Rules and an example: CONTRIBUTING.md, "The README demo".
Setup step (optional)
If people must or may configure the module before using it, declare one setup step: @module.setup (or
required=True) on a function that asks through an injected Prompter (text, choice, choices, confirm,
number, secret) and writes through ConfigEditor.write("<module>.<key>", value) and Credentials.set(...). It
runs as hz setup <module> and as part of hz setup, never as a command of the module, so declaring it never
changes the module's command path (ADR 0032).
Modules without a declared step get none. Test it with scripted answers: ScriptedPrompter([...]) bound with
kernel.bind(Prompter, ...), or the hz_prompter fixture.
Red flags
- The module imports another module's
_privatefile → inject its service instead. - An operation has more than a few lines of logic → move it into the service.
- The module imports
heinzel.heads→ never; userender=.
Verification
make checkpasseshz system moduleslists the module with its letshz <name> <operation> --jsonreturns valid JSON
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

