balena-cli/README.md
2015-05-21 10:52:37 -04:00

1.5 KiB

Resin CLI

npm version dependencies Build Status Build status

The official Resin CLI tool.

Installing

$ npm install -g resin-cli

Running locally

$ ./bin/resin

Tests

You can run the Mocha test suite, you can do:

$ gulp test

Development mode

The following command will watch for any changes and will run a linter and the whole test suite:

$ gulp watch

If you set DEBUG environment variable, errors will print with a stack trace:

$ DEBUG=true resin ...

Documentation

You can renegerate the documentation with:

$ npm run-script doc

Manual pages

UNIX manual pages reside in man/

You can regenerate UNIX roff manual pages from markdown with:

$ gulp man

If you add a new man page, remember to add the generated filename to the man array in package.json.

Caveats