2015-09-21 07:56:24 -04:00
Resin CLI
=========
2014-12-09 15:20:22 -04:00
2015-03-03 14:32:13 -04:00
[![npm version ](https://badge.fury.io/js/resin-cli.svg )](http://badge.fury.io/js/resin-cli)
2015-03-02 12:34:15 -04: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)
2015-05-21 10:52:37 -04:00
[![Build status ](https://ci.appveyor.com/api/projects/status/45i7d0m0patxj420?svg=true )](https://ci.appveyor.com/project/jviotti/resin-cli)
2015-03-02 12:34:15 -04:00
2015-03-02 12:40:19 -04:00
The official Resin CLI tool.
2014-12-09 15:20:22 -04:00
2015-09-21 07:56:24 -04:00
Requisites
----------
2014-12-09 15:20:22 -04:00
2015-09-21 07:56:24 -04:00
- [NodeJS ](https://nodejs.org ) (at least v0.10)
- [Git ](https://git-scm.com )
2014-12-09 15:20:22 -04:00
2015-09-21 07:56:24 -04:00
Getting Started
---------------
2014-12-09 15:20:22 -04:00
2015-09-21 07:56:24 -04:00
### Installing
2014-12-09 15:20:22 -04:00
2015-09-21 07:56:24 -04:00
This might require elevated privileges in some environments.
2014-12-09 15:20:22 -04:00
```sh
2015-09-21 07:56:24 -04:00
$ npm install -g resin-cli
2014-12-09 15:20:22 -04:00
```
2015-09-21 07:56:24 -04:00
### Login
2014-12-09 15:20:22 -04:00
```sh
2015-09-21 07:56:24 -04:00
$ resin login
2014-12-09 15:20:22 -04:00
```
2015-09-21 07:56:24 -04:00
### List available commands
2014-12-10 14:12:12 -04:00
```sh
2015-09-21 07:56:24 -04:00
$ resin help
2014-12-10 14:12:12 -04:00
```
2015-09-21 07:56:24 -04:00
### Run the quickstart wizard
2014-12-09 15:20:22 -04:00
2015-09-21 07:56:24 -04:00
Run as `root` on UNIX based systems, and in an administrator command line prompt in Windows.
2014-12-09 15:20:22 -04:00
```sh
2015-09-21 07:56:24 -04:00
$ resin quickstart
2014-12-09 15:20:22 -04:00
```
2015-09-21 07:56:24 -04:00
Support
-------
2015-09-21 08:32:11 -04: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.
2015-09-21 07:56:24 -04:00
License
-------
The project is licensed under the MIT license.