> For the complete documentation index, see [llms.txt](https://bc-security.gitbook.io/empire-wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bc-security.gitbook.io/empire-wiki/plugins.md).

# Plugins

Plugins are an extension of Empire that allow for custom scripts to be loaded. This allows anyone to build or add community projects to extend Empire functionality.

## Installing Plugins

Plugin installation is available through the Starkiller **Plugin Marketplace**, reachable from the sidebar. Selecting a plugin shows its description, the registry and version to install from, and an **Install** button.

![](https://1910080187-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MM2c5FycSJH9sASPLaA%2Fuploads%2Fgit-blob-acbc7c4021b830e7285da41a2a18278f646c45a6%2Fplugin_marketplace.png?alt=media)

### Auto-Installing Plugins

Plugins can be automatically installed during `./ps-empire setup` by adding them to the `auto_install` list in `config.yaml`. This is useful for Docker builds or automated deployments where plugins need to be pre-installed without manual API calls.

```yaml
plugin_marketplace:
  registries:
    - name: BC-SECURITY
      git_url: https://github.com/BC-SECURITY/Empire-Plugin-Registry.git
      ref: main
      file: registry.yaml
  auto_install:
    - name: Report Generation Plugin
      version: '2.0.0'
      registry: BC-SECURITY
```

Each entry requires `name`, `version`, and `registry` matching a plugin in the configured registries. Plugins that are already installed will be skipped.

### Additional Dependencies

If a plugin requires additional Python dependencies, the plugin page will show a warning that the dependencies need to be installed before the plugin can be loaded.

![](https://1910080187-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MM2c5FycSJH9sASPLaA%2Fuploads%2Fgit-blob-16b31efded93a0b851ab00b14dba047dc5f47e69%2Fplugin-dependencies.png?alt=media)