Merge pull request #346 from resin-io/misc/ssh-sync-cmd-exe-warning

Clarify that sync and ssh only support cmd.exe on Windows

build/actions/ssh.js

@@ -37,7 +37,7 @@ limitations under the License.
   module.exports = {
     signature: 'ssh <uuid>',
     description: '(beta) get a shell into the running app container of a device',
-    help: 'Use this command to get a shell into the running application container of\nyour device.\n\nExamples:\n\n	$ resin ssh 7cf02a6\n	$ resin ssh 7cf02a6 --port 8080',
+    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 7cf02a6\n	$ resin ssh 7cf02a6 --port 8080',
     permission: 'user',
     primary: true,
     options: [

build/actions/sync.js

@@ -19,7 +19,7 @@ limitations under the License.
   module.exports = {
     signature: 'sync [source]',
     description: '(beta) sync your changes with a device',
-    help: 'Use this command to sync your local changes to a certain device on the fly.\n\nThe `source` argument can be either a device uuid or an application name.\n\nYou can save all the options mentioned below in a `resin-sync.yml` file,\nby using the same option names as keys. For example:\n\n	$ cat $PWD/resin-sync.yml\n	source: src/\n	before: \'echo Hello\'\n	ignore:\n		- .git\n		- node_modules/\n	progress: true\n\nNotice that explicitly passed command options override the ones set in the configuration file.\n\nExamples:\n\n	$ resin sync MyApp\n	$ resin sync 7cf02a6\n	$ resin sync 7cf02a6 --port 8080\n	$ resin sync 7cf02a6 --ignore foo,bar',
+    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\nThe `source` argument can be either a device uuid or an application name.\n\nYou can save all the options mentioned below in a `resin-sync.yml` file,\nby using the same option names as keys. For example:\n\n	$ cat $PWD/resin-sync.yml\n	source: src/\n	before: \'echo Hello\'\n	ignore:\n		- .git\n		- node_modules/\n	progress: true\n\nNotice that explicitly passed command options override the ones set in the configuration file.\n\nExamples:\n\n	$ resin sync MyApp\n	$ resin sync 7cf02a6\n	$ resin sync 7cf02a6 --port 8080\n	$ resin sync 7cf02a6 --ignore foo,bar',
     permission: 'user',
     primary: true,
     options: [

doc/cli.markdown

@@ -73,7 +73,7 @@ Now you have access to all the commands referenced below.
 
 - SSH
 
-	- [enter <uuid>](#enter-60-uuid-62-)
+	- [ssh <uuid>](#ssh-60-uuid-62-)
 
 - Notes
 
@@ -584,6 +584,8 @@ continuously stream output
 
 ## sync [source]
 
+WARNING: If you're running Windows, this command only supports `cmd.exe`.
+
 Use this command to sync your local changes to a certain device on the fly.
 
 The `source` argument can be either a device uuid or an application name.
@@ -632,21 +634,23 @@ ssh port
 
 # SSH
 
-## enter <uuid>
+## ssh <uuid>
+
+WARNING: If you're running Windows, this command only supports `cmd.exe`.
 
 Use this command to get a shell into the running application container of
 your device.
 
 Examples:
 
-	$ resin enter 7cf02a6
-	$ resin enter 7cf02a6 --port 8080
+	$ resin ssh 7cf02a6
+	$ resin ssh 7cf02a6 --port 8080
 
 ### Options
 
 #### --port, -t <port>
 
-ssh port
+ssh gateway port
 
 # Notes
 

lib/actions/ssh.coffee

@@ -39,6 +39,8 @@ 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`.
+
 		Use this command to get a shell into the running application container of
 		your device.
 

lib/actions/sync.coffee

@@ -18,6 +18,8 @@ module.exports =
 	signature: 'sync [source]'
 	description: '(beta) sync your changes with a device'
 	help: '''
+		WARNING: If you're running Windows, this command only supports `cmd.exe`.
+
 		Use this command to sync your local changes to a certain device on the fly.
 
 		The `source` argument can be either a device uuid or an application name.