BinHelp

Defined in: packages/core/src/kernel/types.ts:1442

Structured help content for a bin — source of truth for --help and man.

Remarks

Kernel’s --help interception at spawn time reads /lib/help/<bin> if present; man pages are materialized at /sys/man/1/<bin>.md by renderHelp. Registering a bin with an Extension that has both bins and man wires both surfaces automatically.

See

• Extension
• FlagDoc

Properties

description?

readonly optional description?: string

Defined in: packages/core/src/kernel/types.ts:1446

---

examples?

readonly optional examples?: readonly string[]

Defined in: packages/core/src/kernel/types.ts:1447

---

flags?

readonly optional flags?: readonly FlagDoc[]

Defined in: packages/core/src/kernel/types.ts:1445

---

seeAlso?

readonly optional seeAlso?: readonly string[]

Defined in: packages/core/src/kernel/types.ts:1448

---

summary

readonly summary: string

Defined in: packages/core/src/kernel/types.ts:1443

---

usage?

readonly optional usage?: string

Defined in: packages/core/src/kernel/types.ts:1444