AI Disclosure: This page was generated by an LLM and may contain inaccuracies. Hand-crafted documentation will be implemented over time on the road to 1.0

PluginAPI

Since Plugin API: 1.0.0

Base Plugin API - available to all providers

Signature

interface PluginAPI {
    settings: PluginSettings;
    storage: PluginStorageAPI;
    database: PluginDatabaseAPI;
    appSettings: ReadonlyAppSettings;
    invoke<T>(command: string, args?: Record<string, unknown>): Promise<T>;
    modal: ModalAPI;
    notify: NotifyAPI;
    files: FileUtilsAPI;
    explorer: ExplorerAPI;
    git: GitAPI;
    workspaceFolders: WorkspaceFoldersAPI;
    clipboard: ClipboardAPI;
    fetch(input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
    modules: ModulesAPI;
    events: EventsAPI;
}

Members

Name	Type	Required	Description
`settings`	`PluginSettings`	yes	Plugin’s own settings
`storage`	`PluginStorageAPI`	yes	Key/value data storage (separate from settings)
`database`	`PluginDatabaseAPI`	yes	SQL database for plugin-owned tables
`appSettings`	`ReadonlyAppSettings`	yes	Read-only access to app settings
`invoke`	`(command: string, args?: Record<string, unknown>) => Promise<T>`	yes	Invoke Tauri commands (permission-gated allowlist for community plugins)
`modal`	`ModalAPI`	yes	Modal dialogs
`notify`	`NotifyAPI`	yes	Notifications/toasts
`files`	`FileUtilsAPI`	yes	File path utilities
`explorer`	`ExplorerAPI`	yes	Explicit acquisition of stable Explorer pane facades.
`git`	`GitAPI`	yes	Fixed read-only repository inspection under filesystem.read.
`workspaceFolders`	`WorkspaceFoldersAPI`	yes	Permission-gated Workspace Folder data and Page operations.
`clipboard`	`ClipboardAPI`	yes	Permission-gated text clipboard.
`fetch`	`(input: RequestInfo \| URL, init?: RequestInit) => Promise<Response>`	yes	Permission-gated network fetch.
`modules`	`ModulesAPI`	yes	Center-module routing.
`events`	`EventsAPI`	yes	Event pub/sub for cross-plugin communication