Skip to main content

Manifest fields

This page is made from manifest.schema.json in the plugin SDK. Point your editor at it to get the same checks while you type:

{ "$schema": "./node_modules/@termix-ssh/plugin-sdk/schema/manifest.schema.json" }

Top level​

FieldRequiredTypeWhat it is
idyesstringUnique plugin id. Lowercase, starts with a letter, 2-40 characters. Must equal the plugin's directory name.
nameyesstring
versionyesstringSemver version string.
descriptionyesstring
authoryesobject
licenseyesstring
repositorystring
categoryyesstring
iconstringA Lucide icon name, like "Play".
videostringA YouTube link shown at the top of the plugin's page.
featuresarrayShort lines listing what the plugin does, shown on its page.
docsstringWhere the plugin's docs live. Shown as a Documentation link in Termix.
envarrayEnvironment variables the plugin reads, listed in its docs.
engineyesobject
capabilitiesyesarrayCatalog capability ids this plugin's code needs. See the SDK capability catalog.
dependenciesobjectPlugin ids this plugin cannot run without, mapped to a semver range.
optionalDependenciesobjectPlugin ids this plugin uses when present. It must keep working without them.
providesarray
requiresarray
providesSecretarray
requiresSecretarray
contributesobject
backendstringBuilt backend entry, relative to the plugin root. Defaults to dist/backend.js.
sandboxobjectHow the backend process runs (API 2). Requests to the plugin's routes and sockets always start it.
frontendstringBuilt frontend entry, relative to the plugin root. Defaults to dist/frontend.js.
localesstringLocales directory, relative to the plugin root. Defaults to locales.
platformsarray
desktopstringHow a desktop linked to a server treats this plugin: mirror follows the server, local is decided on each desktop, server never runs on a linked desktop. Defaults to mirror.
runtimestringdesktop: the plugin only loads on a desktop app's own embedded backend, never on a server. It implies desktop local and may declare desktop:local.
nativeDependenciesarrayBare npm package names this plugin depends on that carry a native (.node) binding. The build never bundles them: they stay a real dependency in the plugin's own package.json and are resolved from node_modules at runtime, the same as a host-provided package, so the compiled native binary is never copied into the JS bundle.

contributes​

FieldWhat it adds
tabs
guest
protocolsConnection protocols whose per-host login core stores, encrypts, shares and syncs for the plugin.
keybindingActionsKeybinding actions the plugin adds, with the parameters a saved binding carries.
syncEntitiesWire names of the sync entities this plugin registers.
guestViews
auth
panels
hostSections
operationsWhat this plugin can do. Every surface finds these on its own. See the operations section of PLUGIN-GUIDE.md.
dashboardCards
actions
actionSlots
permissionsRole permissions this plugin contributes. Core registers each as ..
settingsSettings fields core renders on the plugin's settings page and in the host editor.
hostCapabilityA host-editor checkbox backed by a boolean column on the host record. Reshaped by a later step.
httpHTTP options for the plugin's /plugin-api// router.
uiPresetsThe plugin's Appearance defaults for each interface preset, read with usePluginUiPreferences.
usesOther plugins' action, slot and extension point ids this plugin calls, fills or extends.
layoutsWhole-app layouts the frontend registers with app.registerLayout. Needs the ui:layout capability.
themesThemes: one CSS file each with token rules scoped under .. Needs the ui:theme capability.
mobileHow the plugin shows in the Termix mobile app. Needs plugin API 1.13 (Termix 26.10.6).

Categories​

  • Terminal
  • Files & Transfer
  • Infrastructure
  • Monitoring
  • Networking
  • Access & Security
  • Productivity