ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2024-12-23 23:42:24 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Move command declarations next to their definitions

Browse Source
This commit is contained in:
Juan Cruz Viotti 2015-01-15 14:10:14 -03:00
parent f94be29047
commit 5abc4e550f
14 changed files with 791 additions and 812 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

92
lib/actions/app.coffee
View File

@ -3,8 +3,33 @@ async = require('async')
resin = require('resin-sdk')
ui = require('../ui')
permissions = require('../permissions/permissions')
commandOptions = require('./command-options')
exports.create = permissions.user (params, options, done) ->
exports.create =
signature: 'app create <name>'
description: 'create an application'
help: '''
Use this command to create a new resin.io application.
You can specify the application type with the `--type` option.
Otherwise, an interactive dropdown will be shown for you to select from.
You can see a list of supported device types with
$ resin devices supported
Examples:
$ resin app create MyApp
$ resin app create MyApp --type raspberry-pi
'''
options: [
{
signature: 'type'
parameter: 'type'
description: 'application type'
alias: 't'
}
]
action: permissions.user (params, options, done) ->
async.waterfall([
(callback) ->
@ -21,7 +46,19 @@ exports.create = permissions.user (params, options, done) ->
], done)
exports.list = permissions.user (params, options, done) ->
exports.list =
signature: 'apps'
description: 'list all applications'
help: '''
Use this command to list all your applications.
Notice this command only shows the most important bits of information for each app.
If you want detailed information, use resin app <id> instead.
Examples:
$ resin apps
'''
action: permissions.user (params, options, done) ->
resin.models.application.getAll (error, applications) ->
return done(error) if error?
console.log ui.widgets.table.horizontal applications, [
@ -33,7 +70,16 @@ exports.list = permissions.user (params, options, done) ->
]
return done()
exports.info = permissions.user (params, options, done) ->
exports.info =
signature: 'app <id>'
description: 'list a single application'
help: '''
Use this command to show detailed information for a single application.
Examples:
$ resin app 91
'''
action: permissions.user (params, options, done) ->
resin.models.application.get params.id, (error, application) ->
return done(error) if error?
console.log ui.widgets.table.vertical application, [
@ -45,16 +91,50 @@ exports.info = permissions.user (params, options, done) ->
]
return done()
exports.restart = permissions.user (params, options, done) ->
exports.restart =
signature: 'app restart <id>'
description: 'restart an application'
help: '''
Use this command to restart all devices that belongs to a certain application.
Examples:
$ resin app restart 91
'''
action: permissions.user (params, options, done) ->
resin.models.application.restart(params.id, done)
exports.remove = permissions.user (params, options, done) ->
exports.remove =
signature: 'app rm <id>'
description: 'remove an application'
help: '''
Use this command to remove a resin.io application.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin app rm 91
$ resin app rm 91 --yes
'''
options: [ commandOptions.yes ]
action: permissions.user (params, options, done) ->
ui.patterns.remove 'application', options.yes, (callback) ->
resin.models.application.remove(params.id, callback)
, done
exports.init = permissions.user (params, options, done) ->
exports.init =
signature: 'init <id>'
description: 'init an application'
help: '''
Use this command to associate a local project to an existing resin.io application.
The application should be a git repository before issuing this command.
Notice this command adds a `resin` git remote to your application.
Examples:
$ cd myApp && resin init 91
'''
action: permissions.user (params, options, done) ->
currentDirectory = process.cwd()
async.waterfall [

60
lib/actions/auth.coffee
View File

@ -6,7 +6,21 @@ ui = require('../ui')
permissions = require('../permissions/permissions')
helpers = require('../helpers/helpers')
exports.login = (params, options, done) ->
exports.login =
signature: 'login [credentials]'
description: 'login to resin.io'
help: '''
Use this command to login to your resin.io account.
You need to login before you can use most of the commands this tool provides.
You can pass your credentials as a colon separated string, or you can omit the
credentials, in which case the tool will present you with an interactive login form.
Examples:
$ resin login username:password
$ resin login
'''
action: (params, options, done) ->
async.waterfall [
(callback) ->
@ -20,10 +34,39 @@ exports.login = (params, options, done) ->
], done
exports.logout = permissions.user (params, options, done) ->
exports.logout =
signature: 'logout'
description: 'logout from resin.io'
help: '''
Use this command to logout from your resin.io account.o
Examples:
$ resin logout
'''
action: permissions.user (params, options, done) ->
resin.auth.logout(done)
exports.signup = (params, options, done) ->
exports.signup =
signature: 'signup'
description: 'signup to resin.io'
help: '''
Use this command to signup for a resin.io account.
If signup is successful, you'll be logged in to your new user automatically.
TODO: We need to provide a non interactive way to use this command,
however it's not clear to me how to do it easily for now.
Examples:
$ resin signup
Email: me@mycompany.com
Username: johndoe
Password: ***********
$ resin whoami
johndoe
'''
action: (params, options, done) ->
async.waterfall([
(callback) ->
@ -38,7 +81,16 @@ exports.signup = (params, options, done) ->
], done)
exports.whoami = permissions.user (params, options, done) ->
exports.whoami =
signature: 'whoami'
description: 'get current username'
help: '''
Use this command to find out the current logged in username.
Examples:
$ resin whoami
'''
action: permissions.user (params, options, done) ->
resin.auth.whoami (error, username) ->
if not username?

12
lib/actions/command-options.coffee Normal file
View File

@ -0,0 +1,12 @@
exports.yes =
signature: 'yes'
description: 'confirm non interactively'
boolean: true
alias: 'y'
exports.application =
signature: 'application'
parameter: 'application'
description: 'application id'
alias: [ 'a', 'app' ]
required: 'You have to specify an application'

78
lib/actions/device.coffee
View File

@ -3,8 +3,19 @@ async = require('async')
resin = require('resin-sdk')
ui = require('../ui')
permissions = require('../permissions/permissions')
commandOptions = require('./command-options')
exports.list = permissions.user (params, options, done) ->
exports.list =
signature: 'devices'
description: 'list all devices'
help: '''
Use this command to list all devices that belong to a certain application.
Examples:
$ resin devices --application 91
'''
options: [ commandOptions.application ]
action: permissions.user (params, options, done) ->
resin.models.device.getAllByApplication options.application, (error, devices) ->
return done(error) if error?
console.log ui.widgets.table.horizontal devices, [
@ -19,7 +30,16 @@ exports.list = permissions.user (params, options, done) ->
return done()
exports.info = permissions.user (params, options, done) ->
exports.info =
signature: 'device <id>'
description: 'list a single device'
help: '''
Use this command to show information about a single device.
Examples:
$ resin device 317
'''
action: permissions.user (params, options, done) ->
resin.models.device.get params.id, (error, device) ->
return done(error) if error?
console.log ui.widgets.table.vertical device, [
@ -40,15 +60,52 @@ exports.info = permissions.user (params, options, done) ->
return done()
exports.remove = permissions.user (params, options, done) ->
exports.remove =
signature: 'device rm <id>'
description: 'remove a device'
help: '''
Use this command to remove a device from resin.io.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin device rm 317
$ resin device rm 317 --yes
'''
options: [ commandOptions.yes ]
action: permissions.user (params, options, done) ->
ui.patterns.remove 'device', options.yes, (callback) ->
resin.models.device.remove(params.id, callback)
, done
exports.identify = permissions.user (params, options, done) ->
exports.identify =
signature: 'device identify <uuid>'
description: 'identify a device with a UUID'
help: '''
Use this command to identify a device.
In the Raspberry Pi, the ACT led is blinked several times.
Examples:
$ resin device identify 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828
'''
action: permissions.user (params, options, done) ->
resin.models.device.identify(params.uuid, done)
exports.rename = permissions.user (params, options, done) ->
exports.rename =
signature: 'device rename <id> [name]'
description: 'rename a resin device'
help: '''
Use this command to rename a device.
If you omit the name, you'll get asked for it interactively.
Examples:
$ resin device rename 317 MyPi
$ resin device rename 317
'''
action: permissions.user (params, options, done) ->
async.waterfall [
(callback) ->
@ -61,6 +118,15 @@ exports.rename = permissions.user (params, options, done) ->
], done
exports.supported = permissions.user ->
exports.supported =
signature: 'devices supported'
description: 'list all supported devices'
help: '''
Use this command to get the list of all supported devices
Examples:
$ resin devices supported
'''
action: permissions.user ->
devices = resin.models.device.getSupportedDeviceTypes()
_.each(devices, _.unary(console.log))

78
lib/actions/environment-variables.coffee
View File

@ -2,8 +2,34 @@ _ = require('lodash-contrib')
resin = require('resin-sdk')
ui = require('../ui')
permissions = require('../permissions/permissions')
commandOptions = require('./command-options')
exports.list = permissions.user (params, options, done) ->
exports.list =
signature: 'envs'
description: 'list all environment variables'
help: '''
Use this command to list all environment variables for a particular application.
Notice we will support per-device environment variables soon.
This command lists all custom environment variables set on the devices running
the application. If you want to see all environment variables, including private
ones used by resin, use the verbose option.
Example:
$ resin envs --application 91
$ resin envs --application 91 --verbose
'''
options: [
commandOptions.application
{
signature: 'verbose'
description: 'show private environment variables'
boolean: true
alias: 'v'
}
]
action: permissions.user (params, options, done) ->
resin.models.environmentVariables.getAllByApplication options.application, (error, environmentVariables) ->
return done(error) if error?
@ -13,12 +39,47 @@ exports.list = permissions.user (params, options, done) ->
console.log(ui.widgets.table.horizontal(environmentVariables))
return done()
exports.remove = permissions.user (params, options, done) ->
exports.remove =
signature: 'env rm <id>'
description: 'remove an environment variable'
help: '''
Use this command to remove an environment variable from an application.
Don't remove resin specific variables, as things might not work as expected.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin env rm 215
$ resin env rm 215 --yes
'''
options: [ commandOptions.yes ]
action: permissions.user (params, options, done) ->
ui.patterns.remove 'environment variable', options.yes, (callback) ->
resin.models.environmentVariables.remove(params.id, callback)
, done
exports.add = permissions.user (params, options, done) ->
exports.add =
signature: 'env add <key> [value]'
description: 'add an environment variable'
help: '''
Use this command to add an enviroment variable to an application.
You need to pass the `--application` option.
If value is omitted, the tool will attempt to use the variable's value
as defined in your host machine.
If the value is grabbed from the environment, a warning message will be printed.
Use `--quiet` to remove it.
Examples:
$ resin env add EDITOR vim -a 91
$ resin env add TERM -a 91
'''
options: [ commandOptions.application ]
action: permissions.user (params, options, done) ->
if not params.value?
params.value = process.env[params.key]
@ -29,5 +90,14 @@ exports.add = permissions.user (params, options, done) ->
resin.models.environmentVariables.create(options.application, params.key, params.value, done)
exports.rename = permissions.user (params, options, done) ->
exports.rename =
signature: 'env rename <id> <value>'
description: 'rename an environment variable'
help: '''
Use this command to rename an enviroment variable from an application.
Examples:
$ resin env rename 376 emacs
'''
action: permissions.user (params, options, done) ->
resin.models.environmentVariables.update(params.id, params.value, done)

35
lib/actions/examples.coffee
View File

@ -8,8 +8,16 @@ permissions = require('../permissions/permissions')
ui = require('../ui')
examplesData = require('../data/examples.json')
exports.list = permissions.user ->
exports.list =
signature: 'examples'
description: 'list all example applications'
help: '''
Use this command to list available example applications from resin.io
Example:
$ resin examples
'''
action: permissions.user ->
examplesData = _.map examplesData, (example, index) ->
example.id = index + 1
return example
@ -25,7 +33,16 @@ exports.list = permissions.user ->
'Author'
]
exports.info = permissions.user (params, options, done) ->
exports.info =
signature: 'example <id>'
description: 'list a single example application'
help: '''
Use this command to show information of a single example application
Example:
$ resin example 3
'''
action: permissions.user (params, options, done) ->
id = params.id - 1
example = examplesData[id]
@ -45,7 +62,19 @@ exports.info = permissions.user (params, options, done) ->
return done()
exports.clone = permissions.user (params, options, done) ->
exports.clone =
signature: 'example clone <id>'
description: 'clone an example application'
help: '''
Use this command to clone an example application to the current directory
This command outputs information about the cloning process.
Use `--quiet` to remove that output.
Example:
$ resin example clone 3
'''
action: permissions.user (params, options, done) ->
example = examplesData[params.id - 1]
if not example?

5
lib/actions/help.coffee
View File

@ -110,7 +110,10 @@ exports.command = (params) ->
console.log()
exports.help = (params) ->
exports.help =
signature: 'help [command...]'
description: 'show help'
action: (params) ->
if params.command?
exports.command(arguments...)
else

5
lib/actions/info.coffee
View File

@ -1,4 +1,7 @@
packageJSON = require('../../package.json')
exports.version = ->
exports.version =
signature: 'version'
description: 'output the version number'
action: ->
console.log(packageJSON.version)

54
lib/actions/keys.coffee
View File

@ -6,26 +6,72 @@ resin = require('resin-sdk')
helpers = require('../helpers/helpers')
ui = require('../ui')
permissions = require('../permissions/permissions')
commandOptions = require('./command-options')
exports.list = permissions.user (params, options, done) ->
exports.list =
signature: 'keys'
description: 'list all ssh keys'
help: '''
Use this command to list all your SSH keys.
Examples:
$ resin keys
'''
action: permissions.user (params, options, done) ->
resin.models.key.getAll (error, keys) ->
return done(error) if error?
console.log ui.widgets.table.horizontal keys, [ 'ID', 'Title' ]
return done()
exports.info = permissions.user (params, options, done) ->
exports.info =
signature: 'key <id>'
description: 'list a single ssh key'
help: '''
Use this command to show information about a single SSH key.
Examples:
$ resin key 17
'''
action: permissions.user (params, options, done) ->
resin.models.key.get params.id, (error, key) ->
return done(error) if error?
key.public_key = '\n' + _.str.chop(key.public_key, resin.settings.get('sshKeyWidth')).join('\n')
console.log(ui.widgets.table.vertical(key, [ 'ID', 'Title', 'Public Key' ]))
return done()
exports.remove = permissions.user (params, options, done) ->
exports.remove =
signature: 'key rm <id>'
description: 'remove a ssh key'
help: '''
Use this command to remove a SSH key from resin.io.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin key rm 17
$ resin key rm 17 --yes
'''
options: [ commandOptions.yes ]
action: permissions.user (params, options, done) ->
ui.patterns.remove 'key', options.yes, (callback) ->
resin.models.key.remove(params.id, callback)
, done
exports.add = permissions.user (params, options, done) ->
exports.add =
signature: 'key add <name> [path]'
description: 'add a SSH key to resin.io'
help: '''
Use this command to associate a new SSH key with your account.
If `path` is omitted, the command will attempt
to read the SSH key from stdin.
Examples:
$ resin key add Main ~/.ssh/id_rsa.pub
$ cat ~/.ssh/id_rsa.pub | resin key add Main
'''
action: permissions.user (params, options, done) ->
async.waterfall [
(callback) ->

38
lib/actions/logs.coffee
View File

@ -4,8 +4,44 @@ permissions = require('../permissions/permissions')
LOGS_HISTORY_COUNT = 200
exports.logs = permissions.user (params, options, done) ->
exports.logs =
signature: 'logs <uuid>'
description: 'show device logs'
help: '''
Use this command to show logs for a specific device.
By default, the command prints all log messages and exit.
To limit the output to the n last lines, use the `--num` option along with a number.
This is similar to doing `resin logs <uuid> | tail -n X`.
To continuously stream output, and see new logs in real time, use the `--tail` option.
Note that for now you need to provide the whole UUID for this command to work correctly,
and the tool won't notice if you're using an invalid UUID.
This is due to some technical limitations that we plan to address soon.
Examples:
$ resin logs 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828
$ resin logs 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828 --num 20
$ resin logs 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828 --tail
'''
options: [
{
signature: 'num'
parameter: 'num'
description: 'number of lines to display'
alias: 'n'
}
{
signature: 'tail'
description: 'continuously stream output'
boolean: true
alias: 't'
}
]
action: permissions.user (params, options, done) ->
resin.logs.subscribe params.uuid, {
history: options.num or LOGS_HISTORY_COUNT
tail: options.tail

23
lib/actions/notes.coffee
View File

@ -3,7 +3,28 @@ permissions = require('../permissions/permissions')
helpers = require('../helpers/helpers')
resin = require('resin-sdk')
exports.set = permissions.user (params, options, done) ->
exports.set =
signature: 'note [note]'
description: 'set a device note'
help: '''
Use this command to set or update a device note.
If note command isn't passed, the tool attempts to read from `stdin`.
To view the notes, use $ resin device <id>.
Examples:
$ resin note "My useful note" --device 317
$ cat note.txt | resin note --device 317
'''
options: [
signature: 'device'
parameter: 'device'
description: 'device id'
alias: [ 'd', 'dev' ]
required: 'You have to specify a device'
]
action: permissions.user (params, options, done) ->
async.waterfall([
(callback) ->

48
lib/actions/os.coffee
View File

@ -6,8 +6,54 @@ ProgressBar = require('progress')
resin = require('resin-sdk')
permissions = require('../permissions/permissions')
exports.download = (params, options, done) ->
exports.download =
signature: 'os download <id>'
description: 'download device OS'
help: '''
Use this command to download the device OS configured to a specific network.
Ethernet:
You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".
Wifi:
You can setup the device OS to use wifi by setting the `--network` option to "wifi".
If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.
By default, this command saved the downloaded image into a resin specific directory.
You can save it to a custom location by specifying the `--output` option.
Examples:
$ resin os download 91 --network ethernet
$ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
'''
options: [
{
signature: 'network'
parameter: 'network'
description: 'network type'
alias: 'n'
}
{
signature: 'ssid'
parameter: 'ssid'
description: 'wifi ssid, if network is wifi'
alias: 's'
}
{
signature: 'key'
parameter: 'key'
description: 'wifi key, if network is wifi'
alias: 'k'
}
{
signature: 'output'
parameter: 'output'
description: 'output file'
alias: 'o'
}
]
action: (params, options, done) ->
osParams =
network: options.network
wifiSsid: options.ssid

14
lib/actions/preferences.coffee
View File

@ -3,7 +3,19 @@ url = require('url')
resin = require('resin-sdk')
permissions = require('../permissions/permissions')
exports.preferences = permissions.user ->
exports.preferences =
signature: 'preferences'
description: 'open preferences form'
help: '''
Use this command to open the preferences form.
In the future, we will allow changing all preferences directly from the terminal.
For now, we open your default web browser and point it to the web based preferences form.
Examples:
$ resin preferences
'''
action: permissions.user ->
preferencesUrl = resin.settings.get('urls.preferences')
absUrl = url.resolve(resin.settings.get('remoteUrl'), preferencesUrl)
open(absUrl)

567
lib/app.coffee
View File

@ -6,16 +6,6 @@ actions = require('./actions')
errors = require('./errors/errors')
plugin = require('./plugin/plugin')
capitano.command
signature: 'version'
description: 'output the version number'
action: actions.info.version
capitano.command
signature: 'help [command...]'
description: 'show help'
action: actions.help.help
capitano.command
signature: '*'
action: ->
@ -42,549 +32,62 @@ capitano.globalOption
description: 'disable colour highlighting'
boolean: true
yesOption =
signature: 'yes'
description: 'confirm non interactively'
boolean: true
alias: 'y'
# ---------- Info Module ----------
capitano.command(actions.info.version)
applicationOption =
signature: 'application'
parameter: 'application'
description: 'application id'
alias: [ 'a', 'app' ]
required: 'You have to specify an application'
deviceOption =
signature: 'device'
parameter: 'device'
description: 'device id'
alias: [ 'd', 'dev' ]
required: 'You have to specify a device'
# ---------- Help Module ----------
capitano.command(actions.help.help)
# ---------- Auth Module ----------
capitano.command
signature: 'login [credentials]'
description: 'login to resin.io'
help: '''
Use this command to login to your resin.io account.
You need to login before you can use most of the commands this tool provides.
You can pass your credentials as a colon separated string, or you can omit the
credentials, in which case the tool will present you with an interactive login form.
Examples:
$ resin login username:password
$ resin login
'''
action: actions.auth.login
capitano.command
signature: 'logout'
description: 'logout from resin.io'
help: '''
Use this command to logout from your resin.io account.o
Examples:
$ resin logout
'''
action: actions.auth.logout
capitano.command
signature: 'signup'
description: 'signup to resin.io'
help: '''
Use this command to signup for a resin.io account.
If signup is successful, you'll be logged in to your new user automatically.
TODO: We need to provide a non interactive way to use this command,
however it's not clear to me how to do it easily for now.
Examples:
$ resin signup
Email: me@mycompany.com
Username: johndoe
Password: ***********
$ resin whoami
johndoe
'''
action: actions.auth.signup
capitano.command
signature: 'whoami'
description: 'get current username'
help: '''
Use this command to find out the current logged in username.
Examples:
$ resin whoami
'''
action: actions.auth.whoami
capitano.command(actions.auth.login)
capitano.command(actions.auth.logout)
capitano.command(actions.auth.signup)
capitano.command(actions.auth.whoami)
# ---------- App Module ----------
capitano.command
signature: 'app create <name>'
description: 'create an application'
help: '''
Use this command to create a new resin.io application.
You can specify the application type with the `--type` option.
Otherwise, an interactive dropdown will be shown for you to select from.
You can see a list of supported device types with
$ resin devices supported
Examples:
$ resin app create MyApp
$ resin app create MyApp --type raspberry-pi
'''
action: actions.app.create
options: [
{
signature: 'type'
parameter: 'type'
description: 'application type'
alias: 't'
}
]
capitano.command
signature: 'apps'
description: 'list all applications'
help: '''
Use this command to list all your applications.
Notice this command only shows the most important bits of information for each app.
If you want detailed information, use resin app <id> instead.
Examples:
$ resin apps
'''
action: actions.app.list
capitano.command
signature: 'app <id>'
description: 'list a single application'
help: '''
Use this command to show detailed information for a single application.
Examples:
$ resin app 91
'''
action: actions.app.info
capitano.command
signature: 'app rm <id>'
description: 'remove an application'
help: '''
Use this command to remove a resin.io application.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin app rm 91
$ resin app rm 91 --yes
'''
action: actions.app.remove
options: [ yesOption ]
capitano.command
signature: 'app restart <id>'
description: 'restart an application'
help: '''
Use this command to restart all devices that belongs to a certain application.
Examples:
$ resin app restart 91
'''
action: actions.app.restart
capitano.command
signature: 'init <id>'
description: 'init an application'
help: '''
Use this command to associate a local project to an existing resin.io application.
The application should be a git repository before issuing this command.
Notice this command adds a `resin` git remote to your application.
Examples:
$ cd myApp && resin init 91
'''
action: actions.app.init
capitano.command(actions.app.create)
capitano.command(actions.app.list)
capitano.command(actions.app.info)
capitano.command(actions.app.remove)
capitano.command(actions.app.restart)
capitano.command(actions.app.init)
# ---------- Device Module ----------
capitano.command
signature: 'devices'
description: 'list all devices'
help: '''
Use this command to list all devices that belong to a certain application.
Examples:
$ resin devices --application 91
'''
action: actions.device.list
options: [ applicationOption ]
capitano.command
signature: 'devices supported'
description: 'list all supported devices'
help: '''
Use this command to get the list of all supported devices
Examples:
$ resin devices supported
'''
action: actions.device.supported
capitano.command
signature: 'device rename <id> [name]'
description: 'rename a resin device'
help: '''
Use this command to rename a device.
If you omit the name, you'll get asked for it interactively.
Examples:
$ resin device rename 317 MyPi
$ resin device rename 317
'''
action: actions.device.rename
capitano.command
signature: 'device <id>'
description: 'list a single device'
help: '''
Use this command to show information about a single device.
Examples:
$ resin device 317
'''
action: actions.device.info
capitano.command
signature: 'device rm <id>'
description: 'remove a device'
help: '''
Use this command to remove a device from resin.io.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin device rm 317
$ resin device rm 317 --yes
'''
action: actions.device.remove
options: [ yesOption ]
capitano.command
signature: 'device identify <uuid>'
description: 'identify a device with a UUID'
help: '''
Use this command to identify a device.
In the Raspberry Pi, the ACT led is blinked several times.
Examples:
$ resin device identify 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828
'''
action: actions.device.identify
capitano.command(actions.device.list)
capitano.command(actions.device.supported)
capitano.command(actions.device.rename)
capitano.command(actions.device.info)
capitano.command(actions.device.remove)
capitano.command(actions.device.identify)
# ---------- Device Module ----------
capitano.command
signature: 'note [note]'
description: 'set a device note'
help: '''
Use this command to set or update a device note.
If note command isn't passed, the tool attempts to read from `stdin`.
To view the notes, use $ resin device <id>.
Examples:
$ resin note "My useful note" --device 317
$ cat note.txt | resin note --device 317
'''
action: actions.notes.set
options: [ deviceOption ]
capitano.command(actions.notes.set)
# ---------- Preferences Module ----------
capitano.command
signature: 'preferences'
description: 'open preferences form'
help: '''
Use this command to open the preferences form.
In the future, we will allow changing all preferences directly from the terminal.
For now, we open your default web browser and point it to the web based preferences form.
Examples:
$ resin preferences
'''
action: actions.preferences.preferences
capitano.command(actions.preferences.preferences)
# ---------- Keys Module ----------
capitano.command
signature: 'keys'
description: 'list all ssh keys'
help: '''
Use this command to list all your SSH keys.
Examples:
$ resin keys
'''
action: actions.keys.list
capitano.command
signature: 'key add <name> [path]'
description: 'add a SSH key to resin.io'
help: '''
Use this command to associate a new SSH key with your account.
If `path` is omitted, the command will attempt
to read the SSH key from stdin.
Examples:
$ resin key add Main ~/.ssh/id_rsa.pub
$ cat ~/.ssh/id_rsa.pub | resin key add Main
'''
action: actions.keys.add
capitano.command
signature: 'key <id>'
description: 'list a single ssh key'
help: '''
Use this command to show information about a single SSH key.
Examples:
$ resin key 17
'''
action: actions.keys.info
capitano.command
signature: 'key rm <id>'
description: 'remove a ssh key'
help: '''
Use this command to remove a SSH key from resin.io.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin key rm 17
$ resin key rm 17 --yes
'''
action: actions.keys.remove
options: [ yesOption ]
capitano.command(actions.keys.list)
capitano.command(actions.keys.add)
capitano.command(actions.keys.info)
capitano.command(actions.keys.remove)
# ---------- Env Module ----------
capitano.command
signature: 'envs'
description: 'list all environment variables'
help: '''
Use this command to list all environment variables for a particular application.
Notice we will support per-device environment variables soon.
This command lists all custom environment variables set on the devices running
the application. If you want to see all environment variables, including private
ones used by resin, use the verbose option.
Example:
$ resin envs --application 91
$ resin envs --application 91 --verbose
'''
action: actions.env.list
options: [
applicationOption
{
signature: 'verbose'
description: 'show private environment variables'
boolean: true
alias: 'v'
}
]
capitano.command
signature: 'env add <key> [value]'
description: 'add an environment variable'
help: '''
Use this command to add an enviroment variable to an application.
You need to pass the `--application` option.
If value is omitted, the tool will attempt to use the variable's value
as defined in your host machine.
If the value is grabbed from the environment, a warning message will be printed.
Use `--quiet` to remove it.
Examples:
$ resin env add EDITOR vim -a 91
$ resin env add TERM -a 91
'''
options: [ applicationOption ]
action: actions.env.add
capitano.command
signature: 'env rename <id> <value>'
description: 'rename an environment variable'
help: '''
Use this command to rename an enviroment variable from an application.
Examples:
$ resin env rename 376 emacs
'''
action: actions.env.rename
capitano.command
signature: 'env rm <id>'
description: 'remove an environment variable'
help: '''
Use this command to remove an environment variable from an application.
Don't remove resin specific variables, as things might not work as expected.
Notice this command asks for confirmation interactively.
You can avoid this by passing the `--yes` boolean option.
Examples:
$ resin env rm 215
$ resin env rm 215 --yes
'''
action: actions.env.remove
options: [ yesOption ]
capitano.command(actions.env.list)
capitano.command(actions.env.add)
capitano.command(actions.env.rename)
capitano.command(actions.env.remove)
# ---------- Logs Module ----------
capitano.command
signature: 'logs <uuid>'
description: 'show device logs'
help: '''
Use this command to show logs for a specific device.
By default, the command prints all log messages and exit.
To limit the output to the n last lines, use the `--num` option along with a number.
This is similar to doing `resin logs <uuid> | tail -n X`.
To continuously stream output, and see new logs in real time, use the `--tail` option.
Note that for now you need to provide the whole UUID for this command to work correctly,
and the tool won't notice if you're using an invalid UUID.
This is due to some technical limitations that we plan to address soon.
Examples:
$ resin logs 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828
$ resin logs 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828 --num 20
$ resin logs 23c73a12e3527df55c60b9ce647640c1b7da1b32d71e6a39849ac0f00db828 --tail
'''
action: actions.logs.logs
options: [
{
signature: 'num'
parameter: 'num'
description: 'number of lines to display'
alias: 'n'
}
{
signature: 'tail'
description: 'continuously stream output'
boolean: true
alias: 't'
}
]
capitano.command(actions.logs.logs)
# ---------- OS Module ----------
capitano.command
signature: 'os download <id>'
description: 'download device OS'
help: '''
Use this command to download the device OS configured to a specific network.
Ethernet:
You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".
Wifi:
You can setup the device OS to use wifi by setting the `--network` option to "wifi".
If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.
By default, this command saved the downloaded image into a resin specific directory.
You can save it to a custom location by specifying the `--output` option.
Examples:
$ resin os download 91 --network ethernet
$ resin os download 91 --network wifi --ssid MyNetwork --key secreykey123
$ resin os download 91 --network ethernet --output ~/MyResinOS.zip
'''
action: actions.os.download
options: [
{
signature: 'network'
parameter: 'network'
description: 'network type'
alias: 'n'
}
{
signature: 'ssid'
parameter: 'ssid'
description: 'wifi ssid, if network is wifi'
alias: 's'
}
{
signature: 'key'
parameter: 'key'
description: 'wifi key, if network is wifi'
alias: 'k'
}
{
signature: 'output'
parameter: 'output'
description: 'output file'
alias: 'o'
}
]
capitano.command(actions.os.download)
# ---------- Examples Module ----------
capitano.command
signature: 'examples'
description: 'list all example applications'
help: '''
Use this command to list available example applications from resin.io
Example:
$ resin examples
'''
action: actions.examples.list
capitano.command
signature: 'example clone <id>'
description: 'clone an example application'
help: '''
Use this command to clone an example application to the current directory
This command outputs information about the cloning process.
Use `--quiet` to remove that output.
Example:
$ resin example clone 3
'''
action: actions.examples.clone
capitano.command
signature: 'example <id>'
description: 'list a single example application'
help: '''
Use this command to show information of a single example application
Example:
$ resin example 3
'''
action: actions.examples.info
capitano.command(actions.examples.list)
capitano.command(actions.examples.clone)
capitano.command(actions.examples.info)
try
for pluginPath in plugin.getPluginsPathsByGlob('resin-plugin-*')