Merge pull request #417 from resin-io/fix-cmd-exe-doc-error

Fix requirement docs for resin sync and resin ssh

README.md

@@ -12,6 +12,20 @@ Requisites
 
 - [NodeJS](https://nodejs.org) (at least v0.10)
 - [Git](https://git-scm.com)
+- 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`)
+  - `rsync`: >= 2.6.9 (required by `resin sync`)
+
+##### Windows Support
+
+`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 Bash.
+
+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](http://www.mingw.org).
+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`.
 
 Getting Started
 ---------------

build/actions/app.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/auth.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/command-options.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/config.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/device.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/environment-variables.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/help.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/index.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/info.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/keys.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/logs.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/notes.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/os.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/settings.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/actions/ssh.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io
@@ -37,7 +38,7 @@ limitations under the License.
   module.exports = {
     signature: 'ssh [uuid]',
     description: '(beta) get a shell into the running app container of a device',
-    help: 'WARNING: If you\'re running Windows, this command only supports `cmd.exe`.\n\nUse this command to get a shell into the running application container of\nyour device.\n\nExamples:\n\n	$ resin ssh MyApp\n	$ resin ssh 7cf02a6\n	$ resin ssh 7cf02a6 --port 8080\n	$ resin ssh 7cf02a6 -v',
+    help: 'Warning: \'resin ssh\' requires an openssh-compatible client to be correctly\ninstalled in your shell environment. For more information (including Windows\nsupport) please check the README here: https://github.com/resin-io/resin-cli\n\nUse this command to get a shell into the running application container of\nyour device.\n\nExamples:\n\n	$ resin ssh MyApp\n	$ resin ssh 7cf02a6\n	$ resin ssh 7cf02a6 --port 8080\n	$ resin ssh 7cf02a6 -v',
     permission: 'user',
     primary: true,
     options: [

build/actions/sync.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io
@@ -46,7 +47,7 @@ limitations under the License.
   module.exports = {
     signature: 'sync [uuid]',
     description: '(beta) sync your changes to a device',
-    help: 'WARNING: If you\'re running Windows, this command only supports `cmd.exe`.\n\nUse this command to sync your local changes to a certain device on the fly.\n\nAfter every \'resin sync\' the updated settings will be saved in\n\'<source>/.resin-sync.yml\' and will be used in later invocations. You can\nalso change any option by editing \'.resin-sync.yml\' directly.\n\nHere is an example \'.resin-sync.yml\' :\n\n	$ cat $PWD/.resin-sync.yml\n	uuid: 7cf02a6\n	destination: \'/usr/src/app\'\n	before: \'echo Hello\'\n	after: \'echo Done\'\n	ignore:\n		- .git\n		- node_modules/\n\nCommand line options have precedence over the ones saved in \'.resin-sync.yml\'.\n\nIf \'.gitignore\' is found in the source directory then all explicitly listed files will be\nexcluded from the syncing process. You can choose to change this default behavior with the\n\'--skip-gitignore\' option.\n\nExamples:\n\n	$ resin sync 7cf02a6 --source . --destination /usr/src/app\n	$ resin sync 7cf02a6 -s /home/user/myResinProject -d /usr/src/app --before \'echo Hello\' --after \'echo Done\'\n	$ resin sync --ignore lib/\n	$ resin sync --verbose false\n	$ resin sync',
+    help: 'Warning: \'resin sync\' requires an openssh-compatible client and \'rsync\' to\nbe correctly installed in your shell environment. For more information (including\nWindows support) please check the README here: https://github.com/resin-io/resin-cli\n\nUse this command to sync your local changes to a certain device on the fly.\n\nAfter every \'resin sync\' the updated settings will be saved in\n\'<source>/.resin-sync.yml\' and will be used in later invocations. You can\nalso change any option by editing \'.resin-sync.yml\' directly.\n\nHere is an example \'.resin-sync.yml\' :\n\n	$ cat $PWD/.resin-sync.yml\n	uuid: 7cf02a6\n	destination: \'/usr/src/app\'\n	before: \'echo Hello\'\n	after: \'echo Done\'\n	ignore:\n		- .git\n		- node_modules/\n\nCommand line options have precedence over the ones saved in \'.resin-sync.yml\'.\n\nIf \'.gitignore\' is found in the source directory then all explicitly listed files will be\nexcluded from the syncing process. You can choose to change this default behavior with the\n\'--skip-gitignore\' option.\n\nExamples:\n\n	$ resin sync 7cf02a6 --source . --destination /usr/src/app\n	$ resin sync 7cf02a6 -s /home/user/myResinProject -d /usr/src/app --before \'echo Hello\' --after \'echo Done\'\n	$ resin sync --ignore lib/\n	$ resin sync --verbose false\n	$ resin sync',
     permission: 'user',
     primary: true,
     options: [

build/actions/wizard.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/app.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/errors.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/events.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 (function() {
   var Mixpanel, Promise, _, capitanoState, packageJSON, resin;
 

build/utils/helpers.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/utils/messages.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 (function() {
   exports.gettingStarted = 'Run the following command to get a device started with Resin.io\n\n  $ resin quickstart';
 

build/utils/patterns.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/utils/plugins.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/utils/update.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

build/utils/validation.js

@@ -1,3 +1,4 @@
+// Generated by CoffeeScript 1.12.2
 
 /*
 Copyright 2016 Resin.io

capitanodoc.json

@@ -1,6 +1,6 @@
 {
 	"title": "Resin CLI Documentation",
-	"introduction": "This tool allows you to interact with the resin.io api from the comfort of your command line.\n\nTo get started download the CLI from npm.\n\n\t$ npm install resin-cli -g\n\nThen authenticate yourself:\n\n\t$ resin login\n\nNow you have access to all the commands referenced below.",
+	"introduction": "This tool allows you to interact with the resin.io api from the comfort of your command line.\n\nPlease make sure your system meets the requirements as specified in the [README](https://github.com/resin-io/resin-cli).\n\nTo get started download the CLI from npm.\n\n\t$ npm install resin-cli -g\n\nThen authenticate yourself:\n\n\t$ resin login\n\nNow you have access to all the commands referenced below.",
 	"categories": [
 		{
 			"title": "Application",

doc/cli.markdown

@@ -2,6 +2,8 @@
 
 This tool allows you to interact with the resin.io api from the comfort of your command line.
 
+Please make sure your system meets the requirements as specified in the [README](https://github.com/resin-io/resin-cli).
+
 To get started download the CLI from npm.
 
 	$ npm install resin-cli -g
@@ -342,7 +344,7 @@ Examples:
 
 ### Options
 
-#### --force, -f <force>
+#### --force, -f
 
 force action if the update lock is set
 
@@ -356,7 +358,7 @@ Examples:
 
 ### Options
 
-#### --force, -f <force>
+#### --force, -f
 
 force action if the update lock is set
 
@@ -650,7 +652,9 @@ continuously stream output
 
 ## sync [uuid]
 
-WARNING: If you're running Windows, this command only supports `cmd.exe`.
+Warning: 'resin sync' requires an openssh-compatible client and 'rsync' to
+be correctly installed in your shell environment. For more information (including
+Windows support) please check the README here: https://github.com/resin-io/resin-cli
 
 Use this command to sync your local changes to a certain device on the fly.
 
@@ -725,7 +729,9 @@ increase verbosity
 
 ## ssh [uuid]
 
-WARNING: If you're running Windows, this command only supports `cmd.exe`.
+Warning: 'resin ssh' requires an openssh-compatible client to be correctly
+installed in your shell environment. For more information (including Windows
+support) please check the README here: https://github.com/resin-io/resin-cli
 
 Use this command to get a shell into the running application container of
 your device.

gulpfile.coffee

@@ -16,7 +16,7 @@ OPTIONS =
 
 gulp.task 'coffee', [ 'lint' ], ->
 	gulp.src(OPTIONS.files.app)
-		.pipe(coffee())
+		.pipe(coffee(header: true))
 		.pipe(gulp.dest(OPTIONS.directories.build))
 
 gulp.task 'lint', ->

lib/actions/ssh.coffee

@@ -39,7 +39,9 @@ module.exports =
 	signature: 'ssh [uuid]'
 	description: '(beta) get a shell into the running app container of a device'
 	help: '''
-		WARNING: If you're running Windows, this command only supports `cmd.exe`.
+		Warning: 'resin ssh' requires an openssh-compatible client to be correctly
+		installed in your shell environment. For more information (including Windows
+		support) please check the README here: https://github.com/resin-io/resin-cli
 
 		Use this command to get a shell into the running application container of
 		your device.

lib/actions/sync.coffee

@@ -44,7 +44,9 @@ module.exports =
 	signature: 'sync [uuid]'
 	description: '(beta) sync your changes to a device'
 	help: '''
-		WARNING: If you're running Windows, this command only supports `cmd.exe`.
+		Warning: 'resin sync' requires an openssh-compatible client and 'rsync' to
+		be correctly installed in your shell environment. For more information (including
+		Windows support) please check the README here: https://github.com/resin-io/resin-cli
 
 		Use this command to sync your local changes to a certain device on the fly.