Skip to content

Latest commit

 

History

History
79 lines (51 loc) · 2.09 KB

readme.md

File metadata and controls

79 lines (51 loc) · 2.09 KB

Task runner CLI

build status npm version dependencies status devDependencies status Gitter RunKit

Installation

npm install @runner/cli

Usage

Runner can be started by using npm or npx commands.

Run with npm:

npm run build

where build is an npm script in the package.json which contains a runner command.

Run with npx:

npx runner

The runner command format:

runner [options] [<task>]

Available options:

Option Description
-c, --config Configuration file is a script which contains tasks definitions. Default value - runner.js.
-s, --serial Run all given tasks sequentially (instead of in parallel).

These two commands are identical:

npx runner
npx runner --config runner.js

To run a webpack:build task from a custom configuration file:

npx runner -c tasks/develop.js webpack:build 

Without the task name starts the default task:

npx runner -c tasks/develop.js 

More information about tasks manipulation is available in the @runner/core package.

Contribution

If you have any problems or suggestions please open an issue according to the contribution rules.

License

@runner/cli is released under the GPL-3.0 License.