Skip to main content

stave contract show

Show the agent-facing contract for an asset type

Usage

stave contract show [flags]

Description

Show emits everything an agent needs to populate observations for one asset type:

  • the per-asset JSON Schema path
  • the property paths the catalog reads, with type, control count, chain count, and a "required vs optional" hint
  • any Steampipe mapping under contracts/steampipe/

Use --list to enumerate every asset type with at least one applicable_asset_types declaration in the catalog, showing whether each has a schema and a Steampipe mapping.

Inputs: --asset-type T Asset type to show (e.g. aws_s3_bucket) --list List every asset type with controls (no --asset-type) --controls DIR Control catalog (default: controls) --chains DIR Chain catalog (default: chains) --steampipe DIR Directory of Steampipe mappings (default: contracts/steampipe) --format F text (default) | json

Exit codes: 0 Success 2 Invalid input (missing flag, unknown asset type) 4 Internal error (catalog load failure)

Flags

FlagTypeDescription
--asset-typestringasset type to inspect (e.g. aws_s3_bucket)
--chainsstringchain catalog directory (default: chains)
-i, --controlsstringcontrol catalog directory (default: controls)
-f, --formatstringoutput format: text | json (default: text)
--listboollist every asset type with controls
--no-pagerboolnever page output, even on a terminal
--steampipestringSteampipe mapping directory (default: contracts/steampipe)

Examples

# Detailed view for one type
stave contract show --asset-type aws_s3_bucket

# All types with at-a-glance schema + mapping presence
stave contract show --list

# Machine-readable
stave contract show --asset-type aws_iam_role --format json