ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-04-09 04:14:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

rebuild docs

Browse Source
This commit is contained in:
Eugene Mirotin 2017-06-12 13:21:12 +03:00
parent 2e7e033bb9
commit 4ac8cb1003
1 changed files with 57 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

59
doc/cli.markdown
View File

@ -103,8 +103,11 @@ environment variable (in the same standard URL format).
- OS
- [os versions <type>](#os-versions-60-type-62-)
- [os download <type>](#os-download-60-type-62-)
- [os build-config <image> <device-type>](#os-build-config-60-image-62-60-device-type-62-)
- [os configure <image> <uuid>](#os-configure-60-image-62-60-uuid-62-)
- [os available-drives](#os-available-drives)
- [os initialize <image>](#os-initialize-60-image-62-)
- Config
@ -477,6 +480,22 @@ confirm non interactively
enable advanced configuration
#### --os-version <os-version>
exact version number, or a valid semver range,
or 'latest' (includes pre-releases),
or 'default' (excludes pre-releases if at least one stable version is available),
or 'recommended' (excludes pre-releases, will fail if only pre-release versions are available),
or 'menu' (will show the interactive menu)
#### --drive, -d <drive>
the drive to write the image to, like /dev/sdb. Careful with this as you can erase your hard drive. Check `resin os available-drives` for available options.
#### --config <config>
stringified JSON with the device config, see `resin os build-config`
# Environment Variables
## envs
@ -813,6 +832,15 @@ device uuid
# OS
## os versions <type>
Use this command to show the available resinOS versions for a certain device type.
Check available types with `resin devices supported`
Example:
$ resin os versions raspberrypi3
## os download <type>
Use this command to download an unconfigured os image for a certain device type.
@ -848,9 +876,28 @@ or 'default' (excludes pre-releases if at least one stable version is available)
or 'recommended' (excludes pre-releases, will fail if only pre-release versions are available),
or 'menu' (will show the interactive menu)
## os build-config <image> <device-type>
Use this command to prebuild the OS config once and skip the interactive part of `resin os configure`.
Examples:
$ resin os build-config ../path/rpi3.img raspberrypi3 --output rpi3-config.json
$ resin os configure ../path/rpi3.img 7cf02a6 --config "$(cat rpi3-config.json)"
### Options
#### --advanced, -v
show advanced commands
#### --output, -o <output>
the path to the output JSON file
## os configure <image> <uuid>
Use this command to configure a previously download operating system image with a device.
Use this command to configure a previously downloaded operating system image for the specific device.
Examples:
@ -862,6 +909,14 @@ Examples:
show advanced commands
#### --config <config>
stringified JSON with the device config, see `resin os build-config`
## os available-drives
undefined
## os initialize <image>
Use this command to initialize a device with previously configured operating system image.
@ -885,7 +940,7 @@ device type (Check available types with `resin devices supported`)
#### --drive, -d <drive>
drive
drive to write the image to. Check `resin os available-drives` for available options.
# Config