Skip to main content

behave-runner

A unified CLI entry point for the Behave BDD ecosystem.

CI PyPI Python Docs License

behave-runner is a single, extensible command-line interface for the Behave BDD ecosystem. It wraps common Behave workflows into focused subcommands and degrades gracefully when optional plugins are not installed.

Why behave-runner?

  • One CLI for everything — run, list, filter, lint, format, watch, report, trace, generate and analyze scenarios from one tool.
  • Plugin-friendly — optional extras add parallel execution, retries, priority ordering, trace viewers, report formatters, step libraries and more without breaking core behavior.
  • Fast feedback — watch mode, impact analysis and rich terminal output keep the test loop tight.
  • Project scaffolding — initialize a new Behave project, generate steps or features, and validate project health with doctor.

Features

  • Run, list, select, lint, format, watch, report, trace, steps, impact, generate, init, config, open and record commands.
  • Optional parallel execution, sharding, retries and priority ordering.
  • Configuration profiles via pyproject.toml or behave.ini.
  • Watch mode that re-runs tests when files change.
  • Reports in console, HTML, Markdown, JSON, XLSX and PDF formats.
  • Trace viewer and web dashboard support.
  • Step library management and feature/step generation.
  • Impact analysis to detect scenarios affected by code changes.
  • Graceful degradation when optional extras are missing.

Installation

pip install behave-runner

To install all optional extensions:

pip install "behave-runner[all]"

For development:

pip install -e ".[dev]"
pre-commit install

Quick Start

behave-runner init
behave-runner run
behave-runner list
behave-runner watch

Commands

Command Description
run Execute Behave tests.
watch Re-run tests when files change.
list List scenarios without executing them.
select Filter scenarios by tags, regex or name.
lint Lint .feature files.
format Format .feature files.
doctor Check project health.
init Initialize a new Behave project.
generate Generate steps or features.
record Record a browser session and generate steps.
report Generate and open reports.
trace View traces or serve a trace dashboard.
steps Manage step libraries.
impact Detect scenarios affected by code changes.
open Open the latest report or trace in the default browser.
config Manage configuration profiles.

Documentation

Full documentation is available at:

https://mathiaspaulenko.github.io/behave-runner/

Contributing

Contributions are welcome. Please read CONTRIBUTING.md for guidelines.

Links

License

MIT

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

behave_runner-1.0.1.tar.gz (49.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

behave_runner-1.0.1-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

Details for the file behave_runner-1.0.1.tar.gz.

File metadata

  • Download URL: behave_runner-1.0.1.tar.gz
  • Upload date:
  • Size: 49.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for behave_runner-1.0.1.tar.gz
Algorithm Hash digest
SHA256 13f46d9947d06a5a9e70a92ecd3b565dd21e07af8efcf69f4d35fc17b6bfbeb9
MD5 e6cff6d6f3a3c6d4a18d6e3df0d7187c
BLAKE2b-256 cd6f6311546d8e7d6cfb11fa288c5c7956d4107e99e650a148dc29b43551f18c

See more details on using hashes here.

Provenance

The following attestation bundles were made for behave_runner-1.0.1.tar.gz:

Publisher: release.yml on MathiasPaulenko/behave-runner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file behave_runner-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: behave_runner-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for behave_runner-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2b816fa13e1a154b51e5e5c13830e83127c1b6b7217a059a6800739a828d1006
MD5 ac96849e3d63d9b8538e94bf8eb5d455
BLAKE2b-256 5843a3f8eb1e9e0d22b615cd07acb3ebb433fc60e16983c25270da4e90bd0d22

See more details on using hashes here.

Provenance

The following attestation bundles were made for behave_runner-1.0.1-py3-none-any.whl:

Publisher: release.yml on MathiasPaulenko/behave-runner

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page