#Interface: RunGeneratedCliOptions

#Properties

#argv

readonly argv: readonly string[]

---

#commands

readonly commands: readonly CompiledCliCommand[]

---

#description?

readonly optional description?: string

---

#execute

readonly execute: (command, input, context) => Promise<unknown>

Runs one resolved plain command with parsed input; returns the validated result.

#Parameters

#command

CompiledCliCommand

#input

Readonly<Record<string, unknown>>

#context

GeneratedCliExecuteContext

#Returns

Promise<unknown>

---

#isTty?

readonly optional isTty?: () => boolean

True when stdout is an interactive terminal; rendered commands then update progress in place.

#Returns

boolean

---

#name

readonly name: string

---

#render?

readonly optional render?: (command, input, context) => GeneratedCliRenderSession

Opens one rendered run for a resolved .tsx command with parsed input.

#Parameters

#command

CompiledCliCommand

#input

Readonly<Record<string, unknown>>

#context

GeneratedCliRenderContext

#Returns

GeneratedCliRenderSession

---

#signal?

readonly optional signal?: AbortSignal

---

#version

readonly version: string

---

#writeErr?

readonly optional writeErr?: (text) => void

#Parameters

#text

string

#Returns

void

---

#writeOut?

readonly optional writeOut?: (text) => void

#Parameters

#text

string

#Returns

void