ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-02-22 02:06:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add missing example to device init

Browse Source
This commit is contained in:
Juan Cruz Viotti 2015-03-23 08:25:45 -04:00
parent 63b2b3feb6
commit f3b6f9d117
15 changed files with 31 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
build/actions/device.js
View File

@ -111,7 +111,7 @@
exports.init = { exports.init = {
signature: 'device init [device]', signature: 'device init [device]',
description: 'initialise a device with resin os', description: 'initialise a device with resin os',
help: 'Use this command to download the OS image of a certain application and write it to an SD Card.\n\nNote that this command requires admin privileges.\n\nIf `device` is omitted, you will be prompted to select a device interactively.\n\nNotice this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` boolean option.\n\nYou can quiet the progress bar by passing the `--quiet` boolean option.\n\nYou may have to unmount the device before attempting this operation.\n\nYou need to configure the network type and other settings:\n\nEthernet:\n You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".\n\nWifi:\n You can setup the device OS to use wifi by setting the `--network` option to "wifi".\n If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.\n\nYou can omit network related options to be asked about them interactively.\n\nExamples:\n\n $ resin device init --application 91\n $ resin device init --application 91 --network ethernet\n $ resin device init /dev/disk2 --application 91 --network wifi --ssid MyNetwork --key secret', help: 'Use this command to download the OS image of a certain application and write it to an SD Card.\n\nNote that this command requires admin privileges.\n\nIf `device` is omitted, you will be prompted to select a device interactively.\n\nNotice this command asks for confirmation interactively.\nYou can avoid this by passing the `--yes` boolean option.\n\nYou can quiet the progress bar by passing the `--quiet` boolean option.\n\nYou may have to unmount the device before attempting this operation.\n\nYou need to configure the network type and other settings:\n\nEthernet:\n You can setup the device OS to use ethernet by setting the `--network` option to "ethernet".\n\nWifi:\n You can setup the device OS to use wifi by setting the `--network` option to "wifi".\n If you set "network" to "wifi", you will need to specify the `--ssid` and `--key` option as well.\n\nYou can omit network related options to be asked about them interactively.\n\nExamples:\n\n $ resin device init\n $ resin device init --application 91\n $ resin device init --application 91 --network ethernet\n $ resin device init /dev/disk2 --application 91 --network wifi --ssid MyNetwork --key secret',
options: [commandOptions.optionalApplication, commandOptions.network, commandOptions.wifiSsid, commandOptions.wifiKey], options: [commandOptions.optionalApplication, commandOptions.network, commandOptions.wifiSsid, commandOptions.wifiKey],
permission: 'user', permission: 'user',
action: function(params, options, done) { action: function(params, options, done) {

6
doc/app/associate.markdown
View File

@ -1,4 +1,4 @@
# app associate <id> # app associate <name>
Use this command to associate a project directory with a resin application. Use this command to associate a project directory with a resin application.
@ -6,5 +6,5 @@ This command adds a 'resin' git remote to the directory and runs git init if nec
Examples: Examples:
$ resin app associate 91 $ resin app associate MyApp
$ resin app associate 91 --project my/app/directory $ resin app associate MyApp --project my/app/directory

4
doc/app/info.markdown
View File

@ -1,7 +1,7 @@
# app <id> # app <name>
Use this command to show detailed information for a single application. Use this command to show detailed information for a single application.
Examples: Examples:
$ resin app 91 $ resin app MyApp

2
doc/app/list.markdown
View File

@ -3,7 +3,7 @@
Use this command to list all your applications. Use this command to list all your applications.
Notice this command only shows the most important bits of information for each app. Notice this command only shows the most important bits of information for each app.
If you want detailed information, use resin app <id> instead. If you want detailed information, use resin app <name> instead.
Examples: Examples:

6
doc/app/remove.markdown
View File

@ -1,4 +1,4 @@
# app rm &#60;id&#62; # app rm &#60;name&#62;
Use this command to remove a resin.io application. Use this command to remove a resin.io application.
@ -7,8 +7,8 @@ You can avoid this by passing the `--yes` boolean option.
Examples: Examples:
$ resin app rm 91 $ resin app rm MyApp
$ resin app rm 91 --yes $ resin app rm MyApp --yes
## Options ## Options

4
doc/app/restart.markdown
View File

@ -1,7 +1,7 @@
# app restart &#60;id&#62; # app restart &#60;name&#62;
Use this command to restart all devices that belongs to a certain application. Use this command to restart all devices that belongs to a certain application.
Examples: Examples:
$ resin app restart 91 $ resin app restart MyApp

4
doc/device/info.markdown
View File

@ -1,7 +1,7 @@
# device &#60;id&#62; # device &#60;name&#62;
Use this command to show information about a single device. Use this command to show information about a single device.
Examples: Examples:
$ resin device 317 $ resin device MyDevice

3
doc/device/init.markdown
View File

@ -26,6 +26,7 @@ You can omit network related options to be asked about them interactively.
Examples: Examples:
$ resin device init
$ resin device init --application 91 $ resin device init --application 91
$ resin device init --application 91 --network ethernet $ resin device init --application 91 --network ethernet
$ resin device init /dev/disk2 --application 91 --network wifi --ssid MyNetwork --key secret $ resin device init /dev/disk2 --application 91 --network wifi --ssid MyNetwork --key secret
@ -34,7 +35,7 @@ Examples:
### --application, --a,app, --a,app &#60;application&#62; ### --application, --a,app, --a,app &#60;application&#62;
application id application name
### --network, -n &#60;network&#62; ### --network, -n &#60;network&#62;

4
doc/device/list.markdown
View File

@ -4,10 +4,10 @@ Use this command to list all devices that belong to a certain application.
Examples: Examples:
$ resin devices --application 91 $ resin devices --application MyApp
## Options ## Options
### --application, --a,app, --a,app &#60;application&#62; ### --application, --a,app, --a,app &#60;application&#62;
application id application name

6
doc/device/remove.markdown
View File

@ -1,4 +1,4 @@
# device rm &#60;id&#62; # device rm &#60;name&#62;
Use this command to remove a device from resin.io. Use this command to remove a device from resin.io.
@ -7,8 +7,8 @@ You can avoid this by passing the `--yes` boolean option.
Examples: Examples:
$ resin device rm 317 $ resin device rm MyDevice
$ resin device rm 317 --yes $ resin device rm MyDevice --yes
## Options ## Options

6
doc/device/rename.markdown
View File

@ -1,4 +1,4 @@
# device rename &#60;id&#62; [name] # device rename &#60;name&#62; [newName]
Use this command to rename a device. Use this command to rename a device.
@ -6,5 +6,5 @@ If you omit the name, you'll get asked for it interactively.
Examples: Examples:
$ resin device rename 317 MyPi $ resin device rename MyDevice MyPi
$ resin device rename 317 $ resin device rename MyDevice

2
doc/environment-variables/add.markdown
View File

@ -19,4 +19,4 @@ Examples:
### --application, --a,app, --a,app &#60;application&#62; ### --application, --a,app, --a,app &#60;application&#62;
application id application name

2
doc/environment-variables/list.markdown
View File

@ -16,7 +16,7 @@ Example:
### --application, --a,app, --a,app &#60;application&#62; ### --application, --a,app, --a,app &#60;application&#62;
application id application name
### --verbose, -v ### --verbose, -v

8
doc/notes/set.markdown
View File

@ -4,15 +4,15 @@ Use this command to set or update a device note.
If note command isn't passed, the tool attempts to read from `stdin`. If note command isn't passed, the tool attempts to read from `stdin`.
To view the notes, use $ resin device <id>. To view the notes, use $ resin device <name>.
Examples: Examples:
$ resin note "My useful note" --device 317 $ resin note "My useful note" --device MyDevice
$ cat note.txt | resin note --device 317 $ cat note.txt | resin note --device MyDevice
## Options ## Options
### --device, --d,dev, --d,dev &#60;device&#62; ### --device, --d,dev, --d,dev &#60;device&#62;
device id device name

1
lib/actions/device.coffee
View File

@ -177,6 +177,7 @@ exports.init =
Examples: Examples:
$ resin device init
$ resin device init --application 91 $ resin device init --application 91
$ resin device init --application 91 --network ethernet $ resin device init --application 91 --network ethernet
$ resin device init /dev/disk2 --application 91 --network wifi --ssid MyNetwork --key secret $ resin device init /dev/disk2 --application 91 --network wifi --ssid MyNetwork --key secret