Using Plugins with CLI

Enabling Plugins for the CLI

Plugin enablement does not persist between CLI runs, so every CLI execution needs any used plugins to be specified each time.

---

By Name

The plugin’s name can be passed to the --plugins CLI option. Multiple names can be passed by separating with a vertical bar | character.

Example:

python arelleCmdLine.py --plugins=myplugin ...

python arelleCmdLine.py --plugins="myplugin|myplugin2" ...

---

By Path

A relative or absolute path to the plugin can be passed to the --plugins CLI option.

Examples:

python arelleCmdLine.py --plugins=../myplugin ...

python arelleCmdLine.py --plugins=/Users/me/myplugin ...