Skip to content
No description, website, or topics provided.
Branch: develop
Clone or download
codenirvana Merge pull request #89 from postmanlabs/greenkeeper/eslint-plugin-jsd…

Update eslint-plugin-jsdoc to the latest version 🚀
Latest commit e30e370 Mar 19, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
examples Add Sample Collection Jul 6, 2018
npm Test: install packages individually Oct 19, 2018
test Test: remove reporter symlink Oct 19, 2018
.eslintrc Update eslint rules Jun 25, 2018
.jsdoc-config.json Initial Setup Jun 25, 2018
.npmignore Test: remove reporter symlink Oct 19, 2018
.travis.yml Travis: add windows os Oct 23, 2018
CHANGELOG.yaml Released v1.0.2 Sep 3, 2018 Initial Setup Jun 25, 2018 docs(readme): remove Greenkeeper badge Sep 3, 2018


HTML reporter for Newman that provides the information about the collection run in HTML format. This needs to be used in conjunction with Newman so that it can recognize HTML reporting options.


The installation should be global if newman is installed globally, local otherwise. (Replace -g from the command below with -S for a local installation)

$ npm install -g newman-reporter-html


In order to enable this reporter, specify html in Newman's -r or --reporters option.

$ newman run -r html


With Newman CLI

CLI Option Description
--reporter-html-export <path> Specify a path where the output HTML file will be written to disk. If not specified, the file will be written to newman/ in the current working directory.
--reporter-html-template <path> Specify a path to the custom template which will be used to render the HTML report. This option depends on --reporter html and --reporter-html-export being present in the run command. If this option is not specified, the default template is used

Custom templates (currently handlebars only) can be passed to the HTML reporter via --reporter-html-template <path> with --reporters html and --reporter-html-export. The default template is used in all other cases.

With Newman as a Library

The CLI functionality is available for programmatic use as well.

const newman = require('newman');{
    collection: require('./examples/sample-collection.json'), // can also provide a URL or path to a local JSON file.
    reporters: 'html',
    reporter: {
        html: {
            export: './htmlResults.html', // If not specified, the file will be written to `newman/` in the current working directory.
            template: './customTemplate.hbs' // optional, this will be picked up relative to the directory that Newman runs in.
}, function (err) {
	if (err) { throw err; }
    console.log('collection run complete!');


newman-reporter-html newman node
v0.1.0 >= v3.10.0 >= v6.x
v1.0.0 >= v4.0.0 >= v6.x


Reporter not found

The reporter and newman must be installed at the same level, the installation should be global if newman is installed globally, local otherwise.

Getting different HTML output

You are most probably getting in-built reporter output used in older versions of newman, Please check the newman's compatibility section above.

If you are facing any other problem, please check the open issues or create new.

Community Support

If you are interested in talking to the Postman team and fellow Newman users, you can find us on our Postman Community Forum. Feel free to drop by and say hello. You'll find us posting about upcoming features and beta releases, answering technical support questions, and contemplating world peace.

Sign in using your Postman account to participate in the discussions and don't forget to take advantage of the search bar - the answer to your question might already be waiting for you! Don’t want to log in? Then lurk on the sidelines and absorb all the knowledge.


This software is licensed under Apache-2.0. Copyright Postdot Technologies, Inc. See the file for more information.

You can’t perform that action at this time.