Open source · Security & Privacy

Rules of Engagement Builder

Generate unsigned engagement drafts from a bounded offline questionnaire.

v0.1.0 · Node.js 22+ · MIT

Browse the public repository · View releases

Generate a rules-of-engagement draft, a client authorization-letter draft, and an unsigned scope candidate from one local JSON questionnaire. Markdown and selectable-text PDFs share the same validated content. Drafts grant no permission, verify no identity, collect no signatures, and start no testing.

This walkthrough uses the tool's public README and checked-in example files. Run the command from a repository checkout with Node.js 22+.

Run the checked-in example

node bin/rules-of-engagement-builder.mjs --input examples/complete/questionnaire.json --out-dir drafts/ --human
node bin/rules-of-engagement-builder.mjs --help

Read the result

The output directory's parent must already exist. The tool may create only the final output directory. Five files are generated: rules-of-engagement.md, authorization-letter.md, their matching .pdf files, and scope-candidate.json. Existing final files are refused; choose a fresh directory for another run. Inputs are preserved. New documents have mode 0600; newly created output/staging directories have mode 0700, subject to the operating system's permission semantics.