Skip to content

@pumpkin-plugins/docs API / commands / FlatCommand

Interface: FlatCommand ​

Defined in: tools/docs/src/commands.ts:143

A runnable command, flattened out of a tree.

Properties ​

arguments ​

arguments: readonly CommandArgumentSpec[]

Defined in: tools/docs/src/commands.ts:154

Required argument nodes that follow this command.


defaultPermission ​

defaultPermission: CommandPermissionDefault

Defined in: tools/docs/src/commands.ts:152

Who may run the command by default.


path ​

path: string[]

Defined in: tools/docs/src/commands.ts:145

The words typed after /.


permission ​

permission: string

Defined in: tools/docs/src/commands.ts:150

The permission of the command it belongs to.


usage ​

usage: string

Defined in: tools/docs/src/commands.ts:147

For example /baddon list.

Pumpkin Plugins documentation