Skip to main content
⚠️ AppKit is in an early development phase and is subject to change without notice. DO NOT use in production environments.

# Interface: PluginManifest

Plugin manifest that declares metadata and resource requirements. Attached to plugin classes as a static property.

## Properties​

### author?​

    optional author: string;

Optional metadata for community plugins

### config?​

    optional config: {
      schema: JSONSchema7;
    };

Configuration schema for the plugin. Defines the shape and validation rules for plugin config.

#### schema​

    schema: JSONSchema7;

### description​

    description: string;

Brief description of what the plugin does

### displayName​

    displayName: string;

Human-readable display name for UI/CLI

### keywords?​

    optional keywords: string[];

### license?​

    optional license: string;

### name​

    name: string;

Plugin identifier (matches plugin.name)

### repository?​

    optional repository: string;

### resources​

    resources: {
      optional: Omit<ResourceRequirement, "required">[];
      required: Omit<ResourceRequirement, "required">[];
    };

Resource requirements declaration

#### optional​

    optional: Omit<ResourceRequirement, "required">[];

Resources that enhance functionality but are not mandatory

#### required​

    required: Omit<ResourceRequirement, "required">[];

Resources that must be available for the plugin to function

### version?​

    optional version: string;