PluginSetupStep

Defined in: plugin.ts:260

A single declarative step in a plugin’s setupSequence.

Properties

check?

optional check?: "auth" | "cli" | "none"

Defined in: plugin.ts:268

What “done” means for this step. cli → the required CLI is on PATH; auth → the provider reports authenticated; none → informational / always actionable (no completion check). Defaults to none.

---

command?

optional command?: string

Defined in: plugin.ts:278

Command to run. Falls back to the manifest field for kind (install→installCommand, auth→loginCommand, setup→setupCommand, diagnose→diagnoseCommand).

---

description?

optional description?: string

Defined in: plugin.ts:272

Short helper line under the title.

---

kind

kind: "install" | "auth" | "setup" | "diagnose"

Defined in: plugin.ts:262

Maps to the terminal-action catalog kind (and its manifest command field).

---

title?

optional title?: string

Defined in: plugin.ts:270

Row label. Falls back to the kind’s default verb.

---

url?

optional url?: string

Defined in: plugin.ts:280

Optional docs link shown beside the action.