Allure Kit (allure kit)

allure kit is a set of CLI commands for bootstrapping and maintaining an Allure 3 setup in JavaScript/TypeScript projects.

It helps you:

• detect test frameworks and install matching Allure adapters,
• create and maintain allurerc config files,
• manage report plugins,
• diagnose setup issues,
• publish reports to GitHub Pages.

Detected frameworks include Vitest, Playwright, Jest, Mocha, Cypress, Cucumber.js, Jasmine, CodeceptJS, Newman, and WebdriverIO (WDIO).

Run

Use without global install:

npx allure kit --help

Run a specific command:

npx allure kit init

kit init is also exposed as a top-level allure init alias:

npx allure init

Quick Start

# 1) Initialize Allure in your project
npx allure init

# 2) Run tests so they produce allure-results
npm test

# 3) Build report
npx allure generate

If an allurerc file already exists, init exits early and points you at allure kit doctor / allure kit update — it never overwrites an existing config.

For a fully non-interactive setup:

npx allure init --yes

For a one-shot install of a specific framework:

npx allure init --lang=js --framework=playwright

Commands

init (alias: allure init)

allure init [--lang js|ts] [--framework <id>] [--format json|yaml|mjs] [--yes] [--cwd <path>]
# equivalent to:
allure kit init ...

init does not generate any demo tests — it only configures Allure (installs adapters and writes allurerc). Sample tests live in a separate repository.

Flags:

• --lang — project language. Currently only js/ts are accepted (a stub for future language support; any other value fails with a usage error).
• --framework — force-pick a single framework by id or package name (playwright, vitest, wdio, ...). Implies non-interactive mode with the default awesome plugin.
• --format — json (default), yaml, or mjs config format.
• --yes — accept defaults without prompts.
• --cwd — working directory.

update

allure kit update [--yes] [--cwd <path>]

doctor

allure kit doctor [--cwd <path>]

gh-pages init

Creates a GitHub Actions workflow that generates an Allure report and publishes it to GitHub Pages via the gh-pages branch.

allure kit gh-pages init [--yes] [--branch <name>] [--config <path>] [--test-command <cmd>] [--cwd <path>]

plugin list

allure kit plugin list [--cwd <path>]

plugin add

allure kit plugin add <name> [--skip-options] [--cwd <path>]

plugin remove

allure kit plugin remove <name> [--uninstall] [--cwd <path>]