UNPKG

1.34 kBMarkdownView Raw
1# Allure Commandline
2
3![downloads](https://img.shields.io/npm/dm/allure-commandline.svg?style=flat-square) [![npm version](https://img.shields.io/npm/v/allure-commandline.svg?style=flat-square)](https://www.npmjs.com/package/allure-commandline)
4
5> NPM wrapper for allure-commandline
6
7[Allure Commandline](https://docs.qameta.io/allure/2.0/#_commandline) is a tool to generate Allure report from test results. Now you can get it installed directly from NPM.
8
9## Install
10
111. Allure requires [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html) or higher
122. `npm install -g allure-commandline --save-dev`
13
14## Usage
15
16```
17allure <command> [<args>]
18```
19Run `allure help` for list of supported commands
20
21## Node.js API
22
23You can also call Allure commands from your Node.js code:
24
25```js
26var allure = require('allure-commandline');
27
28// returns ChildProcess instance
29var generation = allure(['generate', 'allure-results']);
30
31generation.on('exit', function(exitCode) {
32 console.log('Generation is finished with code:', exitCode);
33});
34```
35
36# Development
37
38Allure package should be downloaded from external storage. Repository content doesn't have actual code.
39
401. Update package version `$ npm version 2.13.0`
411. Download Allure-commandline package: `./fetch-source`
421. Pubslish result to NPM: `npm publish`
43