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.

Requisites
----------

- [NodeJS](https://nodejs.org) (at least v0.10)
- [Git](https://git-scm.com)

Getting Started
---------------

### Installing

This might require elevated privileges in some environments.

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

### Login

```sh
$ resin login
```

### List available commands

```sh
$ resin help
```

### Run the quickstart wizard

Run as `root` on UNIX based systems, and in an administrator command line prompt in Windows.

```sh
$ resin quickstart
```

Support
-------

If you're having any problem, check our [troubleshooting guide](https://github.com/resin-io/resin-cli/blob/master/TROUBLESHOOTING.md) and if your problem is not addressed there, please [raise an issue](https://github.com/resin-io/resin-cli/issues/new) on GitHub and the Resin.io team will be happy to help.

License
-------

The project is licensed under the MIT license.
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`Resin CLI`
			`=========`
Write README.md 2014-12-09 19:20:22 +00:00
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
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`Requisites`
			`----------`
Write README.md 2014-12-09 19:20:22 +00:00
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`- [NodeJS](https://nodejs.org) (at least v0.10)`
			`- [Git](https://git-scm.com)`
Write README.md 2014-12-09 19:20:22 +00:00
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`Getting Started`
			`---------------`
Write README.md 2014-12-09 19:20:22 +00:00
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`### Installing`
Write README.md 2014-12-09 19:20:22 +00:00
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`This might require elevated privileges in some environments.`
Write README.md 2014-12-09 19:20:22 +00:00
			```sh
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`$ npm install -g resin-cli`
Write README.md 2014-12-09 19:20:22 +00:00			```

Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`### Login`
Write README.md 2014-12-09 19:20:22 +00:00
			```sh
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`$ resin login`
Write README.md 2014-12-09 19:20:22 +00:00			```

Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`### List available commands`
Implement errors.handle() debug support 2014-12-10 18:12:12 +00:00
			```sh
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`$ resin help`
Implement errors.handle() debug support 2014-12-10 18:12:12 +00:00			```

Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`### Run the quickstart wizard`
Write README.md 2014-12-09 19:20:22 +00:00
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			Run as `root` on UNIX based systems, and in an administrator command line prompt in Windows.
Write README.md 2014-12-09 19:20:22 +00:00
			```sh
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`$ resin quickstart`
Write README.md 2014-12-09 19:20:22 +00:00			```

Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00			`Support`
			`-------`

Add Troubleshooting guide This guide described common Resin CLI issues and how to fix them. 2015-09-21 12:32:11 +00:00			`If you're having any problem, check our [troubleshooting guide](https://github.com/resin-io/resin-cli/blob/master/TROUBLESHOOTING.md) and if your problem is not addressed there, please [raise an issue](https://github.com/resin-io/resin-cli/issues/new) on GitHub and the Resin.io team will be happy to help.`
Improve README.md - Make user oriented instead of developer oriented. - Remove deprecated information. - Add Requisites section. - Add Getting Started section. - Add Support section. - Add License section. 2015-09-21 11:56:24 +00:00
			`License`
			`-------`

			`The project is licensed under the MIT license.`