Skip to main content

Command Reference

All commands ship in the standard stave binary. No build tags are required. Descriptions are each command's one-line summary; run stave <command> --help for full usage, flags, and exit codes.

140 commands across 7 groups.

Getting Started

CommandDescription
generateGenerate starter artifacts
generate observationGenerate an observation template

Control Engine

CommandDescription
applyRun control evaluation after plan checks pass
diagnoseDiagnose evaluation inputs and results
diagnose explainGenerate guided remediation playbook for a finding
diagnose findingDeep-dive analysis of a single finding
diagnose reportGenerate a plain-text report from evaluation output
diagnose traceTrace predicate evaluation for a single control against a single asset
expandShow every control sharing a structural defect archetype
explainExplain how a control evaluates and which fields it needs
validateValidate inputs without evaluation

Workflow & CI

CommandDescription
ciCI/CD policy and baseline commands
ci baselineManage baseline findings for fail-on-new CI workflows
ci baseline checkCompare evaluation findings against baseline and detect new findings
ci baseline saveSave evaluation findings as baseline
ci diffCompare two evaluations and report new findings
ci fixShow machine-readable fix plan for a finding
ci fix-loopRun apply-before/apply-after/verify in one command
ci gateEnforce CI failure policy modes from config or flags
snapshotSnapshot inspection commands
snapshot diffCompare the latest two observation snapshots
statusShow project context and the next recommended command

Data & Artifacts

CommandDescription
enforceGenerate deterministic enforcement templates from evaluation output
reportGenerate executive security posture report

Introspection

CommandDescription
featuresShow what Stave does and deliberately does not do
inspectLow-level security analysis primitives
inspect aclAnalyze S3 ACL grants
inspect aliasesList predicate aliases with metadata
inspect complianceResolve compliance framework crosswalk
inspect exposureClassify resource exposure vectors
inspect policyAnalyze an S3 bucket policy document
inspect riskScore risk from policy statement context

Settings

CommandDescription
completionGenerate shell completion scripts
configConfiguration commands
config contextNamed project context commands
config context createCreate or update a named context
config context deleteDelete a context
config context listList available contexts
config context showShow selected context
config context useSet active context
config deleteRemove a project config key (reverts to default)
config envManage environment variables
config env listList supported STAVE_* environment variables
config explainExplain resolved config values and sources
config getGet a config value
config setSet a project config value in stave.yaml
config showShow effective project configuration and value sources

Additional Commands

CommandDescription
aliasManage command aliases
alias deleteDelete an alias
alias listList all aliases
alias setCreate or update an alias
attestSnapshot tamper detection via Ed25519 signatures
attest keygenGenerate a new Ed25519 key pair for snapshot attestation
attest signSign a snapshot's assets with an Ed25519 private key
attest verifyVerify an attested snapshot against a public key
bisectFind when a control was first violated
bundleGenerate a sealed evidence bundle for air-gap GRC integration
bundle auditAssemble a compliance-period evidence package
capabilitiesPrint supported input types and version constraints (default) or a user-facing catalog (subcommand)
capabilities catalogPrint the user-facing capability catalog
celCEL expression tools
cel evalEvaluate a CEL expression against observation assets
checkCompare before/after evaluations to check remediation
compareCompare compliance posture between two frameworks
contractInspect Stave's per-asset-type input contracts
contract showShow the agent-facing contract for an asset type
controlsWork with control definitions
controls alias-explainShow expanded predicate for an alias
controls aliasesList built-in semantic predicate aliases
controls explainExplain a specific control
controls listList control IDs and names
controls qualityAnalyze control catalog metadata completeness and coverage gaps
controls searchSearch the built-in control catalog
coverageAnalyze observation field coverage against control predicates
diffCompare two observation snapshots or control catalogs
doctorCheck local environment readiness for Stave workflows
exemptManage risk acceptances (acknowledgments, exceptions, exemptions)
exempt acknowledgeAdd a formal risk acceptance
exempt assetAdd a scope exclusion (exemption)
exempt exceptAdd an operational suppression
exempt exportExport risk register as OSCAL POA&M
exempt historyShow full audit trail including expired entries
exempt listList all active risk acceptances
exempt removeMark an acknowledgment as revoked
exempt suggestSuggest exemptions for chronic/oscillating findings
exempt upcomingShow acceptances approaching expiry
exempt validateValidate the acceptance file
exportExport controls and compliance evidence
export changesExport remediation property changes from assessment findings
export complianceExport compliance evidence package
export ocsfExport findings as OCSF 1.1 Compliance Finding events
export oscalExport findings as OSCAL 1.1.2 Assessment Results JSON
export ticketsExport findings as canonical ticket records
export-controlsExport the control catalog for external solver consumption
export-sirExport the Stave Intermediate Representation as JSON
fingerprintPolicy fingerprint diagnostics
fingerprint explainShow the policy fingerprint preimage and diagnosis
fmtFormat control and observation files deterministically
forgeAuthor and test custom controls
forge chainAuthor and validate custom chains
forge chain lintValidate chain YAML
forge lintStatic analysis for control YAML files
forge newInteractive control authoring wizard
forge pathsList available observation property paths from a snapshot
forge previewEvaluate a predicate against a snapshot without writing files
forge scaffoldGenerate test fixtures from a real snapshot
forge testRun fixture-based assertions against a control
gapsReport which observation properties are absent + what they unlock
graphVisualize control and asset relationships
graph coverageShow which controls cover which assets
graph exportExport assessment as JSON, STIX 2.1, JSON-LD, or GraphML
lintLint control files for design quality
mapATT&CK tactic coverage and gap analysis
metricsWrite Prometheus scrape file for node_exporter
packsInspect built-in control packs
packs listList available built-in packs
packs showShow one built-in pack and its control IDs
pathExport attack path graph data from active chain findings
permissionsQuery net effective permissions from a snapshot
permissions principalResolve permissions for a specific principal ARN
permissions resourceShow who has effective access to a resource
permissions summaryAggregate NEP metrics across all principals
profileManage compliance profiles
profile createGenerate a starter profile YAML
profile listList available compliance profiles
profile validateValidate a profile file
readinessReport what Stave can/can't evaluate given the supplied observations
sanitizeSanitize a snapshot for cross-boundary sharing
schemasList all contract schemas
scoreCompute security posture score (0-100)
scorecardMulti-framework compliance scorecard
searchFind catalog entries matching a free-form intent
telemetryEmit structured NDJSON telemetry from assessment output
testRun embedded control test cases
trendAnalyze compliance posture trends across assessment runs
trend forecastProject posture score trajectory with SLA breach warnings
trend oscillationClassify violation oscillation patterns across assessment history
trend predictProject compliance readiness achievement date
validate-mappingValidate a Steampipe→Stave mapping file before use
versionPrint version and environment state