mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-22 06:57:48 +00:00
Merge pull request #2197 from balena-io/device-local-mode-markdown
docs: Fix missing markdown docs for device `deactivate` and `local-mode`
This commit is contained in:
commit
1986c9339c
@ -59,8 +59,10 @@ const capitanoDoc = {
|
||||
'build/commands/devices/index.js',
|
||||
'build/commands/devices/supported.js',
|
||||
'build/commands/device/index.js',
|
||||
'build/commands/device/deactivate.js',
|
||||
'build/commands/device/identify.js',
|
||||
'build/commands/device/init.js',
|
||||
'build/commands/device/local-mode.js',
|
||||
'build/commands/device/move.js',
|
||||
'build/commands/device/os-update.js',
|
||||
'build/commands/device/public-url.js',
|
||||
|
@ -180,8 +180,10 @@ Users are encouraged to regularly update the balena CLI to the latest version.
|
||||
- [devices](#devices)
|
||||
- [devices supported](#devices-supported)
|
||||
- [device <uuid>](#device-uuid)
|
||||
- [device deactivate <uuid>](#device-deactivate-uuid)
|
||||
- [device identify <uuid>](#device-identify-uuid)
|
||||
- [device init](#device-init)
|
||||
- [device local-mode <uuid>](#device-local-mode-uuid)
|
||||
- [device move <uuid(s)>](#device-move-uuid-s)
|
||||
- [device os-update <uuid>](#device-os-update-uuid)
|
||||
- [device public-url <uuid>](#device-public-url-uuid)
|
||||
@ -706,6 +708,30 @@ the device uuid
|
||||
|
||||
### Options
|
||||
|
||||
## device deactivate <uuid>
|
||||
|
||||
Deactivate a device.
|
||||
|
||||
Note this command asks for confirmation interactively.
|
||||
You can avoid this by passing the `--yes` option.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena device deactivate 7cf02a6
|
||||
$ balena device deactivate 7cf02a6 --yes
|
||||
|
||||
### Arguments
|
||||
|
||||
#### UUID
|
||||
|
||||
the UUID of the device to be deactivated
|
||||
|
||||
### Options
|
||||
|
||||
#### -y, --yes
|
||||
|
||||
answer "yes" to all questions (non interactive use)
|
||||
|
||||
## device identify <uuid>
|
||||
|
||||
Identify a device by making the ACT LED blink (Raspberry Pi).
|
||||
@ -785,6 +811,38 @@ Check `balena util available-drives` for available options.
|
||||
|
||||
path to the config JSON file, see `balena os build-config`
|
||||
|
||||
## device local-mode <uuid>
|
||||
|
||||
Output current local mode status, or enable/disable local mode
|
||||
for specified device.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena device local-mode 23c73a1
|
||||
$ balena device local-mode 23c73a1 --enable
|
||||
$ balena device local-mode 23c73a1 --disable
|
||||
$ balena device local-mode 23c73a1 --status
|
||||
|
||||
### Arguments
|
||||
|
||||
#### UUID
|
||||
|
||||
the uuid of the device to manage
|
||||
|
||||
### Options
|
||||
|
||||
#### --enable
|
||||
|
||||
enable local mode
|
||||
|
||||
#### --disable
|
||||
|
||||
disable local mode
|
||||
|
||||
#### --status
|
||||
|
||||
output boolean indicating local mode status
|
||||
|
||||
## device move <uuid(s)>
|
||||
|
||||
Move one or more devices to another application.
|
||||
|
Loading…
Reference in New Issue
Block a user