mirror of
https://github.com/balena-io/balena-cli.git
synced 2025-01-31 00:24:15 +00:00
1bc78edf71
Main changes: - Use the `columnify` module to display the commands instead of using manual parsing. - Extract logic to create a string representation from an option signature to Capitano, and reuse here. See https://github.com/resin-io/capitano/pull/28 Some bugs were caught and fixes during the refactoring: - In command help, if the command didn't exist, we reused default Capitanos command not found function which uses `process.exit(1)`. This was changed to pass a custom error to `done()`, so the command fails correctly when using programatically. - General help didn't call `done()` at all, thus causing problems if using the command programatically someday.
Resin CLI
The official Resin CLI tool.
Installing
$ npm install -g resin-cli
Running locally
$ ./bin/resin
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 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, asCygwinis not official supported by Node.js.