The official balena CLI tool.
Go to file
2014-12-22 12:47:12 -04:00
bin Remove JS compilation step for running bin/resin 2014-12-09 15:40:38 -04:00
doc Regenerate documentation 2014-12-12 09:28:08 -04:00
lib Move errors.handle() out of resin sdk 2014-12-22 12:47:12 -04:00
tests Fix settings get bug in mocks 2014-12-05 11:49:00 -04:00
.editorconfig Add editorconfig 2014-10-31 09:49:57 -04:00
.gitignore Improve build system and CLI integration 2014-11-26 09:54:21 -04:00
coffeelint.json Add Coffeelint support 2014-10-31 09:48:53 -04:00
gulpfile.coffee Remove JS compilation step for running bin/resin 2014-12-09 15:40:38 -04:00
package.json Implement key add command 2014-12-19 13:06:58 -04:00
README.md Implement basic man page 2014-12-10 15:18:39 -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 ...

Documentation

You can renegerate the documentation with:

$ npm run-script doc

Manual pages

UNIX manual pages reside in doc/

You can regenerate UNIX roff manual pages from markdown with:

$ npm run-script man

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