CLI Reference

`bot plugins`

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

bot plugins

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

Related:

Commands

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

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

All plugins must ship a bot.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

bot 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):

bot plugins install -l ./my-plugin

Update

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

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