The official balena CLI tool.
Go to file
2015-02-26 11:50:21 -04:00
bin Precompile CoffeeScript files 2015-02-26 11:47:34 -04:00
build Reference JavaScript version of install-node script 2015-02-26 11:50:21 -04:00
completion Update sh completion with new commands 2015-02-09 10:00:16 -04:00
lib Precompile CoffeeScript files 2015-02-26 11:47:34 -04:00
man Make use of diskio 2015-02-02 12:25:22 -04:00
scripts Precompile CoffeeScript files 2015-02-26 11:47:34 -04:00
tests Move tests to tests/ and flatten errors/ module directory 2015-02-10 11:38:19 -04:00
.editorconfig Add editorconfig 2014-10-31 09:49:57 -04:00
.gitignore Commit build directory 2015-02-26 11:47:56 -04:00
coffeelint.json Add Coffeelint support 2014-10-31 09:48:53 -04:00
gulpfile.coffee Reference JavaScript version of install-node script 2015-02-26 11:50:21 -04:00
npm-shrinkwrap.json Multi arch builds 2015-02-26 10:12:25 -04:00
package.json Reference JavaScript version of install-node script 2015-02-26 11:50:21 -04:00
README.md Explain how to produce a binary in README.md 2014-12-30 13:20:07 -04:00

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@bitbucket.org:rulemotion/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:

$ coffee lib/app.coffee

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.
  • Most commands require an <id> argument, however Commander refuses to show that in the help page. This will be fixed soon.