Skip to content

craft-hub / CommandPackage

Interface: CommandPackage ​

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

Package boundary that declared one project command.

Properties ​

description? ​

optional description?: string

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

Human-readable package summary declared in package.json, when present.


optional featured?: boolean

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

Whether the package should receive stronger visual emphasis in overviews.


hidden? ​

optional hidden?: boolean

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

Whether the package is omitted from overview grids while remaining discoverable.


optional links?: CommandPackageLink[]

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

Plugin-contributed HTTPS destinations resolved from bounded package metadata.


name? ​

optional name?: string

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

Package name declared in package.json, when present.


order? ​

optional order?: number

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

Stable repository-owned ordering override for overview cards.


quickActions? ​

optional quickActions?: string[]

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

Source-qualified discovered capability selectors shown as overview actions.


readme? ​

optional readme?: string

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

Configured project-relative README path, when the conventional file should not be used.


relativePath ​

relativePath: string

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

Project-relative package directory. The project root is represented by '.'.


root ​

root: boolean

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


toolGroups? ​

optional toolGroups?: CommandToolGroup[]

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

Plugin-defined tool surfaces resolved for this package.

Released under the MIT License.