Drop -h flag for help and stop manually adding help per command in favor of oclif automatically adding it

Change-type: major
This commit is contained in:
myarmolinsky 2024-09-30 12:05:32 -04:00
parent de1821d7ac
commit d023d0af91
89 changed files with 9 additions and 316 deletions

View File

@ -29,7 +29,7 @@ _balena() {
_arguments -C \ _arguments -C \
'(- 1 *)--version[show version and exit]' \ '(- 1 *)--version[show version and exit]' \
'(- 1 *)'{-h,--help}'[show help options and exit]' \ '(- 1 *)--help[show help options and exit]' \
'1:first command:_balena_main_cmds' \ '1:first command:_balena_main_cmds' \
'2:second command:_balena_sec_cmds' \ '2:second command:_balena_sec_cmds' \
&& ret=0 && ret=0

View File

@ -14,7 +14,7 @@ $sub_cmds$
_arguments -C \ _arguments -C \
'(- 1 *)--version[show version and exit]' \ '(- 1 *)--version[show version and exit]' \
'(- 1 *)'{-h,--help}'[show help options and exit]' \ '(- 1 *)--help[show help options and exit]' \
'1:first command:_balena_main_cmds' \ '1:first command:_balena_main_cmds' \
'2:second command:_balena_sec_cmds' \ '2:second command:_balena_sec_cmds' \
&& ret=0 && ret=0

View File

@ -333,8 +333,6 @@ Examples:
the API key name the API key name
### Options
## api-key list ## api-key list
### Aliases ### Aliases
@ -384,8 +382,6 @@ Examples:
the API key ids the API key ids
### Options
# Apps # Apps
## app create ## app create
@ -1346,8 +1342,6 @@ Examples:
the uuid of the device to identify the uuid of the device to identify
### Options
## device ## device
### Description ### Description
@ -1749,8 +1743,6 @@ the uuid of the device to pin to a release
the commit of the release for the device to get pinned to the commit of the release for the device to get pinned to
### Options
## device public-url ## device public-url
### Description ### Description
@ -1807,8 +1799,6 @@ Examples:
comma-separated list (no blank spaces) of device UUIDs comma-separated list (no blank spaces) of device UUIDs
### Options
## device reboot ## device reboot
### Description ### Description
@ -1895,8 +1885,6 @@ the uuid of the device to rename
the new name for the device the new name for the device
### Options
## device restart ## device restart
### Description ### Description
@ -2076,8 +2064,6 @@ comma-separated list (no blank spaces) of device UUIDs
comma-separated list (no blank spaces) of service names comma-separated list (no blank spaces) of service names
### Options
## device stop-service ## device stop-service
### Description ### Description
@ -2102,8 +2088,6 @@ comma-separated list (no blank spaces) of device UUIDs
comma-separated list (no blank spaces) of service names comma-separated list (no blank spaces) of service names
### Options
## device track-fleet ## device track-fleet
### Description ### Description
@ -2120,8 +2104,6 @@ Examples:
the uuid of the device to make track the fleet's release the uuid of the device to make track the fleet's release
### Options
## device tunnel ## device tunnel
### Aliases ### Aliases
@ -2618,8 +2600,6 @@ the slug of the fleet to pin to a release
the commit of the release for the fleet to get pinned to the commit of the release for the fleet to get pinned to
### Options
## fleet purge ## fleet purge
### Description ### Description
@ -2648,8 +2628,6 @@ Examples:
fleet name or slug (preferred) fleet name or slug (preferred)
### Options
## fleet rename ## fleet rename
### Description ### Description
@ -2685,8 +2663,6 @@ fleet name or slug (preferred)
the new name for the fleet the new name for the fleet
### Options
## fleet restart ## fleet restart
### Description ### Description
@ -2714,8 +2690,6 @@ Examples:
fleet name or slug (preferred) fleet name or slug (preferred)
### Options
## fleet rm ## fleet rm
### Description ### Description
@ -2769,8 +2743,6 @@ Examples:
the slug of the fleet to make track the latest release the slug of the fleet to make track the latest release
### Options
# Local # Local
## local configure ## local configure
@ -2790,8 +2762,6 @@ Examples:
path of drive or image to configure path of drive or image to configure
### Options
## local flash ## local flash
### Description ### Description
@ -2845,8 +2815,6 @@ Examples:
$ balena organization list $ balena organization list
### Options
# OS # OS
## os build-config ## os build-config
@ -3217,8 +3185,6 @@ Examples:
the device IP or hostname the device IP or hostname
### Options
# Preload # Preload
## preload ## preload
@ -3586,8 +3552,6 @@ Examples:
the commit or ID of the release to finalize the commit or ID of the release to finalize
### Options
## release ## release
### Description ### Description
@ -3641,8 +3605,6 @@ Examples:
the commit or ID of the release to invalidate the commit or ID of the release to invalidate
### Options
## release list ## release list
### Aliases ### Aliases
@ -3708,8 +3670,6 @@ Examples:
the commit or ID of the release to validate the commit or ID of the release to validate
### Options
# Settings # Settings
## settings ## settings
@ -3722,8 +3682,6 @@ Examples:
$ balena settings $ balena settings
### Options
# SSH Keys # SSH Keys
## ssh-key add ## ssh-key add
@ -3772,8 +3730,6 @@ the SSH key name
the path to the public key file the path to the public key file
### Options
## ssh-key ## ssh-key
### Aliases ### Aliases
@ -3797,8 +3753,6 @@ Examples:
balenaCloud ID for the SSH key balenaCloud ID for the SSH key
### Options
## ssh-key list ## ssh-key list
### Aliases ### Aliases
@ -3817,8 +3771,6 @@ Examples:
$ balena ssh-key list $ balena ssh-key list
### Options
## ssh-key rm ## ssh-key rm
### Aliases ### Aliases
@ -4058,8 +4010,6 @@ release id
List available drives which are usable for writing an OS image to. List available drives which are usable for writing an OS image to.
Does not list system drives. Does not list system drives.
### Options
# Version # Version
## version ## version

View File

@ -17,7 +17,6 @@
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import { ExpectedError } from '../../errors'; import { ExpectedError } from '../../errors';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class GenerateCmd extends Command { export default class GenerateCmd extends Command {
@ -39,10 +38,6 @@ export default class GenerateCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -33,7 +33,6 @@ export default class APIKeyListCmd extends Command {
public static examples = ['$ balena api-key list']; public static examples = ['$ balena api-key list'];
public static flags = { public static flags = {
help: cf.help,
user: Flags.boolean({ user: Flags.boolean({
char: 'u', char: 'u',
description: 'show API keys for your user', description: 'show API keys for your user',

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class RevokeCmd extends Command { export default class RevokeCmd extends Command {
@ -40,10 +39,6 @@ export default class RevokeCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy'; import { stripIndent } from '../../utils/lazy';
export default class AppCreateCmd extends Command { export default class AppCreateCmd extends Command {
@ -64,7 +63,6 @@ export default class AppCreateCmd extends Command {
description: description:
'app device type (Check available types with `balena device-type list`)', 'app device type (Check available types with `balena device-type list`)',
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy'; import { stripIndent } from '../../utils/lazy';
export default class BlockCreateCmd extends Command { export default class BlockCreateCmd extends Command {
@ -64,7 +63,6 @@ export default class BlockCreateCmd extends Command {
description: description:
'block device type (Check available types with `balena device-type list`)', 'block device type (Check available types with `balena device-type list`)',
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -44,7 +44,6 @@ interface FlagsDef extends ComposeCliFlags, DockerCliFlags {
deviceType?: string; deviceType?: string;
fleet?: string; fleet?: string;
source?: string; // Not part of command profile - source param copied here. source?: string; // Not part of command profile - source param copied here.
help: void;
} }
export default class BuildCmd extends Command { export default class BuildCmd extends Command {
@ -95,9 +94,6 @@ ${dockerignoreHelp}
fleet: cf.fleet, fleet: cf.fleet,
...composeCliFlags, ...composeCliFlags,
...dockerCliFlags, ...dockerCliFlags,
// NOTE: Not supporting -h for help, because of clash with -h in DockerCliFlags
// Revisit this in future release.
help: Flags.help({}),
}; };
public static primary = true; public static primary = true;

View File

@ -117,7 +117,6 @@ export default class ConfigGenerateCmd extends Command {
'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)', 'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)',
exclusive: ['device'], exclusive: ['device'],
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -44,7 +44,6 @@ export default class ConfigInjectCmd extends Command {
public static flags = { public static flags = {
drive: cf.driveOrImg, drive: cf.driveOrImg,
help: cf.help,
}; };
public static root = true; public static root = true;

View File

@ -38,7 +38,6 @@ export default class ConfigReadCmd extends Command {
public static flags = { public static flags = {
drive: cf.driveOrImg, drive: cf.driveOrImg,
help: cf.help,
json: cf.json, json: cf.json,
}; };

View File

@ -44,7 +44,6 @@ export default class ConfigReconfigureCmd extends Command {
description: 'show advanced commands', description: 'show advanced commands',
char: 'v', char: 'v',
}), }),
help: cf.help,
version: Flags.string({ version: Flags.string({
description: 'balenaOS version, for example "2.32.0" or "2.44.0+rev1"', description: 'balenaOS version, for example "2.32.0" or "2.44.0+rev1"',
}), }),

View File

@ -49,7 +49,6 @@ export default class ConfigWriteCmd extends Command {
public static flags = { public static flags = {
drive: cf.driveOrImg, drive: cf.driveOrImg,
help: cf.help,
}; };
public static root = true; public static root = true;

View File

@ -60,7 +60,6 @@ interface FlagsDef extends ComposeCliFlags, DockerCliFlags {
'release-tag'?: string[]; 'release-tag'?: string[];
draft: boolean; draft: boolean;
note?: string; note?: string;
help: void;
} }
export default class DeployCmd extends Command { export default class DeployCmd extends Command {
@ -139,9 +138,6 @@ ${dockerignoreHelp}
note: Flags.string({ description: 'The notes for this release' }), note: Flags.string({ description: 'The notes for this release' }),
...composeCliFlags, ...composeCliFlags,
...dockerCliFlags, ...dockerCliFlags,
// NOTE: Not supporting -h for help, because of clash with -h in DockerCliFlags
// Revisit this in future release.
help: Flags.help({}),
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -17,7 +17,6 @@
import { Flags, Command } from '@oclif/core'; import { Flags, Command } from '@oclif/core';
import type * as BalenaSdk from 'balena-sdk'; import type * as BalenaSdk from 'balena-sdk';
import * as _ from 'lodash'; import * as _ from 'lodash';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
export default class DeviceTypeListCmd extends Command { export default class DeviceTypeListCmd extends Command {
@ -46,7 +45,6 @@ export default class DeviceTypeListCmd extends Command {
]; ];
public static flags = { public static flags = {
help: cf.help,
json: Flags.boolean({ json: Flags.boolean({
char: 'j', char: 'j',
description: 'produce JSON output instead of tabular output', description: 'produce JSON output instead of tabular output',

View File

@ -42,7 +42,6 @@ export default class DeviceDeactivateCmd extends Command {
public static flags = { public static flags = {
yes: cf.yes, yes: cf.yes,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Command } from '@oclif/core'; import { Flags, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getCliUx, stripIndent } from '../../utils/lazy'; import { getCliUx, stripIndent } from '../../utils/lazy';
export default class DeviceDetectCmd extends Command { export default class DeviceDetectCmd extends Command {
@ -50,7 +49,6 @@ export default class DeviceDetectCmd extends Command {
char: 't', char: 't',
description: 'scan timeout in seconds', description: 'scan timeout in seconds',
}), }),
help: cf.help,
json: Flags.boolean({ json: Flags.boolean({
default: false, default: false,
char: 'j', char: 'j',

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { ExpectedError } from '../../errors'; import { ExpectedError } from '../../errors';
@ -35,10 +34,6 @@ export default class DeviceIdentifyCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -63,7 +63,6 @@ export default class DeviceCmd extends Command {
public static flags = { public static flags = {
json: cf.json, json: cf.json,
help: cf.help,
view: Flags.boolean({ view: Flags.boolean({
default: false, default: false,
description: 'open device dashboard page', description: 'open device dashboard page',

View File

@ -28,7 +28,6 @@ interface FlagsDef {
'os-version'?: string; 'os-version'?: string;
drive?: string; drive?: string;
config?: string; config?: string;
help: void;
'provisioning-key-name'?: string; 'provisioning-key-name'?: string;
'provisioning-key-expiry-date'?: string; 'provisioning-key-expiry-date'?: string;
} }
@ -100,7 +99,6 @@ export default class DeviceInitCmd extends Command {
description: description:
'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)', 'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)',
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -59,7 +59,6 @@ export default class DeviceListCmd extends Command {
public static flags = { public static flags = {
fleet: cf.fleet, fleet: cf.fleet,
json: cf.json, json: cf.json,
help: cf.help,
}; };
public static primary = true; public static primary = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class DeviceLocalModeCmd extends Command { export default class DeviceLocalModeCmd extends Command {
@ -54,7 +53,6 @@ export default class DeviceLocalModeCmd extends Command {
description: 'output boolean indicating local mode status', description: 'output boolean indicating local mode status',
exclusive: ['enable', 'disable'], exclusive: ['enable', 'disable'],
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import type { LogMessage } from 'balena-sdk'; import type { LogMessage } from 'balena-sdk';
@ -87,7 +86,6 @@ export default class DeviceLogsCmd extends Command {
'Only show system logs. This can be used in combination with --service.', 'Only show system logs. This can be used in combination with --service.',
char: 'S', char: 'S',
}), }),
help: cf.help,
}; };
public static primary = true; public static primary = true;

View File

@ -55,7 +55,6 @@ export default class DeviceMoveCmd extends Command {
public static flags = { public static flags = {
fleet: cf.fleet, fleet: cf.fleet,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -50,7 +50,6 @@ export default class DeviceNoteCmd extends Command {
exclusive: ['device'], exclusive: ['device'],
hidden: true, hidden: true,
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -57,7 +57,6 @@ export default class DeviceOsUpdateCmd extends Command {
exclusive: ['version'], exclusive: ['version'],
}), }),
yes: cf.yes, yes: cf.yes,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { getExpandedProp } from '../../utils/pine'; import { getExpandedProp } from '../../utils/pine';
@ -43,10 +42,6 @@ export default class DevicePinCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -17,7 +17,6 @@
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import { ExpectedError } from '../../errors'; import { ExpectedError } from '../../errors';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class DevicePublicUrlCmd extends Command { export default class DevicePublicUrlCmd extends Command {
@ -56,7 +55,6 @@ export default class DevicePublicUrlCmd extends Command {
description: 'determine if public URL is enabled', description: 'determine if public URL is enabled',
exclusive: ['enable', 'disable'], exclusive: ['enable', 'disable'],
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
export default class DevicePurgeCmd extends Command { export default class DevicePurgeCmd extends Command {
@ -41,10 +40,6 @@ export default class DevicePurgeCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -36,7 +36,6 @@ export default class DeviceRebootCmd extends Command {
public static flags = { public static flags = {
force: cf.force, force: cf.force,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Command } from '@oclif/core'; import { Flags, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import * as ca from '../../utils/common-args'; import * as ca from '../../utils/common-args';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { applicationIdInfo } from '../../utils/messages'; import { applicationIdInfo } from '../../utils/messages';
@ -52,7 +51,6 @@ export default class DeviceRegisterCmd extends Command {
description: description:
"device type slug (run 'balena device-type list' for possible values)", "device type slug (run 'balena device-type list' for possible values)",
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy'; import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
export default class DeviceRenameCmd extends Command { export default class DeviceRenameCmd extends Command {
@ -42,10 +41,6 @@ export default class DeviceRenameCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
import type { import type {
BalenaSDK, BalenaSDK,
@ -58,7 +57,6 @@ export default class DeviceRestartCmd extends Command {
'comma-separated list (no blank spaces) of service names to restart', 'comma-separated list (no blank spaces) of service names to restart',
char: 's', char: 's',
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -44,7 +44,6 @@ export default class DeviceRmCmd extends Command {
public static flags = { public static flags = {
yes: cf.yes, yes: cf.yes,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -37,7 +37,6 @@ export default class DeviceShutdownCmd extends Command {
public static flags = { public static flags = {
force: cf.force, force: cf.force,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { import {
parseAsInteger, parseAsInteger,
@ -100,7 +99,6 @@ export default class DeviceSSHCmd extends Command {
default: false, default: false,
description: 'bypass global proxy configuration for the ssh connection', description: 'bypass global proxy configuration for the ssh connection',
}), }),
help: cf.help,
}; };
public static primary = true; public static primary = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
import type { BalenaSDK } from 'balena-sdk'; import type { BalenaSDK } from 'balena-sdk';
@ -45,10 +44,6 @@ export default class DeviceStartServiceCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
import type { BalenaSDK } from 'balena-sdk'; import type { BalenaSDK } from 'balena-sdk';
@ -45,10 +44,6 @@ export default class DeviceStopServiceCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class DeviceTrackFleetCmd extends Command { export default class DeviceTrackFleetCmd extends Command {
@ -34,10 +33,6 @@ export default class DeviceTrackFleetCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -21,7 +21,6 @@ import {
InvalidPortMappingError, InvalidPortMappingError,
ExpectedError, ExpectedError,
} from '../../errors'; } from '../../errors';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { lowercaseIfSlug } from '../../utils/normalization'; import { lowercaseIfSlug } from '../../utils/normalization';
@ -87,7 +86,6 @@ export default class DeviceTunnelCmd extends Command {
char: 'p', char: 'p',
multiple: true, multiple: true,
}), }),
help: cf.help,
}; };
public static primary = true; public static primary = true;

View File

@ -105,7 +105,6 @@ export default class EnvListCmd extends Command {
exclusive: ['service'], exclusive: ['service'],
}), }),
device: { ...cf.device, exclusive: ['fleet'] }, device: { ...cf.device, exclusive: ['fleet'] },
help: cf.help,
json: cf.json, json: cf.json,
service: { ...cf.service, exclusive: ['config'] }, service: { ...cf.service, exclusive: ['config'] },
}; };

View File

@ -15,7 +15,6 @@
* limitations under the License. * limitations under the License.
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import * as ec from '../../utils/env-common'; import * as ec from '../../utils/env-common';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { parseAsInteger } from '../../utils/validation'; import { parseAsInteger } from '../../utils/validation';
@ -55,7 +54,6 @@ export default class EnvRenameCmd extends Command {
config: ec.booleanConfig, config: ec.booleanConfig,
device: ec.booleanDevice, device: ec.booleanDevice,
service: ec.booleanService, service: ec.booleanService,
help: cf.help,
}; };
public async run() { public async run() {

View File

@ -25,7 +25,6 @@ import { applicationIdInfo } from '../../utils/messages';
interface FlagsDef { interface FlagsDef {
fleet?: string; fleet?: string;
device?: string; // device UUID device?: string; // device UUID
help: void;
quiet: boolean; quiet: boolean;
service?: string; // service name service?: string; // service name
} }
@ -98,7 +97,6 @@ export default class EnvSetCmd extends Command {
public static flags = { public static flags = {
fleet: { ...cf.fleet, exclusive: ['device'] }, fleet: { ...cf.fleet, exclusive: ['device'] },
device: { ...cf.device, exclusive: ['fleet'] }, device: { ...cf.device, exclusive: ['fleet'] },
help: cf.help,
quiet: cf.quiet, quiet: cf.quiet,
service: cf.service, service: cf.service,
}; };

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy'; import { stripIndent } from '../../utils/lazy';
export default class FleetCreateCmd extends Command { export default class FleetCreateCmd extends Command {
@ -64,7 +63,6 @@ export default class FleetCreateCmd extends Command {
description: description:
'fleet device type (Check available types with `balena device-type list`)', 'fleet device type (Check available types with `balena device-type list`)',
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -40,7 +40,6 @@ export default class FleetCmd extends Command {
}; };
public static flags = { public static flags = {
help: cf.help,
view: Flags.boolean({ view: Flags.boolean({
default: false, default: false,
description: 'open fleet dashboard page', description: 'open fleet dashboard page',

View File

@ -42,7 +42,6 @@ export default class FleetListCmd extends Command {
public static examples = ['$ balena fleet list']; public static examples = ['$ balena fleet list'];
public static flags = { public static flags = {
help: cf.help,
json: cf.json, json: cf.json,
}; };

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { getExpandedProp } from '../../utils/pine'; import { getExpandedProp } from '../../utils/pine';
@ -43,10 +42,6 @@ export default class FleetPinCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import * as ca from '../../utils/common-args'; import * as ca from '../../utils/common-args';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { applicationIdInfo } from '../../utils/messages'; import { applicationIdInfo } from '../../utils/messages';
@ -40,10 +39,6 @@ export default class FleetPurgeCmd extends Command {
fleet: ca.fleetRequired, fleet: ca.fleetRequired,
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import * as ca from '../../utils/common-args'; import * as ca from '../../utils/common-args';
import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy'; import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
import { applicationIdInfo } from '../../utils/messages'; import { applicationIdInfo } from '../../utils/messages';
@ -46,10 +45,6 @@ export default class FleetRenameCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import * as ca from '../../utils/common-args'; import * as ca from '../../utils/common-args';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { applicationIdInfo } from '../../utils/messages'; import { applicationIdInfo } from '../../utils/messages';
@ -39,10 +38,6 @@ export default class FleetRestartCmd extends Command {
fleet: ca.fleetRequired, fleet: ca.fleetRequired,
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -44,7 +44,6 @@ export default class FleetRmCmd extends Command {
public static flags = { public static flags = {
yes: cf.yes, yes: cf.yes,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class FleetTrackLatestCmd extends Command { export default class FleetTrackLatestCmd extends Command {
@ -37,10 +36,6 @@ export default class FleetTrackLatestCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -65,7 +65,6 @@ export default class JoinCmd extends Command {
description: 'the interval in minutes to check for updates', description: 'the interval in minutes to check for updates',
char: 'i', char: 'i',
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy'; import { stripIndent } from '../../utils/lazy';
import { parseAsLocalHostnameOrIp } from '../../utils/validation'; import { parseAsLocalHostnameOrIp } from '../../utils/validation';
@ -49,10 +48,6 @@ export default class LeaveCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public static primary = true; public static primary = true;

View File

@ -17,7 +17,6 @@
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import { promisify } from 'util'; import { promisify } from 'util';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy'; import { stripIndent } from '../../utils/lazy';
export default class LocalConfigureCmd extends Command { export default class LocalConfigureCmd extends Command {
@ -39,10 +38,6 @@ export default class LocalConfigureCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static root = true; public static root = true;
public static offlineCompatible = true; public static offlineCompatible = true;

View File

@ -48,7 +48,6 @@ export default class LocalFlashCmd extends Command {
public static flags = { public static flags = {
drive: cf.drive, drive: cf.drive,
yes: cf.yes, yes: cf.yes,
help: cf.help,
}; };
public static offlineCompatible = true; public static offlineCompatible = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy'; import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
import { ExpectedError } from '../../errors'; import { ExpectedError } from '../../errors';
import type { WhoamiResult } from 'balena-sdk'; import type { WhoamiResult } from 'balena-sdk';
@ -29,7 +28,6 @@ interface FlagsDef {
user?: string; user?: string;
password?: string; password?: string;
port?: number; port?: number;
help: void;
hideExperimentalWarning: boolean; hideExperimentalWarning: boolean;
} }
@ -111,7 +109,6 @@ export default class LoginCmd extends Command {
default: false, default: false,
description: 'Hides warning for experimental features', description: 'Hides warning for experimental features',
}), }),
help: cf.help,
}; };
public static primary = true; public static primary = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
export default class OrganizationListCmd extends Command { export default class OrganizationListCmd extends Command {
@ -30,10 +29,6 @@ export default class OrganizationListCmd extends Command {
`; `;
public static examples = ['$ balena organization list']; public static examples = ['$ balena organization list'];
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getCliForm, stripIndent } from '../../utils/lazy'; import { getCliForm, stripIndent } from '../../utils/lazy';
import * as _ from 'lodash'; import * as _ from 'lodash';
import type { DeviceTypeJson } from 'balena-sdk'; import type { DeviceTypeJson } from 'balena-sdk';
@ -55,7 +54,6 @@ export default class OsBuildConfigCmd extends Command {
char: 'o', char: 'o',
required: true, required: true,
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -154,7 +154,6 @@ export default class OsConfigureCmd extends Command {
'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)', 'expiry date assigned to generated provisioning api key (format: YYYY-MM-DD)',
exclusive: ['config', 'device'], exclusive: ['config', 'device'],
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy'; import { stripIndent } from '../../utils/lazy';
export default class OsDownloadCmd extends Command { export default class OsDownloadCmd extends Command {
@ -78,7 +77,6 @@ export default class OsDownloadCmd extends Command {
or 'menu-esr' (interactive menu, ESR versions) or 'menu-esr' (interactive menu, ESR versions)
`, `,
}), }),
help: cf.help,
}; };
public async run() { public async run() {

View File

@ -51,7 +51,6 @@ export default class OsInitializeCmd extends Command {
type: cf.deviceType, type: cf.deviceType,
drive: cf.drive, drive: cf.drive,
yes: cf.yes, yes: cf.yes,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy'; import { stripIndent } from '../../utils/lazy';
export default class OsVersionsCmd extends Command { export default class OsVersionsCmd extends Command {
@ -40,7 +39,6 @@ export default class OsVersionsCmd extends Command {
}; };
public static flags = { public static flags = {
help: cf.help,
esr: Flags.boolean({ esr: Flags.boolean({
description: 'select balenaOS ESR versions', description: 'select balenaOS ESR versions',
default: false, default: false,

View File

@ -128,9 +128,6 @@ Can be repeated to add multiple certificates.\
'Docker daemon TCP port number (hint: 2375 for balena devices)', 'Docker daemon TCP port number (hint: 2375 for balena devices)',
parse: async (p) => parseAsInteger(p, 'dockerPort'), parse: async (p) => parseAsInteger(p, 'dockerPort'),
}), }),
// Not supporting -h for help, because of clash with -h in DockerCliFlags
// Revisit this in future release.
help: Flags.help({}),
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -17,7 +17,6 @@
import { Flags, Args, Command } from '@oclif/core'; import { Flags, Args, Command } from '@oclif/core';
import type { Interfaces } from '@oclif/core'; import type { Interfaces } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
import { dockerignoreHelp, registrySecretsHelp } from '../../utils/messages'; import { dockerignoreHelp, registrySecretsHelp } from '../../utils/messages';
import type { BalenaSDK } from 'balena-sdk'; import type { BalenaSDK } from 'balena-sdk';
@ -218,7 +217,6 @@ export default class PushCmd extends Command {
default: false, default: false,
}), }),
note: Flags.string({ description: 'The notes for this release' }), note: Flags.string({ description: 'The notes for this release' }),
help: cf.help,
}; };
public static primary = true; public static primary = true;

View File

@ -17,7 +17,6 @@
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import { commitOrIdArg } from '.'; import { commitOrIdArg } from '.';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class ReleaseFinalizeCmd extends Command { export default class ReleaseFinalizeCmd extends Command {
@ -40,10 +39,6 @@ export default class ReleaseFinalizeCmd extends Command {
'$ balena release finalize 1234567', '$ balena release finalize 1234567',
]; ];
public static flags = {
help: cf.help,
};
public static args = { public static args = {
commitOrId: commitOrIdArg({ commitOrId: commitOrIdArg({
description: 'the commit or ID of the release to finalize', description: 'the commit or ID of the release to finalize',

View File

@ -43,7 +43,6 @@ export default class ReleaseCmd extends Command {
public static flags = { public static flags = {
json: cf.json, json: cf.json,
help: cf.help,
composition: Flags.boolean({ composition: Flags.boolean({
default: false, default: false,
char: 'c', char: 'c',

View File

@ -17,7 +17,6 @@
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import { commitOrIdArg } from '.'; import { commitOrIdArg } from '.';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class ReleaseInvalidateCmd extends Command { export default class ReleaseInvalidateCmd extends Command {
@ -35,10 +34,6 @@ export default class ReleaseInvalidateCmd extends Command {
'$ balena release invalidate 1234567', '$ balena release invalidate 1234567',
]; ];
public static flags = {
help: cf.help,
};
public static args = { public static args = {
commitOrId: commitOrIdArg({ commitOrId: commitOrIdArg({
description: 'the commit or ID of the release to invalidate', description: 'the commit or ID of the release to invalidate',

View File

@ -42,7 +42,6 @@ export default class ReleaseListCmd extends Command {
public static flags = { public static flags = {
json: cf.json, json: cf.json,
help: cf.help,
}; };
public static args = { public static args = {

View File

@ -17,7 +17,6 @@
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import { commitOrIdArg } from '.'; import { commitOrIdArg } from '.';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class ReleaseValidateCmd extends Command { export default class ReleaseValidateCmd extends Command {
@ -34,10 +33,6 @@ export default class ReleaseValidateCmd extends Command {
'$ balena release validate 1234567', '$ balena release validate 1234567',
]; ];
public static flags = {
help: cf.help,
};
public static args = { public static args = {
commitOrId: commitOrIdArg({ commitOrId: commitOrIdArg({
description: 'the commit or ID of the release to validate', description: 'the commit or ID of the release to validate',

View File

@ -16,7 +16,6 @@
*/ */
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class SettingsCmd extends Command { export default class SettingsCmd extends Command {
@ -27,10 +26,6 @@ export default class SettingsCmd extends Command {
`; `;
public static examples = ['$ balena settings']; public static examples = ['$ balena settings'];
public static flags = {
help: cf.help,
};
public async run() { public async run() {
await this.parse(SettingsCmd); await this.parse(SettingsCmd);

View File

@ -17,7 +17,6 @@
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import { ExpectedError } from '../../errors'; import { ExpectedError } from '../../errors';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, stripIndent } from '../../utils/lazy';
export default class SSHKeyAddCmd extends Command { export default class SSHKeyAddCmd extends Command {
@ -63,10 +62,6 @@ export default class SSHKeyAddCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Args, Command } from '@oclif/core'; import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
import { parseAsInteger } from '../../utils/validation'; import { parseAsInteger } from '../../utils/validation';
@ -40,10 +39,6 @@ export default class SSHKeyCmd extends Command {
}), }),
}; };
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -16,7 +16,6 @@
*/ */
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy'; import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
export default class SSHKeyListCmd extends Command { export default class SSHKeyListCmd extends Command {
@ -30,10 +29,6 @@ export default class SSHKeyListCmd extends Command {
`; `;
public static examples = ['$ balena ssh-key list']; public static examples = ['$ balena ssh-key list'];
public static flags = {
help: cf.help,
};
public static authenticated = true; public static authenticated = true;
public async run() { public async run() {

View File

@ -47,7 +47,6 @@ export default class SSHKeyRmCmd extends Command {
public static flags = { public static flags = {
yes: cf.yes, yes: cf.yes,
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -66,7 +66,6 @@ export default class SupportCmd extends Command {
'length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d', 'length of time to enable support for, in (h)ours or (d)ays, e.g. 12h, 2d',
char: 't', char: 't',
}), }),
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -54,7 +54,6 @@ export default class TagListCmd extends Command {
...cf.release, ...cf.release,
exclusive: ['fleet', 'device'], exclusive: ['fleet', 'device'],
}, },
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -57,7 +57,6 @@ export default class TagRmCmd extends Command {
...cf.release, ...cf.release,
exclusive: ['fleet', 'device'], exclusive: ['fleet', 'device'],
}, },
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -71,7 +71,6 @@ export default class TagSetCmd extends Command {
...cf.release, ...cf.release,
exclusive: ['fleet', 'device'], exclusive: ['fleet', 'device'],
}, },
help: cf.help,
}; };
public static authenticated = true; public static authenticated = true;

View File

@ -16,7 +16,6 @@
*/ */
import { Command } from '@oclif/core'; import { Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent, getChalk, getVisuals } from '../../utils/lazy'; import { stripIndent, getChalk, getVisuals } from '../../utils/lazy';
export default class UtilAvailableDrivesCmd extends Command { export default class UtilAvailableDrivesCmd extends Command {
@ -27,10 +26,6 @@ export default class UtilAvailableDrivesCmd extends Command {
Does not list system drives. Does not list system drives.
`; `;
public static flags = {
help: cf.help,
};
public static offlineCompatible = true; public static offlineCompatible = true;
public async run() { public async run() {

View File

@ -63,7 +63,6 @@ export default class VersionCmd extends Command {
description: description:
'output version information in JSON format for programmatic use', 'output version information in JSON format for programmatic use',
}), }),
help: Flags.help({ char: 'h' }),
}; };
public async run() { public async run() {

View File

@ -28,7 +28,7 @@ function getHelpSubject(args: string[]): string | undefined {
if (arg === '--') { if (arg === '--') {
return; return;
} }
if (arg === 'help' || arg === '--help' || arg === '-h') { if (arg === 'help' || arg === '--help') {
continue; continue;
} }
if (arg.startsWith('-')) { if (arg.startsWith('-')) {
@ -135,7 +135,7 @@ export default class BalenaHelp extends Help {
} }
const globalOps = [ const globalOps = [
['--help, -h', 'display command help'], ['--help', 'display command help'],
['--debug', 'enable debug output'], ['--debug', 'enable debug output'],
[ [
'--unsupported', '--unsupported',

View File

@ -40,8 +40,8 @@ export async function preparseArgs(argv: string[]): Promise<string[]> {
if (['--version', '-v'].includes(cmdSlice[0])) { if (['--version', '-v'].includes(cmdSlice[0])) {
cmdSlice[0] = 'version'; cmdSlice[0] = 'version';
} }
// convert 'balena --help' or 'balena -h' to 'balena help' // convert 'balena --help' to 'balena help'
else if (['--help', '-h'].includes(cmdSlice[0])) { else if ('--help' === cmdSlice[0]) {
cmdSlice[0] = 'help'; cmdSlice[0] = 'help';
} }
// convert e.g. 'balena help env set' to 'balena env set --help' // convert e.g. 'balena help env set' to 'balena env set --help'

View File

@ -4,7 +4,6 @@ import { getBalenaSdk } from './lazy';
export interface FlagsDef { export interface FlagsDef {
organization?: string; organization?: string;
type?: string; // application device type type?: string; // application device type
help: void;
} }
export interface ArgsDef { export interface ArgsDef {

View File

@ -30,8 +30,6 @@ export const device = Flags.string({
description: 'device UUID', description: 'device UUID',
}); });
export const help = Flags.help({ char: 'h' });
export const quiet = Flags.boolean({ export const quiet = Flags.boolean({
char: 'q', char: 'q',
description: 'suppress warning messages', description: 'suppress warning messages',

View File

@ -1,46 +0,0 @@
/**
* @license
* Copyright 2019-2020 Balena Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { expect } from 'chai';
import { BalenaAPIMock } from '../../nock/balena-api-mock';
import { cleanOutput, runCommand } from '../../helpers';
const HELP_MESSAGE = '';
describe('balena app create', function () {
let api: BalenaAPIMock;
beforeEach(() => {
api = new BalenaAPIMock();
});
afterEach(() => {
// Check all expected api calls have been made and clean up.
api.done();
});
// Temporarily skipped because of parse/checking order issue with -h
it.skip('should print help text with the -h flag', async () => {
api.expectGetWhoAmI({ optional: true });
const { out, err } = await runCommand('app create -h');
expect(cleanOutput(out)).to.deep.equal(cleanOutput([HELP_MESSAGE]));
expect(err).to.eql([]);
});
});

View File

@ -33,8 +33,8 @@ describe('balena device-type list', function () {
api.done(); api.done();
}); });
it('should print help text with the -h flag', async () => { it('should print help text with the --help flag', async () => {
const { out, err } = await runCommand('device-type list -h'); const { out, err } = await runCommand('device-type list --help');
expect(cleanOutput(out)).to.contain('$ balena device-type list'); expect(cleanOutput(out)).to.contain('$ balena device-type list');

View File

@ -98,7 +98,7 @@ const LIST_ADDITIONAL = `
const GLOBAL_OPTIONS = ` const GLOBAL_OPTIONS = `
GLOBAL OPTIONS GLOBAL OPTIONS
--help, -h --help
--debug --debug
`; `;