Automatic Testing Reports

Projects

📖 Getting Started

Access Token
Use this token in your allurerc config or set as ALLURE_SERVICE_ACCESS_TOKEN env var.
  1. Install the Allure 3 CLI and your framework's reporter:
    npm install -D allure allure-playwright
    Replace allure-playwright with your framework's reporter (e.g., allure-jest, allure-mocha, allure-vitest).
  2. Create an allurerc.mjs config file in your test directory:
    import { defineConfig } from "allure";
    
    export default defineConfig({
      name: "My Project",
      output: "./allure-report",
      allureService: {
        accessToken: process.env.ALLURE_SERVICE_ACCESS_TOKEN
          || "TOKEN_PLACEHOLDER",
      },
      plugins: {
        awesome: {
          options: {
            publish: true,
          },
        },
      },
    });
    Important: publish: true on the plugin is required — without it, reports generate locally but are not uploaded.
  3. Configure your test framework's reporter (e.g., in playwright.config.js):
    reporter: [['list'], ['allure-playwright']]
  4. Run your tests and generate + publish the report:
    npx allure run --config=./allurerc.mjs -- npx playwright test
AI Setup Prompt

Copy and paste this prompt into your AI assistant (Copilot, Claude, etc.) to configure your project automatically:

I want to publish my test results to an Allure 3 reporting service.

Here is what I need configured:

1. Install these npm dev dependencies: `allure` (the Allure 3 CLI, no Java needed) and the reporter for my test framework (e.g., `allure-playwright` for Playwright, `allure-jest` for Jest, `allure-vitest` for Vitest, `allure-mocha` for Mocha).

2. Create an `allurerc.mjs` file in my test directory with this structure:
```javascript
import { defineConfig } from "allure";
export default defineConfig({
  name: "PROJECT_NAME",
  output: "./allure-report",
  allureService: {
    accessToken: process.env.ALLURE_SERVICE_ACCESS_TOKEN || "PASTE_TOKEN_HERE",
  },
  plugins: {
    awesome: {
      options: {
        publish: true,
      },
    },
  },
});
```
IMPORTANT: The `publish: true` option on the plugin is REQUIRED for reports to be uploaded. Without it, reports only generate locally.

3. In my test framework config, add the allure reporter (e.g., `['allure-playwright']` in Playwright's reporter array). Do NOT put `allureService` in the test framework config — it belongs only in `allurerc.mjs`.

4. Update my test scripts so the run command is:
   `npx allure run --config=./allurerc.mjs -- [test command]`
   Or as two steps: run tests, then `npx allure generate ./allure-results --config=./allurerc.mjs`

5. Add `allure-results` and `allure-report` directories to `.gitignore`.

The access token for my service is: PASTE_TOKEN_HERE

Reports