The command line interface for Intern
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
init
src
tests
.gitignore
.jshintrc
.prettierrc
.travis.yml
LICENSE
README.md
intern.json
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

intern-cli

This module gives Intern a friendly command line interface that works like a typical POSIX application.

Intern Intern

Getting started

Install it globally:

$ npm install -g @theintern/cli

You can then run Intern unit tests with:

$ intern run

When used with Intern 3, intern-cli will use Intern’s Node client by default, and it assumes the test config is located at ./tests/intern.js. The “runner” runner can be invoked with the -w/--webdriver flag.

When used with Intern 4, intern-cli will run all functional and unit tests by default (this is Intern 4‘s default behavior). WebDriver tests can be skipped with the -n/--node flag, and Node unit tests can be skipped with the -w/--webdriver flag. The cli assumes the test config is at intern.json.

Getting help

Intern-cli provides top level help when run with no arguments:

$ intern

  Usage: intern [options] [command]

  Run JavaScript tests


  Options:

	-h, --help     output usage information
	-v, --verbose  show more information about what Intern is doing
	-V, --version  output the version
	--debug        enable the Node debugger


  Commands:

    version                    Show versions of intern-cli and intern
    help [command]             Get help for a command
    init [options]             Setup a project for testing with Intern
    run [options] [args...]    Run tests in Node or in a browser using WebDriver
    serve [options] [args...]  Start a simple web server for running unit tests in a browser on your system
    watch [files]              Watch test and app files for changes and re-run Node-based unit tests when files are updated

You can get more information about a particular sub-command with the help command or the -h option:

$ intern help init

  Usage: init [options]

  Setup a project for testing with Intern


  Options:

	-h, --help               output usage information
	-b, --browser <browser>  browser to use for functional tests


  This command creates a "tests" directory with a default Intern config file
  and some sample tests.

  Browser names:

	chrome, firefox, safari, internet explorer, microsoftedge

intern-cli also tries to provide useful feedback when it notices a problem with its environment:

$ intern

  You'll need a local install of Intern before you can use this command.
  Install it with

	npm install --save-dev intern

License

intern-cli is offered under the New BSD license.

© SitePen, Inc. and its contributors