Skip to main content

Interface: PluginManifest

Defined in: types/manifest.ts:36

Plugin manifest declared in a package's omniscribe field in package.json.

Example​

{
  "name": "@omniscribe/plugin-claude",
  "omniscribe": {
    "id": "claude",
    "type": "both",
    "displayName": "Claude Code",
    "description": "Claude Code CLI integration",
    "icon": "./assets/claude-icon.svg"
  }
}

Properties​

apiVersion?​

optional apiVersion?: string

Defined in: types/manifest.ts:59

The plugin API version this plugin targets (e.g., '1.0.0'). Omit to accept any API version.

description​

description: string

Defined in: types/manifest.ts:50

Brief description of the plugin's purpose

displayName​

displayName: string

Defined in: types/manifest.ts:47

Human-readable name shown in the UI

icon?​

optional icon?: string

Defined in: types/manifest.ts:53

Path to icon asset relative to the package root, or an icon name

id​

id: string

Defined in: types/manifest.ts:41

Unique plugin identifier. Must be lowercase alphanumeric with hyphens only (e.g., 'claude', 'codex', 'my-provider').

type​

type: PluginType

Defined in: types/manifest.ts:44

What the plugin provides

version​

version: string

Defined in: types/manifest.ts:56

The plugin's own semantic version (e.g., '1.0.0')