@termix-ssh/plugin-sdk is what every Termix plugin builds against, including the ones that ship with Termix. It has the types for a plugin's backend and frontend, table definitions, the manifest schema, test helpers, and the termix-plugin CLI. The easiest way to start is the Termix Plugin Template. The full guide is at docs.termix.site/develop.

Installation

npm install --save-dev @termix-ssh/plugin-sdk

CLI

npx termix-plugin build                  # bundle dist/backend.js and dist/frontend.js
npx termix-plugin test                   # run the plugin's Vitest suite
npx termix-plugin validate               # check manifest.json and the files it names
npx termix-plugin openapi                # write dist/openapi.json from @openapi comments
npx termix-plugin migrations             # write migrations from the table definitions
npx termix-plugin pack                   # write <id>-<version>.tmxplug
npx termix-plugin changelog              # print this version's notes from CHANGELOG.md
npx termix-plugin sign <file.tmxplug>    # sign it, needs TERMIX_PLUGIN_SIGNING_KEY
npx termix-plugin verify <file.tmxplug> --key <base64>   # check a signature
npx termix-plugin keygen --out <dir>     # make a new signing key pair
npx termix-plugin dev --server <url> --key <tmx_...>   # install on a server and reinstall on every change

dev needs developer mode on (Settings, General) and an API key from an admin account. It installs the plugin from a file, marked unverified, and reinstalls it each time you save. TERMIX_SERVER_URL and TERMIX_API_KEY work in place of the flags. Reload the page to pick up frontend changes.

Support

Bugs and ideas for the SDK or the termix-plugin CLI go in the Termix repo. You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.

For discussions and questions, join the Discord server.

License

Distributed under the Apache License Version 2.0. See LICENSE for more information.