> For the complete documentation index, see [llms.txt](https://docs.pylenium.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pylenium.io/cli/allure-cli.md).

# Allure CLI

These are "convenience" commands if you are new to allure, but you can use these Pylenium commands or use the <mark style="color:yellow;">**`allure`**</mark>  CLI directly *(recommended)*

## allure install

Install the <mark style="color:yellow;">**`allure`**</mark> CLI on the current machine.

{% code title="Terminal" %}

```bash
pylenium allure install
```

{% endcode %}

Pylenium detects your operating system and *tries* to install allure with the appropriate installation commands. However, it's recommended that you use their official installation docs instead.

{% hint style="warning" %}
<https://docs.qameta.io/allure-report/#_installing_a_commandline>
{% endhint %}

## allure check

Check that there is valid allure CLI installed on the current machine.

{% code title="Terminal" %}

```bash
pylenium allure check
```

{% endcode %}

* If successful, a message is displayed with the current version of allure
* Otherwise, allure is not installed or not added to the PATH correctly

{% hint style="info" %}
This is equivalent to the following allure command ⬇️
{% endhint %}

{% code title="Terminal" %}

```bash
allure --version
```

{% endcode %}

## allure serve

Starts the allure server, generates the report, and serves it as a new browser tab.

{% code title="Terminal" %}

```bash
pylenium allure serve --folder [FOLDER]
```

{% endcode %}

{% hint style="info" %}
This is equivalent to the following allure command ⬇️
{% endhint %}

{% code title="Terminal" %}

```bash
allure serve [FOLDER]
```

{% endcode %}

### Example

Run your tests with pytest and specify that the output be saved to the **`allure-report`** folder

{% code title="Terminal" %}

```bash
pytest --alluredir=allure-report
```

{% endcode %}

With the test run finished we can serve the report and see the results

{% code title="Terminal" %}

```bash
pylenium allure serve --folder allure-report
```

{% endcode %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.pylenium.io/cli/allure-cli.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.