Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.45 KB

explain.md

File metadata and controls

41 lines (30 loc) · 1.45 KB
title rootform explain
description Justify an instance, Rule application, or recorded Policy outcome.

Use explain instance to trace one instance at a stage of a Form. Use explain rule to trace how one Rule applied in an input. Use explain policy to inspect an outcome already recorded by rootform check. For definitions, use show; for the current selection, use list.

Usage

rootform explain <command> [options]

Options

Global options

Flag Type Default Description
-h, --help bool false show how to use rootform explain
--color mode auto color human output: auto|always|never; default: auto
--no-pager bool false print a long report in full instead of opening it in less

Subcommands

Command Purpose
rootform explain instance Explain how one instance was interpreted
rootform explain policy Explain one Policy outcome recorded by check
rootform explain rule Explain how one Rule applied in an input

Instance and Rule explanations read inputs as run does. A Policy explanation reads a saved Policy result and never evaluates the Policy again.