CLI Tools#

CPEX includes the cpex command-line tool for scaffolding new plugin projects from templates.

Installation#

The CLI is included when you install CPEX:

pip install cpex

The cpex command becomes available in your environment. To use the bootstrap subcommand, install the CLI extras:

pip install "cpex[cli]"

cpex bootstrap#

Scaffolds a new plugin project from a cookiecutter template.

cpex bootstrap --destination ./my_plugin --template_type native

Options#

Template Types#

native — an in-process plugin with hook stubs for tools and prompts:

cpex bootstrap -d ./my_policy_plugin -t native

Creates:

my_policy_plugin/
├── __init__.py
└── plugin.py          # Plugin subclass with tool + prompt hook stubs

external — a standalone MCP server plugin with test scaffolding:

cpex bootstrap -d ./my_remote_plugin -t external

Creates:

my_remote_plugin/
├── my_remote_plugin/
│   ├── __init__.py
│   └── plugin.py      # Plugin subclass
└── tests/
    ├── __init__.py
    └── test_my_remote_plugin.py

isolated — a venv-isolated plugin:

cpex bootstrap -d ./my_sandboxed_plugin -t isolated

Creates:

my_sandboxed_plugin/
├── __init__.py
└── plugin.py          # Plugin subclass for venv isolation

Dry Run#

Preview what would be created without writing anything:

cpex bootstrap -d ./my_plugin -t native --dry_run

Custom Templates#

Point to your own cookiecutter template repository:

cpex bootstrap -d ./my_plugin -u https://github.com/my-org/plugin-template.git -r v2.0

Environment Variables#