craft-hub / CommandInputDefinition

Interface: CommandInputDefinition

Defined in: packages/craft-hub/src/types.ts:438

Project-owned form input that is resolved into structured command arguments.

Properties

argumentStyle?

optional argumentStyle?: "equals" | "separate" | "positional"

Defined in: packages/craft-hub/src/types.ts:453

Format this value as --flag=value, --flag value, or a positional argv entry.

---

default?

optional default?: string

Defined in: packages/craft-hub/src/types.ts:444

---

description?

optional description?: string

Defined in: packages/craft-hub/src/types.ts:442

---

flag?

optional flag?: string

Defined in: packages/craft-hub/src/types.ts:449

---

id

id: string

Defined in: packages/craft-hub/src/types.ts:439

---

label?

optional label?: string

Defined in: packages/craft-hub/src/types.ts:441

---

omitArgument?

optional omitArgument?: boolean

Defined in: packages/craft-hub/src/types.ts:451

Keep this input in the reviewed execution plan without adding a CLI argument.

---

options?

optional options?: CommandInputOption[]

Defined in: packages/craft-hub/src/types.ts:443

---

pattern?

optional pattern?: string

Defined in: packages/craft-hub/src/types.ts:448

---

private?

optional private?: boolean

Defined in: packages/craft-hub/src/types.ts:455

Treat the current value as a private identifier and omit it from persisted run history.

---

redactInHistory?

optional redactInHistory?: boolean

Defined in: packages/craft-hub/src/types.ts:457

Redact the resolved argument in persisted run history.

---

required?

optional required?: boolean

Defined in: packages/craft-hub/src/types.ts:445

---

requiredWhen?

optional requiredWhen?: CommandInputConditions

Defined in: packages/craft-hub/src/types.ts:446

---

type

type: "boolean" | "text" | "select"

Defined in: packages/craft-hub/src/types.ts:440

---

visibleWhen?

optional visibleWhen?: CommandInputConditions

Defined in: packages/craft-hub/src/types.ts:447