Skip to content

kernel:cli

FieldValue
Prefixkernel:cli
Namespace constantCliNamespace
Subjects constantCliRpcSubjects
Kindbus
Schema recordCliSchemas
Tierframework
Package@makaio/kernel
Defined inpackages/kernel/src/bus/cli/namespace.ts
KeyWireTypeSchema
executekernel:cli.executerpcschemas.ts
listContributionskernel:cli.listContributionsrpcschemas.ts

Execute a CLI subcommand on the server.

The server validates args through the subcommand’s Zod schema, runs the handler with a buffering output writer, and returns captured output.

Subject: kernel:cli.execute Type: Request (RPC)

Request:

FieldTypeRequired
argsRecord<string, unknown> | undefinedno
commandstringyes
subcommandstringyes

Response:

FieldTypeRequired
exitCodenumberyes
stderrstring[]yes
stdoutstring[]yes

List all CLI contributions from loaded extensions.

Returns CLI manifest objects (serializable metadata only, no handler code). The CLI uses this to register remote commands and generate --help output.

Subject: kernel:cli.listContributions Type: Request (RPC)

Request:

Empty object.

Response:

FieldTypeRequired
contributions{ name: string; description: string; subcommands?: readonly { name: string; description: string; args?: readonly { name: string; description: string; required?: boolean | undefined; positional?: boolean | undefined; short?: string | undefined; type?: "string" | "number" | "boolean" | undefined; }[] | undefined; }[] | undefined; hasInteractive?: boolean | undefined; }[]yes

Auto-generated by yarn docs:bus. Do not edit manually.