From 853d1464578b18fc8f5978ff3c3ca11455f58deb Mon Sep 17 00:00:00 2001 From: Thodoris Greasidis Date: Fri, 7 Dec 2018 17:44:18 +0200 Subject: [PATCH] Update the os configure examples to better explain --device-type Signed-off-by: Thodoris Greasidis --- doc/cli.markdown | 24 ++++++++++++++++++++---- lib/actions/os.coffee | 10 +++++----- 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/doc/cli.markdown b/doc/cli.markdown index 771847e5..17177dbd 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -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 --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: - $ balena os configure ../path/rpi.img --device 7cf02a6 - $ balena os configure ../path/rpi.img --device 7cf02a6 --device-api-key - $ balena os configure ../path/rpi.img --app MyApp - $ balena os configure ../path/rpi.img --app MyApp --version 2.12.7 + $ balena os configure ../path/rpi3.img --device 7cf02a6 + $ balena os configure ../path/rpi3.img --device 7cf02a6 --device-api-key + $ balena os configure ../path/rpi3.img --app MyApp + $ balena os configure ../path/rpi3.img --app MyApp --version 2.12.7 + $ balena os configure ../path/rpi3.img --app MyFinApp --device-type raspberrypi3 ### Options @@ -1097,6 +1101,10 @@ device uuid custom device key - note that this is only supported on balenaOS 2.0.3+ +#### --deviceType <device-type> + +device type slug + #### --version <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 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: $ 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 $ 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 --device-type fincm3 $ 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 @@ -1253,6 +1265,10 @@ device uuid custom device key - note that this is only supported on balenaOS 2.0.3+ +#### --deviceType <device-type> + +device type slug + #### --generate-device-api-key generate a fresh device key for the device diff --git a/lib/actions/os.coffee b/lib/actions/os.coffee index 2fc453c5..c46dad12 100644 --- a/lib/actions/os.coffee +++ b/lib/actions/os.coffee @@ -219,11 +219,11 @@ exports.configure = Examples: - $ balena os configure ../path/rpi.img --device 7cf02a6 - $ balena os configure ../path/rpi.img --device 7cf02a6 --device-api-key - $ balena os configure ../path/rpi.img --app MyApp - $ balena os configure ../path/rpi.img --app MyApp --version 2.12.7 - $ balena os configure ../path/rpi.img --app MyApp --device-type fincm3 + $ balena os configure ../path/rpi3.img --device 7cf02a6 + $ balena os configure ../path/rpi3.img --device 7cf02a6 --device-api-key + $ balena os configure ../path/rpi3.img --app MyApp + $ balena os configure ../path/rpi3.img --app MyApp --version 2.12.7 + $ balena os configure ../path/rpi3.img --app MyFinApp --device-type raspberrypi3 ''' permission: 'user' options: [