@dojo/cli

@dojo/cli

The CLI is the officially supported way to create and maintain Dojo 2 apps.

WARNING This is alpha software. It is not yet production ready, so you should use at your own risk.

It is designed to save you time, by promoting a standardised workflow, and automating away more mundane boilerplate tasks.

Prerequisites

You will need node v6+.

Installation

Getting the cli

You can install from npm:

npm i @dojo/cli -g

In a terminal, run:

dojo

This should output the following:

dojo help

Usage: dojo <command> [subCommand] [options]

Hey there, here are all the things you can do with @dojo/cli:
...

If you don't see the message above, then check that you have installed the CLI with the -g option.

You can list all your global npm dependencies by running:

npm list -g –depth=0

If you don't see @dojo/cli in the list of global dependencies, then please re-install and make sure the installation runs without errors.

How to use

The basic groups and commands

The CLI has the following format:

dojo group [command] - where [command] is optional

e.g.

dojo build

where build is the group, and no command is specified, so the default build command is run. The above will output generic help information.

dojo build custombuild

where build is the group and custombuild is an installed command.

The CLI has the following in-built options:

dojo -h, --help - provides a list of help as detailed above.

The CLI has the following in-built groups:

dojo version - provides information on the versions of installed commands and the cli itself.

dojo create app and dojo build are not installed by default with @dojo/cli. To use them, you must install them separately, e.g. with npm i @dojo/cli-create-app -g.

How do I contribute?

We appreciate your interest! Please see the Dojo 2 Meta Repository for the Contributing Guidelines and Style Guide.

Testing

Test cases MUST be written using Intern using the Object test interface and Assert assertion interface.

90% branch coverage MUST be provided for all code submitted to this repository, as reported by istanbul’s combined coverage results for all supported platforms.

To test locally in node run:

grunt test

To test against browsers with a local selenium server run:

grunt test:local

To test against BrowserStack or Sauce Labs run:

grunt test:browserstack

or

grunt test:saucelabs

Licensing information

© 2004–2016 Dojo Foundation & contributors. New BSD license.