verdict describe

Source command definition

Inspect a command or alias without running it or connecting to a server. Use separate path arguments or quote paths containing spaces. Report arguments, results, effects and limitations. File-content schemas appear at input.fileSchema in JSON mode.

Runs locally. Effects: none declared.

Arguments and flags

Argument	Type	Required	Default	Description
<command>	positional	yes	No parser default	Command name, full quoted path or alias
<subcommand>	positional	no	No parser default	Optional subcommand name
--json	boolean	no	false	Output as JSON

--help (-h) shows command help without executing the command. Boolean flags support --no-<flag>. Defaults stated in descriptions may be resolved by the handler or configuration rather than the argument parser.

Input

Required command path.

File input: unsupported. Standard input: unsupported.

Result

{
  "kind": "json-schema",
  "schema": {
    "type": "object",
    "additionalProperties": false,
    "required": [
      "path",
      "aliases",
      "summary",
      "kind",
      "scope",
      "effects",
      "availability",
      "description",
      "examples",
      "input",
      "arguments",
      "inputSchema",
      "result"
    ],
    "properties": {
      "path": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "aliases": {
        "type": "array",
        "items": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "summary": {
        "type": "string"
      },
      "kind": {
        "type": "string",
        "enum": [
          "finite",
          "group",
          "raw",
          "process"
        ]
      },
      "scope": {
        "type": "string",
        "enum": [
          "local",
          "server"
        ]
      },
      "effects": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "availability": {
        "type": "object",
        "required": [
          "status"
        ],
        "additionalProperties": false,
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "available",
              "unavailable"
            ]
          },
          "reason": {
            "type": "string",
            "nullable": true
          }
        }
      },
      "description": {
        "type": "string"
      },
      "examples": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "input": {
        "type": "object",
        "required": [
          "file",
          "stdin",
          "description"
        ],
        "additionalProperties": false,
        "properties": {
          "file": {
            "type": "boolean"
          },
          "stdin": {
            "type": "boolean"
          },
          "description": {
            "type": "string"
          },
          "constraints": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "nullable": true
          },
          "fileSchema": {
            "type": "object",
            "required": [],
            "additionalProperties": true,
            "nullable": true
          }
        }
      },
      "arguments": {
        "type": "object",
        "required": [],
        "additionalProperties": true
      },
      "inputSchema": {
        "type": "object",
        "required": [],
        "additionalProperties": true
      },
      "result": {
        "type": "object",
        "required": [],
        "additionalProperties": true
      },
      "stdout": {
        "type": "string",
        "nullable": true
      },
      "lifecycle": {
        "type": "string",
        "nullable": true
      },
      "children": {
        "type": "array",
        "items": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "nullable": true
      }
    }
  }
}

By default, the command renders human-readable records. --json writes one JSON result to stdout. Operational failures use status 1; JSON failures contain an error object with code and message. See shared output semantics.

Exit status

• 0: the command completed its operation.

Argument, I/O, and other failures handled by the CLI runner use status 1.

Examples

verdict describe "fact list" --json
verdict describe authorize --json