Plugin Installation

Preinstalled Plugins

Some plugins are built into and packaged with Arelle. These plugins are located in the source code under /arelle/plugins. No additional installation steps are necessary for these plugins. Activate pre-installed plugins via the GUI using Select or via CLI by name.

Installing Plugins via Package Manager

If you installed Arelle from source, published plugins can be installed by your Python package manager of choice.

Example:

pip install ixbrl-viewer

Activate plugins installed with this method via the GUI using Select or via CLI by name.

Installing Plugins Manually

If the plugin you are using is not available via package manager, or you would like to run a plugin you are developing locally, plugins can also be installed anywhere Arelle can access on your local file system. You can then activate manually installed plugins via the GUI using Browse or via CLI by path.

Alternatively, if you are running Arelle from source, you can place your plugin in the preinstalled plugins directory (arelle/plugins) to allow your plugin to be treated as a preinstalled plugin and activated by name.

---

Next, see Using Plugins with GUI or Using Plugins with CLI to learn how to use the plugins.