← Back to Docs
Recipe

Recipe: SECURITY.md / responsible-disclosure writer

Generate a polished SECURITY.md with safe-harbor language, PGP key block, scope boundaries, and SLA commitments — ready to commit.

What it does

Takes your project name, contact email, PGP fingerprint, and preferred response SLA. Produces a complete SECURITY.md with responsible-disclosure policy, safe-harbor clause, scope definition, and embedded ASCII-armored PGP key block.

Inputs

  • Project name and repository URL
  • Security contact email
  • PGP public key (ASCII-armored block)
  • Response SLA (e.g., 48 hours for acknowledgment)
  • Scope boundaries (in-scope / out-of-scope)

Output

A single Markdown file with structured sections: Reporting, Safe Harbor, Scope, PGP Key, SLA, and Recognition. Includes legal-safe language vetted against common disclosure templates. Drop it into your repo root and GitHub surfaces it automatically on the Security tab.

Usage

nimbus recipe security-md --project "MyApp" --email security@example.com --pgp-key ./pubkey.asc --sla 48h

Ready to try it?

Open a terminal and run the recipe against your repo. No configuration needed.

Browse all recipes