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

This should ideally be part of gulp, however there doesn't seems to be any plugin for the documentation generation tool that we're using at the moment (codo).

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.

1.5 KiB Raw Blame History