Skip to content

InspectResult ​

Structured routing and input resolution outcome returned by CLIBuilder.inspect().

Signatures ​

ts
type InspectResult = InspectedCommand | { kind: "root-version"; version: string; } | { kind: "root-help"; schema: CLISchema; mode: "short" | "all"; } | { kind: "command-help"; path: readonly string[]; schema: CommandSchema; mode: "short" | "all" | { name: string; group: string; }; } | { kind: "root-completions"; shell: Shell; } | { kind: "dynamic-completion"; argv: readonly string[]; } | { kind: "dispatch-error"; error: CLIError; } | { kind: "command-error"; path: readonly string[]; stage: "parse" | "resolve"; error: CLIError; parse?: ParseContext; };

See Also ​

Released under the MIT License.