ExternalVendorCode/balena-cli
1
0
Fork 0
mirror of https://github.com/balena-io/balena-cli.git synced 2025-03-22 03:55:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
completion/_balena
View File

@ -29,7 +29,7 @@ _balena() {
_arguments -C \
'(- 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' \
'2:second command:_balena_sec_cmds' \
&& ret=0

2
completion/templates/zsh.template
View File

@ -14,7 +14,7 @@ $sub_cmds$
_arguments -C \
'(- 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' \
'2:second command:_balena_sec_cmds' \
&& ret=0

50
docs/balena-cli.md
View File

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

5
src/commands/api-key/generate.ts
View File

@ -17,7 +17,6 @@
import { Args, Command } from '@oclif/core';
import { ExpectedError } from '../../errors';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

1
src/commands/api-key/list.ts
View File

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

5
src/commands/api-key/revoke.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

2
src/commands/app/create.ts
View File

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

2
src/commands/block/create.ts
View File

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

4
src/commands/build/index.ts
View File

@ -44,7 +44,6 @@ interface FlagsDef extends ComposeCliFlags, DockerCliFlags {
deviceType?: string;
fleet?: string;
source?: string; // Not part of command profile - source param copied here.
help: void;
}
export default class BuildCmd extends Command {
@ -95,9 +94,6 @@ ${dockerignoreHelp}
fleet: cf.fleet,
...composeCliFlags,
...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;

1
src/commands/config/generate.ts
View File

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

1
src/commands/config/inject.ts
View File

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

1
src/commands/config/read.ts
View File

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

1
src/commands/config/reconfigure.ts
View File

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

1
src/commands/config/write.ts
View File

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

4
src/commands/deploy/index.ts
View File

@ -60,7 +60,6 @@ interface FlagsDef extends ComposeCliFlags, DockerCliFlags {
'release-tag'?: string[];
draft: boolean;
note?: string;
help: void;
}
export default class DeployCmd extends Command {
@ -139,9 +138,6 @@ ${dockerignoreHelp}
note: Flags.string({ description: 'The notes for this release' }),
...composeCliFlags,
...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;

2
src/commands/device-type/list.ts
View File

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

1
src/commands/device/deactivate.ts
View File

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

2
src/commands/device/detect.ts
View File

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

5
src/commands/device/identify.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

1
src/commands/device/index.ts
View File

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

2
src/commands/device/init.ts
View File

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

1
src/commands/device/list.ts
View File

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

2
src/commands/device/local-mode.ts
View File

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

2
src/commands/device/logs.ts
View File

@ -16,7 +16,6 @@
*/
import { Flags, Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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.',
char: 'S',
}),
help: cf.help,
};
public static primary = true;

1
src/commands/device/move.ts
View File

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

1
src/commands/device/note.ts
View File

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

1
src/commands/device/os-update.ts
View File

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

5
src/commands/device/pin.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

2
src/commands/device/public-url.ts
View File

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

5
src/commands/device/purge.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
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 async run() {

1
src/commands/device/reboot.ts
View File

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

2
src/commands/device/register.ts
View File

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

5
src/commands/device/rename.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
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 async run() {

2
src/commands/device/restart.ts
View File

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

1
src/commands/device/rm.ts
View File

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

1
src/commands/device/shutdown.ts
View File

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

2
src/commands/device/ssh.ts
View File

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

5
src/commands/device/start-service.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
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 async run() {

5
src/commands/device/stop-service.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getCliUx, stripIndent } from '../../utils/lazy';
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 async run() {

5
src/commands/device/track-fleet.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

2
src/commands/device/tunnel.ts
View File

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

1
src/commands/env/list.ts vendored
View File

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

2
src/commands/env/rename.ts vendored
View File

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

2
src/commands/env/set.ts vendored
View File

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

2
src/commands/fleet/create.ts
View File

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

1
src/commands/fleet/index.ts
View File

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

1
src/commands/fleet/list.ts
View File

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

5
src/commands/fleet/pin.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

5
src/commands/fleet/purge.ts
View File

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

5
src/commands/fleet/rename.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import * as ca from '../../utils/common-args';
import { getBalenaSdk, stripIndent, getCliForm } from '../../utils/lazy';
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 async run() {

5
src/commands/fleet/restart.ts
View File

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

1
src/commands/fleet/rm.ts
View File

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

5
src/commands/fleet/track-latest.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

1
src/commands/join/index.ts
View File

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

5
src/commands/leave/index.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy';
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 primary = true;

5
src/commands/local/configure.ts
View File

@ -17,7 +17,6 @@
import { Args, Command } from '@oclif/core';
import { promisify } from 'util';
import * as cf from '../../utils/common-flags';
import { stripIndent } from '../../utils/lazy';
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 offlineCompatible = true;

1
src/commands/local/flash.ts
View File

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

3
src/commands/login/index.ts
View File

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

5
src/commands/organization/list.ts
View File

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

2
src/commands/os/build-config.ts
View File

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

1
src/commands/os/configure.ts
View File

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

2
src/commands/os/download.ts
View File

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

1
src/commands/os/initialize.ts
View File

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

2
src/commands/os/versions.ts
View File

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

3
src/commands/preload/index.ts
View File

@ -128,9 +128,6 @@ Can be repeated to add multiple certificates.\
'Docker daemon TCP port number (hint: 2375 for balena devices)',
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;

2
src/commands/push/index.ts
View File

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

5
src/commands/release/finalize.ts
View File

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

1
src/commands/release/index.ts
View File

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

5
src/commands/release/invalidate.ts
View File

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

1
src/commands/release/list.ts
View File

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

5
src/commands/release/validate.ts
View File

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

5
src/commands/settings/index.ts
View File

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

5
src/commands/ssh-key/add.ts
View File

@ -17,7 +17,6 @@
import { Args, Command } from '@oclif/core';
import { ExpectedError } from '../../errors';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, stripIndent } from '../../utils/lazy';
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 async run() {

5
src/commands/ssh-key/index.ts
View File

@ -16,7 +16,6 @@
*/
import { Args, Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
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 async run() {

5
src/commands/ssh-key/list.ts
View File

@ -16,7 +16,6 @@
*/
import { Command } from '@oclif/core';
import * as cf from '../../utils/common-flags';
import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
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 flags = {
help: cf.help,
};
public static authenticated = true;
public async run() {

1
src/commands/ssh-key/rm.ts
View File

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

1
src/commands/support/index.ts
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',
char: 't',
}),
help: cf.help,
};
public static authenticated = true;

1
src/commands/tag/list.ts
View File

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

1
src/commands/tag/rm.ts
View File

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

1
src/commands/tag/set.ts
View File

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

5
src/commands/util/available-drives.ts
View File

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

1
src/commands/version/index.ts
View File

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

4
src/help.ts
View File

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

4
src/preparser.ts
View File

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

1
src/utils/application-create.ts
View File

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

2
src/utils/common-flags.ts
View File

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

46
tests/commands/app/create.spec.ts
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([]);
});
});

4
tests/commands/device-type/list.spec.ts
View File

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

2
tests/commands/help.spec.ts
View File

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