mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-18 21:27:51 +00:00
Throw error if command directory rules not followed
Signed-off-by: Vipul Gupta (@vipulgupta2048) <vipulgupta2048@gmail.com>
This commit is contained in:
Vipul Gupta (@vipulgupta2048)
parent
0711eefb7c
commit
99094dbfda
@ -15,7 +15,7 @@
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
import type { JsonVersions } from '../lib/commands/version';
|
||||
import type { JsonVersions } from '../lib/commands/help/version';
|
||||
|
||||
import { run as oclifRun } from '@oclif/core';
|
||||
import * as archiver from 'archiver';
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
|
||||
import * as path from 'path';
|
||||
import { MarkdownFileParser } from './utils';
|
||||
import { globSync } from 'glob';
|
||||
import { GlobSync } from 'glob';
|
||||
|
||||
/**
|
||||
* This is the skeleton of CLI documentation/reference web page at:
|
||||
@ -68,12 +68,26 @@ const commandHeadings: { [key: string]: string } = {
|
||||
};
|
||||
|
||||
// Fetch all available commands
|
||||
const allCommandsPaths = globSync('build/commands/**/*.js', {
|
||||
const allCommandsPaths = new GlobSync('build/commands/**/*.js', {
|
||||
ignore: 'build/commands/internal/**',
|
||||
});
|
||||
}).found;
|
||||
|
||||
// Throw error if any commands found outside of command directories
|
||||
//
|
||||
const illegalCommandPaths = allCommandsPaths.filter((commandPath: string) =>
|
||||
/^build\/commands\/[^/]+\.js$/.test(commandPath),
|
||||
);
|
||||
|
||||
if (illegalCommandPaths.length !== 0) {
|
||||
throw new Error(
|
||||
`Found the following commands without a command directory: ${illegalCommandPaths}\n
|
||||
To resolve this error, move the respective commands to their resource directories or create new ones.\n
|
||||
Refer to the automation/capitanodoc/capitanodoc.ts file for more information.`,
|
||||
);
|
||||
}
|
||||
|
||||
// Docs config template
|
||||
let capitanoDoc: Documentation = {
|
||||
const capitanoDoc: Documentation = {
|
||||
title: 'balena CLI Documentation',
|
||||
introduction: '',
|
||||
categories: [],
|
||||
@ -101,7 +115,7 @@ for (const commandPath of allCommandsPaths) {
|
||||
|
||||
// Sort Category titles alhpabetically
|
||||
capitanoDoc.categories = capitanoDoc.categories.sort((a, b) =>
|
||||
a.title.localeCompare(b.title),
|
||||
a.title.localeCompare(b.title),
|
||||
);
|
||||
|
||||
// Sort Category file paths alhpabetically
|
||||
@ -109,7 +123,7 @@ capitanoDoc.categories.forEach((category) => {
|
||||
category.files.sort((a, b) => a.localeCompare(b));
|
||||
});
|
||||
|
||||
// TODO: Generate an error if commands are not in their folder
|
||||
console.log(capitanoDoc.categories);
|
||||
|
||||
/**
|
||||
* Modify and return the `capitanoDoc` object above in order to generate the
|
||||
|
||||
@ -8,21 +8,27 @@ _balena() {
|
||||
local context state line curcontext="$curcontext"
|
||||
|
||||
# Valid top-level completions
|
||||
main_commands=( build deploy envs fleets join keys leave login logout logs note orgs preload push releases scan settings ssh support tags tunnel version whoami api-key api-keys app block config device device devices env fleet fleet internal key key local os release release tag util )
|
||||
main_commands=( api-key api-keys app auth block config deploy deploy device device devices env envs fleet fleet fleets help internal key key keys local logs network notes orgs os platform preload push release release releases settings support tag tags util )
|
||||
# Sub-completions
|
||||
api_key_cmds=( generate revoke )
|
||||
app_cmds=( create )
|
||||
auth_cmds=( login logout whoami )
|
||||
block_cmds=( create )
|
||||
config_cmds=( generate inject read reconfigure write )
|
||||
deploy_cmds=( build )
|
||||
device_cmds=( deactivate identify init local-mode move os-update pin public-url purge reboot register rename restart rm shutdown start-service stop-service track-fleet )
|
||||
devices_cmds=( supported )
|
||||
env_cmds=( add rename rm )
|
||||
fleet_cmds=( create pin purge rename restart rm track-latest )
|
||||
help_cmds=( version )
|
||||
internal_cmds=( osinit )
|
||||
key_cmds=( add rm )
|
||||
local_cmds=( configure flash )
|
||||
network_cmds=( scan ssh tunnel )
|
||||
os_cmds=( build-config configure download initialize versions )
|
||||
platform_cmds=( join leave )
|
||||
release_cmds=( finalize invalidate validate )
|
||||
support_cmds=( support )
|
||||
tag_cmds=( rm set )
|
||||
|
||||
|
||||
@ -48,12 +54,18 @@ _balena_sec_cmds() {
|
||||
"app")
|
||||
_describe -t app_cmds 'app_cmd' app_cmds "$@" && ret=0
|
||||
;;
|
||||
"auth")
|
||||
_describe -t auth_cmds 'auth_cmd' auth_cmds "$@" && ret=0
|
||||
;;
|
||||
"block")
|
||||
_describe -t block_cmds 'block_cmd' block_cmds "$@" && ret=0
|
||||
;;
|
||||
"config")
|
||||
_describe -t config_cmds 'config_cmd' config_cmds "$@" && ret=0
|
||||
;;
|
||||
"deploy")
|
||||
_describe -t deploy_cmds 'deploy_cmd' deploy_cmds "$@" && ret=0
|
||||
;;
|
||||
"device")
|
||||
_describe -t device_cmds 'device_cmd' device_cmds "$@" && ret=0
|
||||
;;
|
||||
@ -66,6 +78,9 @@ _balena_sec_cmds() {
|
||||
"fleet")
|
||||
_describe -t fleet_cmds 'fleet_cmd' fleet_cmds "$@" && ret=0
|
||||
;;
|
||||
"help")
|
||||
_describe -t help_cmds 'help_cmd' help_cmds "$@" && ret=0
|
||||
;;
|
||||
"internal")
|
||||
_describe -t internal_cmds 'internal_cmd' internal_cmds "$@" && ret=0
|
||||
;;
|
||||
@ -75,12 +90,21 @@ _balena_sec_cmds() {
|
||||
"local")
|
||||
_describe -t local_cmds 'local_cmd' local_cmds "$@" && ret=0
|
||||
;;
|
||||
"network")
|
||||
_describe -t network_cmds 'network_cmd' network_cmds "$@" && ret=0
|
||||
;;
|
||||
"os")
|
||||
_describe -t os_cmds 'os_cmd' os_cmds "$@" && ret=0
|
||||
;;
|
||||
"platform")
|
||||
_describe -t platform_cmds 'platform_cmd' platform_cmds "$@" && ret=0
|
||||
;;
|
||||
"release")
|
||||
_describe -t release_cmds 'release_cmd' release_cmds "$@" && ret=0
|
||||
;;
|
||||
"support")
|
||||
_describe -t support_cmds 'support_cmd' support_cmds "$@" && ret=0
|
||||
;;
|
||||
"tag")
|
||||
_describe -t tag_cmds 'tag_cmd' tag_cmds "$@" && ret=0
|
||||
;;
|
||||
|
||||
@ -7,21 +7,27 @@ _balena_complete()
|
||||
local cur prev
|
||||
|
||||
# Valid top-level completions
|
||||
main_commands="build deploy envs fleets join keys leave login logout logs note orgs preload push releases scan settings ssh support tags tunnel version whoami api-key api-keys app block config device device devices env fleet fleet internal key key local os release release tag util"
|
||||
main_commands="api-key api-keys app auth block config deploy deploy device device devices env envs fleet fleet fleets help internal key key keys local logs network notes orgs os platform preload push release release releases settings support tag tags util"
|
||||
# Sub-completions
|
||||
api_key_cmds="generate revoke"
|
||||
app_cmds="create"
|
||||
auth_cmds="login logout whoami"
|
||||
block_cmds="create"
|
||||
config_cmds="generate inject read reconfigure write"
|
||||
deploy_cmds="build"
|
||||
device_cmds="deactivate identify init local-mode move os-update pin public-url purge reboot register rename restart rm shutdown start-service stop-service track-fleet"
|
||||
devices_cmds="supported"
|
||||
env_cmds="add rename rm"
|
||||
fleet_cmds="create pin purge rename restart rm track-latest"
|
||||
help_cmds="version"
|
||||
internal_cmds="osinit"
|
||||
key_cmds="add rm"
|
||||
local_cmds="configure flash"
|
||||
network_cmds="scan ssh tunnel"
|
||||
os_cmds="build-config configure download initialize versions"
|
||||
platform_cmds="join leave"
|
||||
release_cmds="finalize invalidate validate"
|
||||
support_cmds="support"
|
||||
tag_cmds="rm set"
|
||||
|
||||
|
||||
@ -42,12 +48,18 @@ _balena_complete()
|
||||
app)
|
||||
COMPREPLY=( $(compgen -W "$app_cmds" -- $cur) )
|
||||
;;
|
||||
auth)
|
||||
COMPREPLY=( $(compgen -W "$auth_cmds" -- $cur) )
|
||||
;;
|
||||
block)
|
||||
COMPREPLY=( $(compgen -W "$block_cmds" -- $cur) )
|
||||
;;
|
||||
config)
|
||||
COMPREPLY=( $(compgen -W "$config_cmds" -- $cur) )
|
||||
;;
|
||||
deploy)
|
||||
COMPREPLY=( $(compgen -W "$deploy_cmds" -- $cur) )
|
||||
;;
|
||||
device)
|
||||
COMPREPLY=( $(compgen -W "$device_cmds" -- $cur) )
|
||||
;;
|
||||
@ -60,6 +72,9 @@ _balena_complete()
|
||||
fleet)
|
||||
COMPREPLY=( $(compgen -W "$fleet_cmds" -- $cur) )
|
||||
;;
|
||||
help)
|
||||
COMPREPLY=( $(compgen -W "$help_cmds" -- $cur) )
|
||||
;;
|
||||
internal)
|
||||
COMPREPLY=( $(compgen -W "$internal_cmds" -- $cur) )
|
||||
;;
|
||||
@ -69,12 +84,21 @@ _balena_complete()
|
||||
local)
|
||||
COMPREPLY=( $(compgen -W "$local_cmds" -- $cur) )
|
||||
;;
|
||||
network)
|
||||
COMPREPLY=( $(compgen -W "$network_cmds" -- $cur) )
|
||||
;;
|
||||
os)
|
||||
COMPREPLY=( $(compgen -W "$os_cmds" -- $cur) )
|
||||
;;
|
||||
platform)
|
||||
COMPREPLY=( $(compgen -W "$platform_cmds" -- $cur) )
|
||||
;;
|
||||
release)
|
||||
COMPREPLY=( $(compgen -W "$release_cmds" -- $cur) )
|
||||
;;
|
||||
support)
|
||||
COMPREPLY=( $(compgen -W "$support_cmds" -- $cur) )
|
||||
;;
|
||||
tag)
|
||||
COMPREPLY=( $(compgen -W "$tag_cmds" -- $cur) )
|
||||
;;
|
||||
|
||||
@ -1,3 +1,168 @@
|
||||
[
|
||||
{
|
||||
title: 'API Key',
|
||||
files: [
|
||||
'build/commands/api-key/generate.js',
|
||||
'build/commands/api-key/revoke.js'
|
||||
]
|
||||
},
|
||||
{ title: 'API Keys', files: [ 'build/commands/api-keys/index.js' ] },
|
||||
{ title: 'App', files: [ 'build/commands/app/create.js' ] },
|
||||
{
|
||||
title: 'Authentication',
|
||||
files: [
|
||||
'build/commands/auth/login.js',
|
||||
'build/commands/auth/logout.js',
|
||||
'build/commands/auth/whoami.js'
|
||||
]
|
||||
},
|
||||
{ title: 'Block', files: [ 'build/commands/block/create.js' ] },
|
||||
{
|
||||
title: 'Config',
|
||||
files: [
|
||||
'build/commands/config/generate.js',
|
||||
'build/commands/config/inject.js',
|
||||
'build/commands/config/read.js',
|
||||
'build/commands/config/reconfigure.js',
|
||||
'build/commands/config/write.js'
|
||||
]
|
||||
},
|
||||
{
|
||||
title: 'Deploy',
|
||||
files: [
|
||||
'build/commands/deploy/build.js',
|
||||
'build/commands/deploy/index.js'
|
||||
]
|
||||
},
|
||||
{
|
||||
title: 'Device',
|
||||
files: [
|
||||
'build/commands/device/deactivate.js',
|
||||
'build/commands/device/identify.js',
|
||||
'build/commands/device/index.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/pin.js',
|
||||
'build/commands/device/public-url.js',
|
||||
'build/commands/device/purge.js',
|
||||
'build/commands/device/reboot.js',
|
||||
'build/commands/device/register.js',
|
||||
'build/commands/device/rename.js',
|
||||
'build/commands/device/restart.js',
|
||||
'build/commands/device/rm.js',
|
||||
'build/commands/device/shutdown.js',
|
||||
'build/commands/device/start-service.js',
|
||||
'build/commands/device/stop-service.js',
|
||||
'build/commands/device/track-fleet.js'
|
||||
]
|
||||
},
|
||||
{
|
||||
title: 'Devices',
|
||||
files: [
|
||||
'build/commands/devices/index.js',
|
||||
'build/commands/devices/supported.js'
|
||||
]
|
||||
},
|
||||
{
|
||||
title: 'Environment Variable',
|
||||
files: [
|
||||
'build/commands/env/add.js',
|
||||
'build/commands/env/rename.js',
|
||||
'build/commands/env/rm.js'
|
||||
]
|
||||
},
|
||||
{
|
||||
title: 'Environment Variables',
|
||||
files: [ 'build/commands/envs/index.js' ]
|
||||
},
|
||||
{
|
||||
title: 'Fleet',
|
||||
files: [
|
||||
'build/commands/fleet/create.js',
|
||||
'build/commands/fleet/index.js',
|
||||
'build/commands/fleet/pin.js',
|
||||
'build/commands/fleet/purge.js',
|
||||
'build/commands/fleet/rename.js',
|
||||
'build/commands/fleet/restart.js',
|
||||
'build/commands/fleet/rm.js',
|
||||
'build/commands/fleet/track-latest.js'
|
||||
]
|
||||
},
|
||||
{ title: 'Fleets', files: [ 'build/commands/fleets/index.js' ] },
|
||||
{
|
||||
title: 'Help and Version',
|
||||
files: [ 'build/commands/help/version.js' ]
|
||||
},
|
||||
{
|
||||
title: 'Local',
|
||||
files: [
|
||||
'build/commands/local/configure.js',
|
||||
'build/commands/local/flash.js'
|
||||
]
|
||||
},
|
||||
{ title: 'Logs', files: [ 'build/commands/logs/index.js' ] },
|
||||
{
|
||||
title: 'Network',
|
||||
files: [
|
||||
'build/commands/network/scan.js',
|
||||
'build/commands/network/ssh.js',
|
||||
'build/commands/network/tunnel.js'
|
||||
]
|
||||
},
|
||||
{ title: 'Notes', files: [ 'build/commands/notes/index.js' ] },
|
||||
{ title: 'Organizations', files: [ 'build/commands/orgs/index.js' ] },
|
||||
{
|
||||
title: 'OS',
|
||||
files: [
|
||||
'build/commands/os/build-config.js',
|
||||
'build/commands/os/configure.js',
|
||||
'build/commands/os/download.js',
|
||||
'build/commands/os/initialize.js',
|
||||
'build/commands/os/versions.js'
|
||||
]
|
||||
},
|
||||
{
|
||||
title: 'Platform',
|
||||
files: [
|
||||
'build/commands/platform/join.js',
|
||||
'build/commands/platform/leave.js'
|
||||
]
|
||||
},
|
||||
{ title: 'Preload', files: [ 'build/commands/preload/index.js' ] },
|
||||
{ title: 'Push', files: [ 'build/commands/push/index.js' ] },
|
||||
{
|
||||
title: 'Release',
|
||||
files: [
|
||||
'build/commands/release/finalize.js',
|
||||
'build/commands/release/index.js',
|
||||
'build/commands/release/invalidate.js',
|
||||
'build/commands/release/validate.js'
|
||||
]
|
||||
},
|
||||
{ title: 'Releases', files: [ 'build/commands/releases/index.js' ] },
|
||||
{ title: 'Settings', files: [ 'build/commands/settings/index.js' ] },
|
||||
{
|
||||
title: 'SSH Key',
|
||||
files: [
|
||||
'build/commands/key/add.js',
|
||||
'build/commands/key/index.js',
|
||||
'build/commands/key/rm.js'
|
||||
]
|
||||
},
|
||||
{ title: 'SSH Keys', files: [ 'build/commands/keys/index.js' ] },
|
||||
{ title: 'Support', files: [ 'build/commands/support/support.js' ] },
|
||||
{
|
||||
title: 'Tag',
|
||||
files: [ 'build/commands/tag/rm.js', 'build/commands/tag/set.js' ]
|
||||
},
|
||||
{ title: 'Tags', files: [ 'build/commands/tags/index.js' ] },
|
||||
{
|
||||
title: 'Utilities',
|
||||
files: [ 'build/commands/util/available-drives.js' ]
|
||||
}
|
||||
]
|
||||
# balena CLI Documentation
|
||||
|
||||
The balena CLI is a Command Line Interface for [balenaCloud](https://www.balena.io/cloud/) or
|
||||
@ -162,12 +327,12 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
|
||||
- API Key
|
||||
|
||||
- [api-keys](#api-keys)
|
||||
- [api-key generate <name>](#api-key-generate-name)
|
||||
- [api-key revoke <ids>](#api-key-revoke-ids)
|
||||
|
||||
- API Keys
|
||||
|
||||
- [api-key generate <name>](#api-key-generate-name)
|
||||
- [api-key revoke <ids>](#api-key-revoke-ids)
|
||||
- [api-keys](#api-keys)
|
||||
|
||||
- App
|
||||
|
||||
@ -181,7 +346,7 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
|
||||
- Block
|
||||
|
||||
- [app create <name>](#app-create-name)
|
||||
- [block create <name>](#block-create-name)
|
||||
|
||||
- Config
|
||||
|
||||
@ -214,9 +379,9 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
- [device restart <uuid>](#device-restart-uuid)
|
||||
- [device rm <uuid(s)>](#device-rm-uuid-s)
|
||||
- [device shutdown <uuid>](#device-shutdown-uuid)
|
||||
- [device track-fleet <uuid>](#device-track-fleet-uuid)
|
||||
- [device start-service <uuid>](#device-start-service-uuid)
|
||||
- [device stop-service <uuid>](#device-stop-service-uuid)
|
||||
- [device track-fleet <uuid>](#device-track-fleet-uuid)
|
||||
|
||||
- Devices
|
||||
|
||||
@ -250,7 +415,6 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
|
||||
- Help and Version
|
||||
|
||||
- [help [command]](#help-command)
|
||||
- [version](#version)
|
||||
|
||||
- Local
|
||||
@ -284,6 +448,11 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
- [os configure <image>](#os-configure-image)
|
||||
- [os initialize <image>](#os-initialize-image)
|
||||
|
||||
- Platform
|
||||
|
||||
- [join [deviceiporhostname]](#join-deviceiporhostname)
|
||||
- [leave [deviceiporhostname]](#leave-deviceiporhostname)
|
||||
|
||||
- Preload
|
||||
|
||||
- [preload <image>](#preload-image)
|
||||
@ -292,11 +461,6 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
|
||||
- [push <fleetordevice>](#push-fleetordevice)
|
||||
|
||||
- Platform
|
||||
|
||||
- [join [deviceiporhostname]](#join-deviceiporhostname)
|
||||
- [leave [deviceiporhostname]](#leave-deviceiporhostname)
|
||||
|
||||
- Release
|
||||
|
||||
- [release finalize <commitorid>](#release-finalize-commitorid)
|
||||
@ -312,10 +476,6 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
|
||||
- [settings](#settings)
|
||||
|
||||
- Support
|
||||
|
||||
- [support <action>](#support-action)
|
||||
|
||||
- SSH Key
|
||||
|
||||
- [key add <name> [path]](#key-add-name-path)
|
||||
@ -326,7 +486,11 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
|
||||
- [keys](#keys)
|
||||
|
||||
- Tags
|
||||
- Support
|
||||
|
||||
- [support <action>](#support-action)
|
||||
|
||||
- Tag
|
||||
|
||||
- [tag rm <tagkey>](#tag-rm-tagkey)
|
||||
- [tag set <tagkey> [value]](#tag-set-tagkey-value)
|
||||
@ -341,28 +505,6 @@ are encouraged to regularly update the balena CLI to the latest version.
|
||||
|
||||
# API Key
|
||||
|
||||
## api-keys
|
||||
|
||||
Print a list of balenaCloud API keys.
|
||||
|
||||
Print a list of balenaCloud API keys for the current user or for a specific fleet with the `--fleet` option.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena api-keys
|
||||
|
||||
### Options
|
||||
|
||||
#### -u, --user
|
||||
|
||||
show API keys for your user
|
||||
|
||||
#### -f, --fleet FLEET
|
||||
|
||||
fleet name or slug (preferred)
|
||||
|
||||
# API Keys
|
||||
|
||||
## api-key generate <name>
|
||||
|
||||
Generate a new balenaCloud API key for the current user, with the given
|
||||
@ -403,6 +545,28 @@ the API key ids
|
||||
|
||||
### Options
|
||||
|
||||
# API Keys
|
||||
|
||||
## api-keys
|
||||
|
||||
Print a list of balenaCloud API keys.
|
||||
|
||||
Print a list of balenaCloud API keys for the current user or for a specific fleet with the `--fleet` option.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena api-keys
|
||||
|
||||
### Options
|
||||
|
||||
#### -u, --user
|
||||
|
||||
show API keys for your user
|
||||
|
||||
#### -f, --fleet FLEET
|
||||
|
||||
fleet name or slug (preferred)
|
||||
|
||||
# App
|
||||
|
||||
## app create <name>
|
||||
@ -527,16 +691,16 @@ Examples:
|
||||
|
||||
# Block
|
||||
|
||||
## app create <name>
|
||||
## block create <name>
|
||||
|
||||
Create a new balena app.
|
||||
Create a new balena block.
|
||||
|
||||
You can specify the organization the app should belong to using
|
||||
You can specify the organization the block should belong to using
|
||||
the `--organization` option. The organization's handle, not its name,
|
||||
should be provided. Organization handles can be listed with the
|
||||
`balena orgs` command.
|
||||
|
||||
The app's default device type is specified with the `--type` option.
|
||||
The block's default device type is specified with the `--type` option.
|
||||
The `balena devices supported` command can be used to list the available
|
||||
device types.
|
||||
|
||||
@ -548,25 +712,25 @@ type and organization.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena app create MyApp
|
||||
$ balena app create MyApp --organization mmyorg
|
||||
$ balena app create MyApp -o myorg --type raspberry-pi
|
||||
$ balena block create MyBlock
|
||||
$ balena block create MyBlock --organization mmyorg
|
||||
$ balena block create MyBlock -o myorg --type raspberry-pi
|
||||
|
||||
### Arguments
|
||||
|
||||
#### NAME
|
||||
|
||||
app name
|
||||
block name
|
||||
|
||||
### Options
|
||||
|
||||
#### -o, --organization ORGANIZATION
|
||||
|
||||
handle of the organization the app should belong to
|
||||
handle of the organization the block should belong to
|
||||
|
||||
#### -t, --type TYPE
|
||||
|
||||
app device type (Check available types with `balena devices supported`)
|
||||
block device type (Check available types with `balena devices supported`)
|
||||
|
||||
# Config
|
||||
|
||||
@ -1706,22 +1870,6 @@ the uuid of the device to shutdown
|
||||
|
||||
force action if the update lock is set
|
||||
|
||||
## device track-fleet <uuid>
|
||||
|
||||
Make a device track the fleet's pinned release.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena device track-fleet 7cf02a6
|
||||
|
||||
### Arguments
|
||||
|
||||
#### UUID
|
||||
|
||||
the uuid of the device to make track the fleet's release
|
||||
|
||||
### Options
|
||||
|
||||
## device start-service <uuid>
|
||||
|
||||
Start containers on a device.
|
||||
@ -1770,6 +1918,22 @@ comma-separated list (no blank spaces) of service names
|
||||
|
||||
### Options
|
||||
|
||||
## device track-fleet <uuid>
|
||||
|
||||
Make a device track the fleet's pinned release.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena device track-fleet 7cf02a6
|
||||
|
||||
### Arguments
|
||||
|
||||
#### UUID
|
||||
|
||||
the uuid of the device to make track the fleet's release
|
||||
|
||||
### Options
|
||||
|
||||
# Devices
|
||||
|
||||
## devices
|
||||
@ -2403,28 +2567,6 @@ field to sort by (prepend '-' for descending order)
|
||||
|
||||
# Help and Version
|
||||
|
||||
## help [command]
|
||||
|
||||
List balena commands, or get detailed help for a specific command.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena help
|
||||
$ balena help login
|
||||
$ balena help os download
|
||||
|
||||
### Arguments
|
||||
|
||||
#### COMMAND
|
||||
|
||||
command to show help for
|
||||
|
||||
### Options
|
||||
|
||||
#### --v, --verbose
|
||||
|
||||
show additional commands
|
||||
|
||||
## version
|
||||
|
||||
Display version information for the balena CLI and/or Node.js. Note that the
|
||||
@ -3033,6 +3175,87 @@ Check `balena util available-drives` for available options.
|
||||
|
||||
answer "yes" to all questions (non interactive use)
|
||||
|
||||
# Platform
|
||||
|
||||
## join [deviceIpOrHostname]
|
||||
|
||||
Move a local device to a fleet on another balena server, causing
|
||||
the device to "join" the new server. The device must be running balenaOS.
|
||||
|
||||
For example, you could provision a device against an openBalena installation
|
||||
where you perform end-to-end tests and then move it to balenaCloud when it's
|
||||
ready for production.
|
||||
|
||||
To move a device between fleets on the same server, use the
|
||||
`balena device move` command instead of `balena join`.
|
||||
|
||||
If you don't specify a device hostname or IP, this command will automatically
|
||||
scan the local network for balenaOS devices and prompt you to select one
|
||||
from an interactive picker. This may require administrator/root privileges.
|
||||
Likewise, if the fleet option is not provided then a picker will be shown.
|
||||
|
||||
Fleets may be specified by fleet name or slug. Fleet slugs are
|
||||
the recommended option, as they are unique and unambiguous. Slugs can be
|
||||
listed with the `balena fleets` command. Note that slugs may change if the
|
||||
fleet is renamed. Fleet names are not unique and may result in "Fleet is
|
||||
ambiguous" errors at any time (even if it "used to work in the past"), for
|
||||
example if the name clashes with a newly created public fleet, or with fleets
|
||||
from other balena accounts that you may be invited to join under any role.
|
||||
For this reason, fleet names are especially discouraged in scripts (e.g. CI
|
||||
environments).
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena join
|
||||
$ balena join balena.local
|
||||
$ balena join balena.local --fleet MyFleet
|
||||
$ balena join balena.local -f myorg/myfleet
|
||||
$ balena join 192.168.1.25
|
||||
$ balena join 192.168.1.25 --fleet MyFleet
|
||||
|
||||
### Arguments
|
||||
|
||||
#### DEVICEIPORHOSTNAME
|
||||
|
||||
the IP or hostname of device
|
||||
|
||||
### Options
|
||||
|
||||
#### -f, --fleet FLEET
|
||||
|
||||
fleet name or slug (preferred)
|
||||
|
||||
#### -i, --pollInterval POLLINTERVAL
|
||||
|
||||
the interval in minutes to check for updates
|
||||
|
||||
## leave [deviceIpOrHostname]
|
||||
|
||||
Remove a local device from its balena fleet, causing the device to
|
||||
"leave" the server it is provisioned on. This effectively makes the device
|
||||
"unmanaged". The device must be running balenaOS.
|
||||
|
||||
The device entry on the server is preserved after running this command,
|
||||
so the device can subsequently re-join the server if needed.
|
||||
|
||||
If you don't specify a device hostname or IP, this command will automatically
|
||||
scan the local network for balenaOS devices and prompt you to select one
|
||||
from an interactive picker. This may require administrator/root privileges.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena leave
|
||||
$ balena leave balena.local
|
||||
$ balena leave 192.168.1.25
|
||||
|
||||
### Arguments
|
||||
|
||||
#### DEVICEIPORHOSTNAME
|
||||
|
||||
the device IP or hostname
|
||||
|
||||
### Options
|
||||
|
||||
# Preload
|
||||
|
||||
## preload <image>
|
||||
@ -3368,87 +3591,6 @@ as final by default unless this option is given.
|
||||
|
||||
The notes for this release
|
||||
|
||||
# Platform
|
||||
|
||||
## join [deviceIpOrHostname]
|
||||
|
||||
Move a local device to a fleet on another balena server, causing
|
||||
the device to "join" the new server. The device must be running balenaOS.
|
||||
|
||||
For example, you could provision a device against an openBalena installation
|
||||
where you perform end-to-end tests and then move it to balenaCloud when it's
|
||||
ready for production.
|
||||
|
||||
To move a device between fleets on the same server, use the
|
||||
`balena device move` command instead of `balena join`.
|
||||
|
||||
If you don't specify a device hostname or IP, this command will automatically
|
||||
scan the local network for balenaOS devices and prompt you to select one
|
||||
from an interactive picker. This may require administrator/root privileges.
|
||||
Likewise, if the fleet option is not provided then a picker will be shown.
|
||||
|
||||
Fleets may be specified by fleet name or slug. Fleet slugs are
|
||||
the recommended option, as they are unique and unambiguous. Slugs can be
|
||||
listed with the `balena fleets` command. Note that slugs may change if the
|
||||
fleet is renamed. Fleet names are not unique and may result in "Fleet is
|
||||
ambiguous" errors at any time (even if it "used to work in the past"), for
|
||||
example if the name clashes with a newly created public fleet, or with fleets
|
||||
from other balena accounts that you may be invited to join under any role.
|
||||
For this reason, fleet names are especially discouraged in scripts (e.g. CI
|
||||
environments).
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena join
|
||||
$ balena join balena.local
|
||||
$ balena join balena.local --fleet MyFleet
|
||||
$ balena join balena.local -f myorg/myfleet
|
||||
$ balena join 192.168.1.25
|
||||
$ balena join 192.168.1.25 --fleet MyFleet
|
||||
|
||||
### Arguments
|
||||
|
||||
#### DEVICEIPORHOSTNAME
|
||||
|
||||
the IP or hostname of device
|
||||
|
||||
### Options
|
||||
|
||||
#### -f, --fleet FLEET
|
||||
|
||||
fleet name or slug (preferred)
|
||||
|
||||
#### -i, --pollInterval POLLINTERVAL
|
||||
|
||||
the interval in minutes to check for updates
|
||||
|
||||
## leave [deviceIpOrHostname]
|
||||
|
||||
Remove a local device from its balena fleet, causing the device to
|
||||
"leave" the server it is provisioned on. This effectively makes the device
|
||||
"unmanaged". The device must be running balenaOS.
|
||||
|
||||
The device entry on the server is preserved after running this command,
|
||||
so the device can subsequently re-join the server if needed.
|
||||
|
||||
If you don't specify a device hostname or IP, this command will automatically
|
||||
scan the local network for balenaOS devices and prompt you to select one
|
||||
from an interactive picker. This may require administrator/root privileges.
|
||||
|
||||
Examples:
|
||||
|
||||
$ balena leave
|
||||
$ balena leave balena.local
|
||||
$ balena leave 192.168.1.25
|
||||
|
||||
### Arguments
|
||||
|
||||
#### DEVICEIPORHOSTNAME
|
||||
|
||||
the device IP or hostname
|
||||
|
||||
### Options
|
||||
|
||||
# Release
|
||||
|
||||
## release finalize <commitOrId>
|
||||
@ -3598,56 +3740,6 @@ Examples:
|
||||
|
||||
### Options
|
||||
|
||||
# Support
|
||||
|
||||
## support <action>
|
||||
|
||||
Grant or revoke balena support agent access to devices or fleets
|
||||
on balenaCloud. (This command does not apply to openBalena.)
|
||||
Access will be automatically revoked once the specified duration has elapsed.
|
||||
|
||||
Duration defaults to 24h, but can be specified using --duration flag in days
|
||||
or hours, e.g. '12h', '2d'.
|
||||
|
||||
Both --device and --fleet flags accept multiple values, specified as
|
||||
a comma-separated list (with no spaces).
|
||||
|
||||
Fleets may be specified by fleet name or slug. Fleet slugs are
|
||||
the recommended option, as they are unique and unambiguous. Slugs can be
|
||||
listed with the `balena fleets` command. Note that slugs may change if the
|
||||
fleet is renamed. Fleet names are not unique and may result in "Fleet is
|
||||
ambiguous" errors at any time (even if it "used to work in the past"), for
|
||||
example if the name clashes with a newly created public fleet, or with fleets
|
||||
from other balena accounts that you may be invited to join under any role.
|
||||
For this reason, fleet names are especially discouraged in scripts (e.g. CI
|
||||
environments).
|
||||
|
||||
Examples:
|
||||
|
||||
balena support enable --device ab346f,cd457a --duration 3d
|
||||
balena support enable --fleet myFleet --duration 12h
|
||||
balena support disable -f myorg/myfleet
|
||||
|
||||
### Arguments
|
||||
|
||||
#### ACTION
|
||||
|
||||
enable|disable support access
|
||||
|
||||
### Options
|
||||
|
||||
#### -d, --device DEVICE
|
||||
|
||||
comma-separated list (no spaces) of device UUIDs
|
||||
|
||||
#### -f, --fleet FLEET
|
||||
|
||||
comma-separated list (no spaces) of fleet names or slugs (preferred)
|
||||
|
||||
#### -t, --duration DURATION
|
||||
|
||||
length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d
|
||||
|
||||
# SSH Key
|
||||
|
||||
## key add <name> [path]
|
||||
@ -3740,7 +3832,57 @@ Examples:
|
||||
|
||||
### Options
|
||||
|
||||
# Tags
|
||||
# Support
|
||||
|
||||
## support <action>
|
||||
|
||||
Grant or revoke balena support agent access to devices or fleets
|
||||
on balenaCloud. (This command does not apply to openBalena.)
|
||||
Access will be automatically revoked once the specified duration has elapsed.
|
||||
|
||||
Duration defaults to 24h, but can be specified using --duration flag in days
|
||||
or hours, e.g. '12h', '2d'.
|
||||
|
||||
Both --device and --fleet flags accept multiple values, specified as
|
||||
a comma-separated list (with no spaces).
|
||||
|
||||
Fleets may be specified by fleet name or slug. Fleet slugs are
|
||||
the recommended option, as they are unique and unambiguous. Slugs can be
|
||||
listed with the `balena fleets` command. Note that slugs may change if the
|
||||
fleet is renamed. Fleet names are not unique and may result in "Fleet is
|
||||
ambiguous" errors at any time (even if it "used to work in the past"), for
|
||||
example if the name clashes with a newly created public fleet, or with fleets
|
||||
from other balena accounts that you may be invited to join under any role.
|
||||
For this reason, fleet names are especially discouraged in scripts (e.g. CI
|
||||
environments).
|
||||
|
||||
Examples:
|
||||
|
||||
balena support enable --device ab346f,cd457a --duration 3d
|
||||
balena support enable --fleet myFleet --duration 12h
|
||||
balena support disable -f myorg/myfleet
|
||||
|
||||
### Arguments
|
||||
|
||||
#### ACTION
|
||||
|
||||
enable|disable support access
|
||||
|
||||
### Options
|
||||
|
||||
#### -d, --device DEVICE
|
||||
|
||||
comma-separated list (no spaces) of device UUIDs
|
||||
|
||||
#### -f, --fleet FLEET
|
||||
|
||||
comma-separated list (no spaces) of fleet names or slugs (preferred)
|
||||
|
||||
#### -t, --duration DURATION
|
||||
|
||||
length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d
|
||||
|
||||
# Tag
|
||||
|
||||
## tag rm <tagKey>
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user