Notes Commands
The notes command group is a deprecated compatibility alias for control issues. Prefer pretorin issues ... for new work. Existing local notes/ files remain supported for one compatibility window.
Issues are the durable home for gaps, missing evidence, unresolved ambiguity, and remediation work. Narratives should describe implemented control state only, and evidence should describe artifacts and what they support only.
Create Local Note
pretorin notes create ac-02 fedramp-moderate \
-c "Gap: Missing SSO evidence. Manual next step: collect IdP configuration screenshots."
Creates a local markdown file at notes/<framework>/<control>/<slug>.md with YAML frontmatter. No markdown validation is applied to notes.
Options:
--content / -c— Note content (required)--name / -n— Custom name (defaults to content summary)
Push Notes
pretorin notes push --dry-run
pretorin notes push
Batch-pushes all unsynced local notes to the platform. Notes are append-only on the platform. After a successful push, the local file’s platform_synced frontmatter is set to true.
List Local Notes
pretorin notes list --local
pretorin notes list --local --framework fedramp-moderate
Use the --local flag to list local note files instead of platform notes.
List Platform Notes
pretorin notes list ac-02 fedramp-moderate --system "My System"
Add a Note (Direct to Platform)
pretorin notes add ac-02 fedramp-moderate \
--content "Gap: Missing SSO evidence. Manual next step: collect IdP configuration screenshots."
pretorin notes add ac-02 fedramp-moderate \
--content "MFA verified" --system "My System"
Options:
--content / -c— Note content (required)--system / -s— System name or ID (uses active context if omitted)
Resolve or Reopen a Note
# Resolve a note with an audit-trail justification
pretorin notes resolve ac-02 fedramp-moderate <note_id> --resolution-note "SSO config verified in IdP logs."
# Resolve with updated content and a resolution justification
pretorin notes resolve ac-02 fedramp-moderate <note_id> --resolution-note "SSO config verified." --content "Updated note text."
# Reopen a resolved note
pretorin notes resolve ac-02 fedramp-moderate <note_id> --reopen
Options:
--system / -s— System name or ID--reopen— Reopen a resolved note instead of resolving it--resolution-note / --justification— Required when resolving; stored as the closure audit trail--content / -c— Optional updated note content--pinned— Optional pinned state
Gap Issue Format
When adding issues for unresolved gaps, use this structured format:
Gap: <short title>
Observed: <what was verifiably found>
Missing: <what could not be verified>
Why missing: <access/system limitation>
Manual next step: <explicit user/platform action>
This format ensures consistency across CLI, MCP, and agent workflows when documenting compliance gaps. Prefer pretorin issues add for new work.