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

Update the os configure examples to better explain --device-type

Browse Source 
Signed-off-by: Thodoris Greasidis <thodoris@balena.io>
This commit is contained in:
Thodoris Greasidis 2018-12-07 17:44:18 +02:00
parent 97d6a39677
commit 853d146457
2 changed files with 25 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
doc/cli.markdown
View File

@ -1072,12 +1072,16 @@ This command still supports the *deprecated* format where the UUID and optionall
are passed directly on the command line, but the recommended way is to pass either an --app or are passed directly on the command line, but the recommended way is to pass either an --app or
--device argument. The deprecated format will be remove in a future release. --device argument. The deprecated format will be remove in a future release.
In case that you want to configure an image for an application with mixed device types,
you can pass the --device-type argument along with --app to specify the target device type.
Examples: Examples:
$ balena os configure ../path/rpi.img --device 7cf02a6 $ balena os configure ../path/rpi3.img --device 7cf02a6
$ balena os configure ../path/rpi.img --device 7cf02a6 --device-api-key <existingDeviceKey> $ balena os configure ../path/rpi3.img --device 7cf02a6 --device-api-key <existingDeviceKey>
$ balena os configure ../path/rpi.img --app MyApp $ balena os configure ../path/rpi3.img --app MyApp
$ balena os configure ../path/rpi.img --app MyApp --version 2.12.7 $ balena os configure ../path/rpi3.img --app MyApp --version 2.12.7
$ balena os configure ../path/rpi3.img --app MyFinApp --device-type raspberrypi3
### Options ### Options
@ -1097,6 +1101,10 @@ device uuid
custom device key - note that this is only supported on balenaOS 2.0.3+ custom device key - note that this is only supported on balenaOS 2.0.3+
#### --deviceType &#60;device-type&#62;
device type slug
#### --version &#60;version&#62; #### --version &#60;version&#62;
a balenaOS version a balenaOS version
@ -1225,6 +1233,9 @@ This is interactive by default, but you can do this automatically without intera
by specifying an option for each question on the command line, if you know the questions by specifying an option for each question on the command line, if you know the questions
that will be asked for the relevant device type. that will be asked for the relevant device type.
In case that you want to configure an image for an application with mixed device types,
you can pass the --device-type argument along with --app to specify the target device type.
Examples: Examples:
$ balena config generate --device 7cf02a6 --version 2.12.7 $ balena config generate --device 7cf02a6 --version 2.12.7
@ -1232,6 +1243,7 @@ Examples:
$ balena config generate --device 7cf02a6 --version 2.12.7 --device-api-key <existingDeviceKey> $ balena config generate --device 7cf02a6 --version 2.12.7 --device-api-key <existingDeviceKey>
$ balena config generate --device 7cf02a6 --version 2.12.7 --output config.json $ balena config generate --device 7cf02a6 --version 2.12.7 --output config.json
$ balena config generate --app MyApp --version 2.12.7 $ balena config generate --app MyApp --version 2.12.7
$ balena config generate --app MyApp --version 2.12.7 --device-type fincm3
$ balena config generate --app MyApp --version 2.12.7 --output config.json $ balena config generate --app MyApp --version 2.12.7 --output config.json
$ balena config generate --app MyApp --version 2.12.7 --network wifi --wifiSsid mySsid --wifiKey abcdefgh --appUpdatePollInterval 1 $ balena config generate --app MyApp --version 2.12.7 --network wifi --wifiSsid mySsid --wifiKey abcdefgh --appUpdatePollInterval 1
@ -1253,6 +1265,10 @@ device uuid
custom device key - note that this is only supported on balenaOS 2.0.3+ custom device key - note that this is only supported on balenaOS 2.0.3+
#### --deviceType &#60;device-type&#62;
device type slug
#### --generate-device-api-key #### --generate-device-api-key
generate a fresh device key for the device generate a fresh device key for the device

10
lib/actions/os.coffee
View File

@ -219,11 +219,11 @@ exports.configure =
Examples: Examples:
$ balena os configure ../path/rpi.img --device 7cf02a6 $ balena os configure ../path/rpi3.img --device 7cf02a6
$ balena os configure ../path/rpi.img --device 7cf02a6 --device-api-key <existingDeviceKey> $ balena os configure ../path/rpi3.img --device 7cf02a6 --device-api-key <existingDeviceKey>
$ balena os configure ../path/rpi.img --app MyApp $ balena os configure ../path/rpi3.img --app MyApp
$ balena os configure ../path/rpi.img --app MyApp --version 2.12.7 $ balena os configure ../path/rpi3.img --app MyApp --version 2.12.7
$ balena os configure ../path/rpi.img --app MyApp --device-type fincm3 $ balena os configure ../path/rpi3.img --app MyFinApp --device-type raspberrypi3
''' '''
permission: 'user' permission: 'user'
options: [ options: [