Skip to main content

stave explain

Explain how a control evaluates and which fields it needs

Usage

stave explain <control-id> [flags]

Description

Explain loads a single control and prints:

  • matched field paths used by predicates
  • operator/value expectations
  • a minimal obs.v0.1 snippet you can start from

Exit Codes: 0 Success 2 Input error 4 Internal error

Offline-only: reads local files; makes zero network connections; no cloud credentials.

Flags

FlagTypeDescription
--controlsstringPath to control definitions directory (default: controls)
-f, --formatstringOutput format: text or json (default: text)

Examples

stave explain --controls controls/s3 --format json