balena-cli/README.md
Juan Cruz Viotti e82173bfb5 Write README.md
2014-12-09 15:23:17 -04:00

1.6 KiB

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:

$ coffee lib/app.coffee

Note: Alternatively, you can run bin/resin. In that case, you first need to compile the project with gulp build. This will change in the future.

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

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.
  • If you make a typo when writing a command, or run the app without any command, nothing is shown. This will be fixed soon.