8c74f784f7
Fixes #906 Change-Type: patch |
||
---|---|---|
.github | ||
automation | ||
bin | ||
doc | ||
lib | ||
tests/auth | ||
typings | ||
.editorconfig | ||
.gitignore | ||
.hound.yml | ||
.prettierrc | ||
.travis.yml | ||
appveyor.yml | ||
capitanodoc.ts | ||
CHANGELOG.md | ||
coffeelint.json | ||
gulpfile.coffee | ||
LICENSE | ||
package.json | ||
README.md | ||
resin-completion.bash | ||
TROUBLESHOOTING.md | ||
tsconfig.json |
Resin CLI
The official resin.io CLI tool.
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 byresin sync
andresin ssh
)- if you need
ssh
to work behind the proxy you also needproxytunnel
installed (available asproxytunnel
package for Ubuntu, for example)
- if you need
rsync
: >= 2.6.9 (required byresin 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:
- Install MinGW.
- Install the
msys-rsync
andmsys-openssh
packages. - Add MinGW to the
%PATH%
if this hasn't been done by the installer already. The location where the binaries are places is usuallyC:\MinGW\msys\1.0\bin
, but it can vary if you selected a different location in the installer. - Copy your SSH keys to
%homedrive%%homepath\.ssh
. - 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:
- Download the latest zip for your OS from https://github.com/resin-io/resin-cli/releases.
- Extract the contents, putting the
resin-cli
folder somewhere appropriate for your system (e.g.C:/resin-cli
,/usr/local/lib/resin-cli
, etc). - Add the
resin-cli
folder to yourPATH
(Windows instructions, Linux instructions, OSX instructions) - Running
resin
in a fresh command line should print the resin CLI help.
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.