Plugin specification

Overview

Plugins add command results to Launcher, desktop, and command-palette surfaces without owning user data. Hosts pass scoped input to the WASM module, render returned result items, and execute actions only after a user confirms a result.

Manifest

yap.plugin.toml is the canonical plugin manifest. This example includes all required identity fields, hosted artifact URLs, trigger behavior, commands, and capability declarations.

schema_version = "2026-05"

[plugin]
id = "dev.example.github-jump"
slug = "github-jump"
name = "GitHub Jump"
version = "0.3.3"
author = "Dev Tools Co"
description = "Search repositories, pull requests, and issues from Launcher."
homepage = "https://example.com/plugins/github-jump"

[runtime]
module = "./dist/github_jump.wasm"
abi = "yapture-plugin-v1"
targets = ["launcher", "desktop", "app_v2"]
manifest_url = "https://cdn.example.dev/github-jump/yap.plugin.toml"
signature_url = "https://cdn.example.dev/github-jump/yap.plugin.toml.sig"

[[triggers]]
kind = "prefix"
value = "gh"
keywords = ["github", "repo", "pull request", "issue"]
partial_match = true
accept = ["enter", "tab"]
placeholder = "Search GitHub..."

[[commands]]
name = "query"
input = "text"
output = "results"

[[commands]]
name = "execute"
input = "result"
output = "action"

[capabilities]
network.fetch = ["https://api.github.com"]
secrets.read.github = true
clipboard.write = true
yaps.read = false
yaps.write = false
filesystem.read = []
filesystem.write = []

Trigger model

Prefixes are the fast path. Keywords and partial matches make a plugin discoverable, but they do not take over input by themselves. Launcher accepts a plugin hint only when the user presses Enter or Tab.

Runtime

The runtime module is a WebAssembly artifact loaded by the host. The manifest URL tells clients where to check for updates, and the signature URL lets clients verify both the manifest and the downloaded WASM before execution.

• The WASM module exports the declared command functions.
• Inputs and outputs are JSON-serializable values defined by the host ABI.
• Hosts may cache the module after signature verification.
• Network, filesystem, clipboard, secrets, and Yapture data are unavailable unless granted by capability.

Result item schema

Query commands return result items. Hosts own ranking, keyboard navigation, and rendering details; plugins provide compact structured data and an action to run after user confirmation.

{
  "id": "repo:yapture/desktop",
  "title": "yapture/desktop",
  "subtitle": "Open pull requests, issues, and releases",
  "icon": {
    "type": "url",
    "value": "https://github.com/yapture.png"
  },
  "badge": {
    "label": "repo",
    "tone": "blue"
  },
  "action": {
    "type": "open_url",
    "url": "https://github.com/yapture/desktop"
  }
}

Lifecycle

{
  "id": "lpi_01HV7QK3KX7Z9Q9Y6RZ2Z9W3R5",
  "type": "plugin",
  "key": "plugin:github-jump",
  "slug": "github-jump",
  "name": "GitHub Jump",
  "version": "0.3.3",
  "author": "Dev Tools Co",
  "enabled": true,
  "installedAt": "2026-05-24T18:05:00.000Z",
  "clients": ["app_v2", "desktop", "launcher"],
  "source": "launcher_plugin_install"
}

Security and capabilities

Plugins run with a capability allowlist. The default grant set is empty: no ambient filesystem access, no ambient network access, no clipboard writes, no secrets, and no Yapture data access unless the manifest requests the capability and the user approves it.

Public market submissions are expected to provide signed artifacts. Capability additions in an update require renewed user consent before the update can run.

Cross-client availability

Installed state is shared, but each client decides which runtime surfaces it can support. The canonical inventory endpoint exposes the clients array so app_v2, desktop, Launcher, browser_v2, and cli_v2 can present consistent availability.