> 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**.

### 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.

![](/files/8VRKTvsCkRXCfZluxLmu)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bc-security.gitbook.io/empire-wiki/plugins.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.