mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-24 07:46:39 +00:00
66 lines
1.7 KiB
Markdown
66 lines
1.7 KiB
Markdown
Resin CLI
|
|
=========
|
|
|
|
[](http://badge.fury.io/js/resin-cli)
|
|
[](https://david-dm.org/resin-io/resin-cli.png)
|
|
[](https://travis-ci.org/resin-io/resin-cli)
|
|
[](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 --global --production 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
|
|
```
|
|
|
|
Documentation
|
|
-------------
|
|
|
|
### How to point the Resin CLI to staging?
|
|
|
|
The easiest way is to set the `RESINRC_RESIN_URL=resinstaging.io` environment variable.
|
|
|
|
Alternatively, you can edit your `$HOME/.resinrc.yml` or `%UserProfile%\_resinrc.yml` and set `resinUrl: resinstaging.io` to persist this setting.
|
|
|
|
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.
|