From a90d568d5c0bec9c136a5ac5a909fc9679a8eeca Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Thu, 19 May 2016 10:10:45 -0400 Subject: [PATCH] Clarify that sync and ssh only support cmd.exe on Windows Signed-off-by: Juan Cruz Viotti --- build/actions/ssh.js | 2 +- build/actions/sync.js | 2 +- doc/cli.markdown | 14 +++++++++----- lib/actions/ssh.coffee | 2 ++ lib/actions/sync.coffee | 2 ++ 5 files changed, 15 insertions(+), 7 deletions(-) diff --git a/build/actions/ssh.js b/build/actions/ssh.js index 569e98db..bf9a928a 100644 --- a/build/actions/ssh.js +++ b/build/actions/ssh.js @@ -37,7 +37,7 @@ limitations under the License. module.exports = { signature: 'ssh ', 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: [ diff --git a/build/actions/sync.js b/build/actions/sync.js index 1aa627f4..bf9b7401 100644 --- a/build/actions/sync.js +++ b/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: [ diff --git a/doc/cli.markdown b/doc/cli.markdown index 3082c157..2743d167 100644 --- a/doc/cli.markdown +++ b/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 diff --git a/lib/actions/ssh.coffee b/lib/actions/ssh.coffee index c04b7aa0..393923cb 100644 --- a/lib/actions/ssh.coffee +++ b/lib/actions/ssh.coffee @@ -39,6 +39,8 @@ module.exports = signature: 'ssh ' 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. diff --git a/lib/actions/sync.coffee b/lib/actions/sync.coffee index 06ea4da4..79ef8461 100644 --- a/lib/actions/sync.coffee +++ b/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.