Add a plugin

What a plugin adds

A plugin can contribute a panel, command, settings screen or host behavior. It extends Lyre itself. You do not need one to start testing an ordinary project.

Use the host CLI supplied with your compatible Lyre build. In these examples, /path/to/host-cli is a placeholder: replace it with that executable?s actual path. It is not a command to install globally.

Review the code before installing

Install a local plugin

These commands are for the host owner on the host computer. Replace the path with your reviewed plugin directory.

/path/to/host-cli plugin install /absolute/path/to/my-plugin
/path/to/host-cli plugin ls
/path/to/host-cli plugin logs my-plugin

The host must have pluginsEnabled: true in its selected configuration. If you choose to enable that setting, review every configured plugin first: it enables the plugin system, not just one new plugin. Apply the root setting with /path/to/host-cli reload.

Update and remove deliberately

/path/to/host-cli plugin reload my-plugin
/path/to/host-cli plugin disable my-plugin
/path/to/host-cli plugin remove my-plugin

For a reviewed Git source, use /path/to/host-cli plugin add owner/repository --ref VERSION_OR_COMMIT. Pin a reviewed tag or commit; updates can change the code you trust. Removing a managed Git source removes its managed checkout. Back up your own work first.

Create your first plugin →