balena-cli/README.md

# Resin CLI

[![npm version](https://badge.fury.io/js/resin-cli.svg)](http://badge.fury.io/js/resin-cli)
[![dependencies](https://david-dm.org/resin-io/resin-cli.png)](https://david-dm.org/resin-io/resin-cli.png)
[![Build Status](https://travis-ci.org/resin-io/resin-cli.svg?branch=master)](https://travis-ci.org/resin-io/resin-cli)
[![Build status](https://ci.appveyor.com/api/projects/status/45i7d0m0patxj420?svg=true)](https://ci.appveyor.com/project/jviotti/resin-cli)

The official Resin CLI tool.

## Installing

```sh
$ npm install -g resin-cli
```

### Running locally

```sh
$ ./bin/resin
```

## Tests

You can run the [Mocha](http://mochajs.org/) test suite, you can do:

```sh
$ gulp test
```

## Development mode

The following command will watch for any changes and will run a linter and the whole test suite:

```sh
$ gulp watch
```

If you set `DEBUG` environment variable, errors will print with a stack trace:

```sh
$ DEBUG=true resin ...
```

## Documentation

You can renegerate the documentation with:

```sh
$ npm run-script doc
```

## Caveats

- Some interactive widgets don't work on [Cygwin](https://cygwin.com/). If you're running Windows, it's preferrable that you use `cmd.exe`, as `Cygwin` is [not official supported by Node.js](https://github.com/chjj/blessed/issues/56#issuecomment-42671945).
Write README.md 2014-12-09 19:20:22 +00:00			`# Resin CLI`

Add NPM badge 2015-03-03 18:32:13 +00:00			`[![npm version](https://badge.fury.io/js/resin-cli.svg)](http://badge.fury.io/js/resin-cli)`
Add dependencies and Travis CI badges 2015-03-02 16:34:15 +00:00			`[![dependencies](https://david-dm.org/resin-io/resin-cli.png)](https://david-dm.org/resin-io/resin-cli.png)`
			`[![Build Status](https://travis-ci.org/resin-io/resin-cli.svg?branch=master)](https://travis-ci.org/resin-io/resin-cli)`
Configure appveyor CI 2015-05-21 14:52:37 +00:00			`[![Build status](https://ci.appveyor.com/api/projects/status/45i7d0m0patxj420?svg=true)](https://ci.appveyor.com/project/jviotti/resin-cli)`
Add dependencies and Travis CI badges 2015-03-02 16:34:15 +00:00
Remove private Google Doc link from README 2015-03-02 16:40:19 +00:00			`The official Resin CLI tool.`
Write README.md 2014-12-09 19:20:22 +00:00
			`## Installing`

			```sh
Clean README 2015-03-03 19:05:46 +00:00			`$ npm install -g resin-cli`
Write README.md 2014-12-09 19:20:22 +00:00			```

Clean README 2015-03-03 19:05:46 +00:00			`### Running locally`
Write README.md 2014-12-09 19:20:22 +00:00
			```sh
Remove JS compilation step for running bin/resin 2014-12-09 19:35:15 +00:00			`$ ./bin/resin`
Write README.md 2014-12-09 19:20:22 +00:00			```

			`## Tests`

			`You can run the [Mocha](http://mochajs.org/) test suite, you can do:`

			```sh
			`$ gulp test`
			```

			`## Development mode`

			`The following command will watch for any changes and will run a linter and the whole test suite:`

			```sh
			`$ gulp watch`
			```

Implement errors.handle() debug support 2014-12-10 18:12:12 +00:00			If you set `DEBUG` environment variable, errors will print with a stack trace:

			```sh
			`$ DEBUG=true resin ...`
			```

Write README.md 2014-12-09 19:20:22 +00:00			`## Documentation`

			`You can renegerate the documentation with:`

			```sh
			`$ npm run-script doc`
			```

			`## Caveats`

Add information about why CLI doesn't work fine on Cygwin 2014-12-24 12:04:36 +00:00			- Some interactive widgets don't work on [Cygwin](https://cygwin.com/). If you're running Windows, it's preferrable that you use `cmd.exe`, as `Cygwin` is [not official supported by Node.js](https://github.com/chjj/blessed/issues/56#issuecomment-42671945).