For AI agents: the complete documentation index is available at https://scriptedalchemy.github.io/agent-bundle/llms.txt, the full documentation bundle is available at https://scriptedalchemy.github.io/agent-bundle/llms-full.txt, and this page is available as Markdown at https://scriptedalchemy.github.io/agent-bundle/api/interfaces/test.CliInvocation.md.
  • English
  • Interface: CliInvocation

    Properties

    argv

    readonly argv: readonly string[]

    The argv vector as dispatched, including the command path segments.


    command?

    readonly optional command?: string

    The resolved command path (db migrate); absent for help, --version, and usage failures.


    exitCode

    readonly exitCode: number

    The process exit code the routed shell mapped: 0 success (or the result's exitCode under config.exitCode: 'result'), 1 execution failure, 2 usage or input-validation failure.


    provenance

    readonly provenance: CliDispatchProvenance


    routeId?

    readonly optional routeId?: string


    stderr

    readonly stderr: string

    Everything the shell wrote to its diagnostic stream.


    stdout

    readonly stdout: string

    Everything the shell wrote to stdout, including rendered Markdown, TTY, JSON, or NDJSON output.


    value?

    readonly optional value?: unknown

    The validated plain result or rendered document value; absent unless a command completed validation.