SystemDependency

Defined in: core.ts:252

A declared dependency on a system binary (e.g., yt-dlp, ffmpeg, git).

Declared in the dependencies.system array of plugin.json. The host runs check.command + check.args at activation time to probe binary presence. Requires shell.execute permission and shellCommands allowlist entry for the check.command.

Properties

name

name: string

Defined in: core.ts:254

Human-readable name of the dependency (e.g., “yt-dlp”).

---

check

check: SystemDependencyCheck

Defined in: core.ts:256

Probe configuration for detecting the binary.

---

minVersion?

optional minVersion?: string

Defined in: core.ts:258

Minimum version constraint string.

---

required?

optional required?: boolean

Defined in: core.ts:260

Whether this dependency is required. Default: true.

---

installHint?

optional installHint?: string

Defined in: core.ts:262

Human-readable install hint (e.g., “brew install yt-dlp”).

---

installUrl?

optional installUrl?: string

Defined in: core.ts:264

URL to installation instructions. Must start with https:// or http://.

---

description?

optional description?: string

Defined in: core.ts:266

Human-readable description of the dependency’s purpose.