mirror of
https://github.com/balena-io/balena-cli.git
synced 2025-01-18 18:56:25 +00:00
The official balena CLI tool.
3d36e5f5d3
This functionality is outdated and not using anymore due to limitations in the way it was addressed. The module and dependencies are removed for now, and will be added back in the future, once a better approach is planned. |
||
|---|---|---|
| bin | ||
| build | ||
| completion | ||
| doc | ||
| extras/capitanodoc | ||
| lib | ||
| tests | ||
| .editorconfig | ||
| .gitignore | ||
| .hound.yml | ||
| .travis.yml | ||
| appveyor.yml | ||
| capitanodoc.json | ||
| coffeelint.json | ||
| gulpfile.coffee | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
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.