The official balena CLI tool.
Go to file
Juan Cruz Viotti d414d1c5e3 Merge pull request #403 from resin-io/coffee-script-1.11.1
Update coffee-script to 1.11.1
2016-10-26 12:04:18 -04:00
bin Remove unused resin-write bin script 2015-08-19 11:30:48 -04:00
build Update coffee-script to 1.11.1 2016-10-26 11:55:39 -03:00
doc Regenerate markdown documentation 2016-09-25 19:51:32 -04:00
extras/capitanodoc Regenerate docs 2015-07-07 18:01:25 -04:00
lib Bring back devices supported command 2016-09-25 19:49:06 -04:00
.editorconfig Add editorconfig 2014-10-31 09:49:57 -04:00
.gitignore Add resinrc.yml to gitignore 2015-09-08 09:07:48 +03:00
.hound.yml Change java_script to javascript in hound config 2015-10-19 14:21:10 -04:00
.npmignore Add npmignore 2015-12-04 08:51:28 -04:00
capitanodoc.json Implement resin ssh <uuid> command 2016-04-26 16:00:54 +03:00
CHANGELOG.md v5.1.0 2016-09-25 19:55:55 -04:00
coffeelint.json Add Coffeelint support 2014-10-31 09:48:53 -04:00
gulpfile.coffee Remove tests tasks and CI configuration 2016-01-21 10:16:54 -04:00
LICENSE Change license to Apache 2.0 2016-01-03 23:58:51 -04:00
package.json Update coffee-script to 1.11.1 2016-10-26 11:55:39 -03:00
README.md Link to resin-plugin-hello from README 2016-03-31 10:11:05 -04:00
TROUBLESHOOTING.md Document the case where EACCES is thrown during login 2016-03-09 11:03:45 -04:00

Resin CLI

The official Resin CLI tool.

npm version dependencies Gitter

Requisites

Getting Started

Installing

This might require elevated privileges in some environments.

$ npm install --global --production resin-cli

List available commands

$ resin help

Run the quickstart wizard

$ resin quickstart

Plugins

The Resin CLI can be extended with plugins to automate laborious tasks and overall provide a better experience when working with Resin.io. Check the plugin development tutorial to learn how to build your own!

FAQ

Where is my configuration file?

The per-user configuration file lives in $HOME/.resinrc.yml or %UserProfile%\_resinrc.yml, in Unix based operating systems and Windows respectively.

The Resin CLI also attempts to read a resinrc.yml file in the current directory, which takes precedence over the per-user configuration file.

How do I 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 configuration file and set resinUrl: resinstaging.io to persist this setting.

How do I make the Resin CLI persist data in another directory?

The Resin CLI persists your session token, as well as cached images in $HOME/.resin or %UserProfile%\_resin.

Pointing the Resin CLI to persist data in another location is necessary in certain environments, like a server, where there is no home directory, or a device running Resin OS, which erases all data after a restart.

You can accomplish this by setting RESINRC_DATA_DIRECTORY=/opt/resin or adding dataDirectory: /opt/resin to your configuration file, replacing /opt/resin with your desired directory.

Support

If you're having any problem, check our troubleshooting guide and if your problem is not addressed there, please raise an issue on GitHub and the Resin.io team will be happy to help.

You can also get in touch with us at our public Gitter chat channel.

License

The project is licensed under the Apache 2.0 license.