From 7da9a800ccd2af0fbb051f1d95707e5d8623e227 Mon Sep 17 00:00:00 2001 From: Thomas Manning Date: Mon, 9 Nov 2020 06:13:06 +0000 Subject: [PATCH] Modify `os download` help to mention dev images Change-type: patch Signed-off-by: Thomas Manning --- doc/cli.markdown | 8 ++++++-- lib/commands/os/download.ts | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/doc/cli.markdown b/doc/cli.markdown index e59be7e9..de8dad59 100644 --- a/doc/cli.markdown +++ b/doc/cli.markdown @@ -1714,11 +1714,15 @@ versions for the given device type are pre-release). You can pass `--version menu` to pick the OS version from the interactive menu of all available versions. +To download a development image append `.dev` to the version or select from +the interactive menu. + Examples: $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img - $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version 1.24.1 - $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version ^1.20.0 + $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version 2.60.1+rev1 + $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version 2.60.1+rev1.dev + $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version ^2.60.0 $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version latest $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version default $ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version menu diff --git a/lib/commands/os/download.ts b/lib/commands/os/download.ts index b809a4b2..ac85ecaa 100644 --- a/lib/commands/os/download.ts +++ b/lib/commands/os/download.ts @@ -46,11 +46,15 @@ export default class OsDownloadCmd extends Command { You can pass \`--version menu\` to pick the OS version from the interactive menu of all available versions. + + To download a development image append \`.dev\` to the version or select from + the interactive menu. `; public static examples = [ '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img', - '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version 1.24.1', - '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version ^1.20.0', + '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version 2.60.1+rev1', + '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version 2.60.1+rev1.dev', + '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version ^2.60.0', '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version latest', '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version default', '$ balena os download raspberrypi3 -o ../foo/bar/raspberry-pi.img --version menu',