balena-cli/README.md

Resin CLI

Take a look at the spec for features, roadmap and progress https://docs.google.com/a/resin.io/document/d/1mPBWy9wwLiNd25VcIvp3HEWJNjoXkALfMLMblXaGoh8/edit?usp=sharing.

Installing

$ git clone git@github.com:resin-io/resin-cli.git
$ cd resin-cli
$ npm install

If you want to have resin on your PATH:

$ npm install -g

If you want to run it locally:

$ ./bin/resin

Or:

$ node build/app.js

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 ...

Release

The following command will compile the application into a single executable for the current platform (supports Mac OS X, GNU/Linux and Windows > XP):

$ gulp release

The binary will be located at build/Release.

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

• Some interactive widgets don't work on Cygwin. If you're running Windows, it's preferrable that you use cmd.exe, as Cygwin is not official supported by Node.js.