CLI reference for `zirkabot plugins` (list, install, enable/disable, doctor)

Read when…
  • You want to install or manage in-process Gateway plugins
  • You want to debug plugin load failures

zirkabot plugins

Manage Gateway plugins/extensions (loaded in-process).

Related:

Commands

zirkabot plugins list
zirkabot plugins info <id>
zirkabot plugins enable <id>
zirkabot plugins disable <id>
zirkabot plugins doctor
zirkabot plugins update <id>
zirkabot plugins update --all

Bundled plugins ship with Zirkabot but start disabled. Use plugins enable to activate them.

All plugins must ship a zirkabot.plugin.json file with an inline JSON Schema (configSchema, even if empty). Missing/invalid manifests or schemas prevent the plugin from loading and fail config validation.

Install

zirkabot plugins install <path-or-spec>

Security note: treat plugin installs like running code. Prefer pinned versions.

Supported archives: .zip, .tgz, .tar.gz, .tar.

Use --link to avoid copying a local directory (adds to plugins.load.paths):

zirkabot plugins install -l ./my-plugin

Update

zirkabot plugins update <id>
zirkabot plugins update --all
zirkabot plugins update <id> --dry-run

Updates only apply to plugins installed from npm (tracked in plugins.installs).