craft-hub / CommandInputDefinition

Interface: CommandInputDefinition

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

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

Properties

argumentStyle?

optional argumentStyle?: "equals" | "separate"

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

---

default?

optional default?: string

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

---

description?

optional description?: string

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

---

flag

flag: string

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

---

id

id: string

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

---

label?

optional label?: string

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

---

options?

optional options?: CommandInputOption[]

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

---

pattern?

optional pattern?: string

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

---

private?

optional private?: boolean

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

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:371

Redact the resolved argument in persisted run history.

---

required?

optional required?: boolean

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

---

requiredWhen?

optional requiredWhen?: CommandInputConditions

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

---

type

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

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

---

visibleWhen?

optional visibleWhen?: CommandInputConditions

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