README
¶
nova-hook
What it is
nova-hook: hooks an acting identity to the live, proven pushes its role needs; some bus mailbox checks are advisory
Why use it
Tools gate the acting identity on the live, proven pushes its role needs. Some
nova-bus send and recv mailbox checks are advisory by default;
--require-push or NOVA_BUS_REQUIRE_PUSH=1 makes them strict. This is how you
hook in, see who is, and unhook.
Install
go install github.com/mas-bandwidth/nova-tools/cmd/nova-hook@latest
nova-hook version
First run
The transcript below is executed line for line by the docs tests; the full record is in docs/TESTS.md.
$ nova-hook status --as m1
$ nova-hook hook --as m1 --role member --once
$ nova-hook unhook --as m1
A session hooks in under its Monitor with nova-hook hook --as <name> --role <role> and answers each HOOK CHALLENGE line it prints with the nova-hook prove line that challenge carries.
Verbs
The reference for its verbs is docs/CLI.md.
statushookproveunhookversion
Spec
The contract is docs/SPEC-HOOK.md; the module is hook/, the machine tla/Hook.tla.
Documentation
¶
Overview ¶
nova-hook hooks an identity in: the one record, in the bus Redis, of the pushes its role needs (the bus, the sprint, its work), each live while its holder renews a lease and proven while a proof stands (docs/SPEC-HOOK.md; the module is hook/, the machine tla/Hook.tla). Tools gate the acting identity; some bus mailbox proofs are advisory unless --require-push is set or NOVA_BUS_REQUIRE_PUSH=1. The verbs are hook, prove, unhook and status; the dispatch, the banner, the help, the version verb, the refusals and the output envelope are pkg/tool's, and the rules are the hook module's.
Source Files