> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# ryanisnan/allure

Orb providing support for [Allure Framework](https://github.com/allure-framework/allure2)

## Commands

### install

Installs Allure Framework and registers it as /usr/local/bin/allure

| Parameter | Type | Default | Description |
|---|---|---|---|
| `version` | string | 2.13.1 | Allure version to use |

### report

Generates report using Allure Framework

| Parameter | Type | Default | Description |
|---|---|---|---|
| `configuration-path` | string | /usr/local/share/allure/config/allure.yml | Path to Allure configuration, uses default one if omitted |
| `target-path` | string | allure-report | Path for report directory |
| `results-path` | string | allure-results | Path to directory with test results |
| `artifact-path` | string | Report/Allure | Path that will be used when storing result as artifact |