Installation

Requirements

The fastest way to get started is to install the base package:

pip install behave-runner

This installs the CLI, the core orchestrator, and the integration with behave, behave-kit, and behave-model.

behave-runner follows a modular design. Optional features are shipped as extras so you only install what you need.

Extra	Enables
`parallel`	Parallel execution via behave-pool
`priority`	Priority ordering via behave-priority
`retry`	Retry failed scenarios via behave-retry
`trace`	Trace viewer and UI mode via behave-trace
`lint`	Feature file linting via behave-lint
`format`	Feature file formatting via behave-format
`doctor`	Project health checks via behave-doctor
`gen`	Project scaffolding via behave-gen
`steplib`	Step library management via behave-steplib
`comments`	Comment extraction via behave-comments
`report-html`	HTML reports via behave-modern-html-report
`report-md`	Markdown reports via behave-modern-md-report
`report-json`	JSON reports via behave-modern-json-report
`report-console`	Console reports via behave-modern-console-report
`report-sheets`	Spreadsheet reports via behave-modern-sheets-report
`report-file`	File reports via behave-modern-file-report
`record`	Browser recording via wavexis

Install one or more extras with brackets:

pip install "behave-runner[parallel,retry,report-html]"

Install everything

Use the all extra to install the full ecosystem in one command.

pip install "behave-runner[all]"

Clone the repository and install the package in editable mode with the dependencies needed for development:

git clone https://github.com/MathiasPaulenko/behave-runner.git
cd behave-runner
pip install -e ".[dev]"
pre-commit install

This also installs ruff, mypy, pytest, and the pre-commit hooks so you can run the same checks the CI runs.

Documentation dependencies

Install the docs extra to build the documentation site locally.

pip install -e ".[docs]"

Check the installed version and list the available commands:

behave-runner --version
behave-runner --help

A working installation prints the version and a table with all top-level commands.