kni.json

{
  "name": "kni",
  "description": [
    "kni <script.kni>"
  ],
  "usage": [
    "<scripts>{1..} :input Script file name(s)",
    "[-s <start>] Start script at this label",
    "[-J] Read kni script as compiled JSON",
    "[-j|--json] Write compiled script as JSON.",
    "[-h|--html <script>] :output Write interactive HTML file.",
    "[-d] Describe instead of running interactively.",
    "[-t <script>] :output Write a transcript.",
    "[-v <script>] :input Verify a prior recorded transcript.",
    "[-S <seed>] :number Seed the random number generator.",
    "[-r <waypoint>] :input Restore a saved waypoint in the story.",
    "[--di] Log input file before processing",
    "[--dr] Enable runtime debug logging",
    "[--dp] Enable parser debug logging",
    "[--dil] Enable inline lexer debug logging",
    "[--dol] Enable outline lexer debug logging",
    "[--ds] Enable scanner debug logging",
    "[--html-title <title>] Set the title for the generated page.",
    "[--html-color <color>] Set the foreground color for the generated page.",
    "[--html-background-color <color>] Set the background color for the generated page."
  ],
  "terms": {
    "scripts": {
      "flags": [],
      "arg": "scripts",
      "command": null,
      "collectorType": "array",
      "type": "input",
      "required": true,
      "minLength": 1,
      "maxLength": null,
      "help": "Script file name(s)"
    },
    "start": {
      "flags": [
        {
          "flag": "-s",
          "short": true
        }
      ],
      "arg": "start",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Start script at this label"
    },
    "fromJson": {
      "flags": [
        {
          "flag": "-J",
          "short": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Read kni script as compiled JSON"
    },
    "toJson": {
      "flags": [
        {
          "flag": "-j",
          "short": true
        },
        {
          "flag": "--json",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Write compiled script as JSON."
    },
    "toHtml": {
      "flags": [
        {
          "flag": "-h",
          "short": true
        },
        {
          "flag": "--html",
          "long": true
        }
      ],
      "arg": "script",
      "command": null,
      "collectorType": null,
      "type": "output",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Write interactive HTML file."
    },
    "describe": {
      "flags": [
        {
          "flag": "-d",
          "short": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Describe instead of running interactively."
    },
    "transcript": {
      "flags": [
        {
          "flag": "-t",
          "short": true
        }
      ],
      "arg": "script",
      "command": null,
      "collectorType": null,
      "type": "output",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Write a transcript."
    },
    "expected": {
      "flags": [
        {
          "flag": "-v",
          "short": true
        }
      ],
      "arg": "script",
      "command": null,
      "collectorType": null,
      "type": "input",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Verify a prior recorded transcript."
    },
    "seed": {
      "flags": [
        {
          "flag": "-S",
          "short": true
        }
      ],
      "arg": "seed",
      "command": null,
      "collectorType": null,
      "type": "number",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Seed the random number generator."
    },
    "waypoint": {
      "flags": [
        {
          "flag": "-r",
          "short": true
        }
      ],
      "arg": "waypoint",
      "command": null,
      "collectorType": null,
      "type": "input",
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Restore a saved waypoint in the story."
    },
    "debugInput": {
      "flags": [
        {
          "flag": "--di",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Log input file before processing"
    },
    "debugRuntime": {
      "flags": [
        {
          "flag": "--dr",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Enable runtime debug logging"
    },
    "debugParser": {
      "flags": [
        {
          "flag": "--dp",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Enable parser debug logging"
    },
    "debugInlineLexer": {
      "flags": [
        {
          "flag": "--dil",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Enable inline lexer debug logging"
    },
    "debugOutlineLexer": {
      "flags": [
        {
          "flag": "--dol",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Enable outline lexer debug logging"
    },
    "debugScanner": {
      "flags": [
        {
          "flag": "--ds",
          "long": true
        }
      ],
      "arg": null,
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Enable scanner debug logging"
    },
    "htmlTitle": {
      "flags": [
        {
          "flag": "--html-title",
          "long": true
        }
      ],
      "arg": "title",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Set the title for the generated page."
    },
    "htmlColor": {
      "flags": [
        {
          "flag": "--html-color",
          "long": true
        }
      ],
      "arg": "color",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Set the foreground color for the generated page."
    },
    "htmlBackgroundColor": {
      "flags": [
        {
          "flag": "--html-background-color",
          "long": true
        }
      ],
      "arg": "color",
      "command": null,
      "collectorType": null,
      "type": null,
      "required": false,
      "minLength": null,
      "maxLength": null,
      "help": "Set the background color for the generated page."
    }
  },
  "parsers": {},
  "converters": {},
  "validators": {},
  "collectors": {}
}