The official resin.io CLI tool.
CoffeeScript TypeScript Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Create ISSUE_TEMPLATE.md Sep 4, 2017
automation Remove explicit anchor links in CLI docs Mar 20, 2018
bin Remove unused resin-write bin script Aug 19, 2015
doc Support emulated and nocache options for remote builds Aug 9, 2018
lib Fix errors in `getRequestStream` not being propogated Aug 15, 2018
tests/auth Clarify isTokenValid logic Mar 29, 2018
typings Add join/leave commands to promote and move devices between platforms Jul 19, 2018
.editorconfig fix resin local push help message and lint errors Mar 21, 2017
.gitignore Build standalone zips into a separate folder Dec 18, 2017
.hound.yml Change java_script to javascript in hound config Oct 19, 2015
.prettierrc Fix prettier configuration to avoid linting errors Mar 5, 2018
.travis.yml Update the deploy key since npm invalidated the old one Jul 13, 2018
CHANGELOG.md v7.9.1 Aug 15, 2018
LICENSE Change license to Apache 2.0 Jan 4, 2016
README.md Document Pyhton native build dependency Jun 12, 2018
TROUBLESHOOTING.md Document the case where EACCES is thrown during login Mar 9, 2016
appveyor.yml Autodeploy built standalone binaries for all platforms to github Dec 18, 2017
capitanodoc.ts Make sure 'resin push' is included in the docs Jun 26, 2018
coffeelint.json Add Coffeelint support Oct 31, 2014
gulpfile.coffee Use spec test reporter, so we can debug with output Mar 29, 2018
package.json v7.9.1 Aug 15, 2018
resin-completion.bash Add bash completions Mar 15, 2018
tsconfig.json Update TypeScript to 2.8.1 Jul 17, 2018

README.md

Resin CLI

The official resin.io CLI tool.

npm version dependencies Gitter

Requisites

If you want to install the CLI directly through npm, you'll need the below. If this looks difficult, we do now have an experimental standalone binary release available, see 'Standalone install' below.

  • NodeJS (>= v6)
  • Git
  • The following executables should be correctly installed in your shell environment:
    • ssh: Any recent version of the OpenSSH ssh client (required by resin sync and resin ssh)
      • if you need ssh to work behind the proxy you also need proxytunnel installed (available as proxytunnel package for Ubuntu, for example)
    • rsync: >= 2.6.9 (required by resin sync)
Windows Support

Before installing resin-cli, you'll need a working node-gyp environment. If you don't already have one you'll see native module build errors during installation. To fix this, run npm install -g --production windows-build-tools in an administrator console (available as 'Command Prompt (Admin)' when pressing windows+x in Windows 7+).

resin sync and resin ssh have not been thoroughly tested on the standard Windows cmd.exe shell. We recommend using bash (or a similar) shell, like Bash for Windows 10 or Git for Windows.

If you still want to use cmd.exe you will have to use a package manager like MinGW or chocolatey. For MinGW the steps are:

  1. Install MinGW.
  2. Install the msys-rsync and msys-openssh packages.
  3. Add MinGW to the %PATH% if this hasn't been done by the installer already. The location where the binaries are places is usually C:\MinGW\msys\1.0\bin, but it can vary if you selected a different location in the installer.
  4. Copy your SSH keys to %homedrive%%homepath\.ssh.
  5. If you need ssh to work behind the proxy you also need to install proxytunnel

Getting Started

NPM install

If you've got all the requirements above, you should be able to install the CLI directly from npm. If not, or if you have any trouble with this, please try the new standalone install steps just below.

This might require elevated privileges in some environments.

$ npm install resin-cli -g --production --unsafe-perm

--unsafe-perm is only required on systems where the global install directory is not user-writable. This allows npm install steps to download and save prebuilt native binaries. You may be able to omit it, especially if you're using a user-managed node install such as nvm.

In some environments, this process will need to build native modules. This may require a more complex build environment, and notably requires Python 2.7. If you hit any problems with this, we recommend you try the alternative standalone install below instead.

Standalone install

If you don't have node or a working pre-gyp environment, you can still install the CLI as a standalone binary. This is in experimental and may not work perfectly yet in all environments, but it seems to work well in initial cross-platform testing, so it may be useful, and we'd love your feedback if you hit any issues.

To install the CLI as a standalone binary:

To update in future, simply download a new release and replace the extracted folder.

Have any problems, or see any unexpected behaviour? Please file an issue!

Login

$ resin login

(Typically useful, but not strictly required for all commands)

Run commands

Take a look at the full command documentation at https://docs.resin.io/tools/cli/, or by running resin help.

Bash completions

Optionally you can enable tab completions for the bash shell, enabling the shell to provide additional context and automatically complete arguments toresin. To enable bash completions, copy the resin-completion.bash file to the default bash completions directory (usually /etc/bash_completion.d/) or append it to the end of ~/.bash_completion.

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 resinOS, 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 problems, 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 in the resin.io forums.

License

The project is licensed under the Apache 2.0 license.