plugin_get

Fetch one installed JavaScript plugin in detail. Unlike plugin_list, it tells you whether the plugin is running and lists its files/ folder.

Request

{
  "cmd": "plugin_get",
  "name": "hello"
}

Field	Type	Required	Description
`name`	string	Yes	Plugin name. 1 to 64 letters, digits, `_`, or `-`.

Response

{
  "cmd": "plugin_get",
  "plugin": {
    "name": "hello",
    "description": "Say hello and answer !ping",
    "version": "0.1.0",
    "enabled": true,
    "loaded": true,
    "slash": [
      {
        "name": "hello",
        "description": "Say hello",
        "options": [],
        "whitelistRoles": null,
        "blacklistRoles": null,
        "ephemeral": false
      }
    ],
    "events": ["message_new"],
    "files": [
      {
        "name": "notes.md",
        "ext": ".md",
        "path": "/srv/originchats/db/plugins/hello/files/notes.md",
        "isDir": false
      }
    ]
  }
}

Field	Description
`name`, `description`, `version`	From the manifest.
`enabled`	The manifest’s `enabled` flag. Defaults to `true`.
`loaded`	`true` if the plugin is running now. An enabled plugin that failed to load shows `enabled: true` and `loaded: false`.
`slash`	Slash command definitions as written in the manifest.
`events`	Commands the plugin’s `onEvent` runs before.
`files`	Entries in the plugin’s `files/` folder, in the same shape as `plugin_file_list`.

Permissions

Requires manage_server.

Errors

`val`	When
`Invalid plugin name`	`name` has characters other than letters, digits, `_`, and `-`.
`Plugin '<name>' is not installed`	There is no readable `plugin.json` for that name.
Validation message	`name` is missing, blank, or longer than 64 characters.

See also