Merge pull request #2854 from balena-io/fleets-to-fleet-list

Add alias `fleet list` for `fleets` command

completion/_balena

@@ -8,7 +8,7 @@ _balena() {
   local context state line curcontext="$curcontext"
 
   # Valid top-level completions
-  main_commands=( api-key app block build config deploy device devices env envs fleet fleets internal join key keys leave local login logout logs notes orgs os preload push release releases scan settings ssh support tag tags tunnel util version whoami )
+  main_commands=( api-key app block build config deploy device devices env envs fleet internal join key keys leave local login logout logs notes orgs os preload push release releases scan settings ssh support tag tags tunnel util version whoami )
   # Sub-completions
   api_key_cmds=( generate list revoke )
   app_cmds=( create )
@@ -17,7 +17,7 @@ _balena() {
   device_cmds=( deactivate identify init list local-mode move os-update pin public-url purge reboot register rename restart rm shutdown start-service stop-service track-fleet )
   devices_cmds=( supported )
   env_cmds=( add rename rm )
-  fleet_cmds=( create pin purge rename restart rm track-latest )
+  fleet_cmds=( create list pin purge rename restart rm track-latest )
   internal_cmds=( osinit )
   key_cmds=( add rm )
   local_cmds=( configure flash )

completion/balena-completion.bash

@@ -7,7 +7,7 @@ _balena_complete()
   local cur prev
 
   # Valid top-level completions
-  main_commands="api-key app block build config deploy device devices env envs fleet fleets internal join key keys leave local login logout logs notes orgs os preload push release releases scan settings ssh support tag tags tunnel util version whoami"
+  main_commands="api-key app block build config deploy device devices env envs fleet internal join key keys leave local login logout logs notes orgs os preload push release releases scan settings ssh support tag tags tunnel util version whoami"
   # Sub-completions
   api_key_cmds="generate list revoke"
   app_cmds="create"
@@ -16,7 +16,7 @@ _balena_complete()
   device_cmds="deactivate identify init list local-mode move os-update pin public-url purge reboot register rename restart rm shutdown start-service stop-service track-fleet"
   devices_cmds="supported"
   env_cmds="add rename rm"
-  fleet_cmds="create pin purge rename restart rm track-latest"
+  fleet_cmds="create list pin purge rename restart rm track-latest"
   internal_cmds="osinit"
   key_cmds="add rm"
   local_cmds="configure flash"

docs/balena-cli.md

@@ -228,13 +228,13 @@ are encouraged to regularly update the balena CLI to the latest version.
 
 	- [fleet create](#fleet-create)
 	- [fleet](#fleet)
+	- [fleet list](#fleet-list)
 	- [fleet pin](#fleet-pin)
 	- [fleet purge](#fleet-purge)
 	- [fleet rename](#fleet-rename)
 	- [fleet restart](#fleet-restart)
 	- [fleet rm](#fleet-rm)
 	- [fleet track-latest](#fleet-track-latest)
-	- [fleets](#fleets)
 
 - Local
 
@@ -599,7 +599,7 @@ would otherwise be asked.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -1327,7 +1327,7 @@ namely:
 Possible arguments for the '--fleet', '--os-version' and '--drive' options can
 be listed respectively with the commands:
 
-'balena fleets'  
+'balena fleet list'
 'balena os versions'
 'balena util available-drives'
 
@@ -1337,7 +1337,7 @@ the latest released OS version for the fleet's default device type will be used.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -1413,7 +1413,7 @@ Devices can be filtered by fleet with the `--fleet` option.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -1487,7 +1487,7 @@ If --fleet is omitted, the fleet will be prompted for interactively.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -1667,7 +1667,7 @@ If --uuid is not provided, a new UUID will be automatically assigned.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -1928,7 +1928,7 @@ these reserved prefixes.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -2146,7 +2146,7 @@ in case the current user was removed from the fleet by the fleet's owner).
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -2240,7 +2240,7 @@ Display detailed information about a single fleet.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -2270,6 +2270,32 @@ open fleet dashboard page
 
 produce JSON output instead of tabular output
 
+## fleet list
+
+### Aliases
+
+- `fleets`
+
+
+To use one of the aliases, replace `fleet list` with the alias.
+
+### Description
+
+List all your balena fleets.
+
+For detailed information on a particular fleet, use
+`balena fleet <fleet>`
+
+Examples:
+
+	$ balena fleet list
+
+### Options
+
+#### -j, --json
+
+produce JSON output instead of tabular output
+
 ## fleet pin
 
 ### Description
@@ -2304,7 +2330,7 @@ This will clear the fleet's '/data' directory.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -2336,7 +2362,7 @@ prompted for interactively.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -2370,7 +2396,7 @@ Restart all devices belonging to a fleet.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -2401,7 +2427,7 @@ The --yes option may be used to avoid interactive confirmation.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -2446,25 +2472,6 @@ the slug of the fleet to make track the latest release
 
 ### Options
 
-## fleets
-
-### Description
-
-List all your balena fleets.
-
-For detailed information on a particular fleet, use
-`balena fleet <fleet>`
-
-Examples:
-
-	$ balena fleets
-
-### Options
-
-#### -j, --json
-
-produce JSON output instead of tabular output
-
 # Local
 
 ## local configure
@@ -2851,7 +2858,7 @@ https://developer.gnome.org/NetworkManager/stable/ref-settings.html
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -3088,7 +3095,7 @@ Likewise, if the fleet option is not provided then a picker will be shown.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -3170,7 +3177,7 @@ https://www.balena.io/docs/learn/more/masterclasses/advanced-cli/#5-preloading-a
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -3603,7 +3610,7 @@ the commit or ID of the release to validate
 List all releases of the given fleet.
 
 Fleets may be specified by fleet name or slug. Slugs are recommended because
-they are unique and unambiguous. Slugs can be listed with the `balena fleets`
+they are unique and unambiguous. Slugs can be listed with the `balena fleet list`
 command. Note that slugs may change if the fleet is renamed. Fleet names are
 not unique and may result in "Fleet is ambiguous" errors at any time (even if
 "it used to work in the past"), for example if the name clashes with a newly
@@ -3764,7 +3771,7 @@ a comma-separated list (with no spaces).
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -3808,7 +3815,7 @@ Remove a tag from a fleet, device or release.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -3856,7 +3863,7 @@ provided, a tag with an empty value is created.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -3907,7 +3914,7 @@ List all tags and their values for the specified fleet, device or release.
 
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the `balena fleets` command. Note that slugs may change if the
+listed with the `balena fleet list` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets

src/commands/device/init.ts

@@ -51,7 +51,7 @@ export default class DeviceInitCmd extends Command {
 		Possible arguments for the '--fleet', '--os-version' and '--drive' options can
 		be listed respectively with the commands:
 
-		'balena fleets'  
+		'balena fleet list'
 		'balena os versions'
 		'balena util available-drives'
 

src/commands/fleet/list.ts

@@ -26,7 +26,9 @@ interface ExtendedApplication extends ApplicationWithDeviceTypeSlug {
 	device_type?: string;
 }
 
-export default class FleetsCmd extends Command {
+export default class FleetListCmd extends Command {
+	public static aliases = ['fleets'];
+
 	public static description = stripIndent`
 		List all fleets.
 
@@ -36,7 +38,7 @@ export default class FleetsCmd extends Command {
 		\`balena fleet <fleet>\`
 	`;
 
-	public static examples = ['$ balena fleets'];
+	public static examples = ['$ balena fleet list'];
 
 	public static flags = {
 		help: cf.help,
@@ -47,7 +49,7 @@ export default class FleetsCmd extends Command {
 	public static primary = true;
 
 	public async run() {
-		const { flags: options } = await this.parse(FleetsCmd);
+		const { flags: options } = await this.parse(FleetListCmd);
 
 		const balena = getBalenaSdk();
 

src/help.ts

@@ -229,7 +229,6 @@ See: https://git.io/JRHUW#deprecation-policy`,
 		'push',
 		'logs',
 		'ssh',
-		'fleets',
 		'fleet',
 		'device',
 		'tunnel',

src/utils/messages.ts

@@ -139,7 +139,7 @@ adding exception patterns to the applicable .dockerignore file(s), for example
 export const applicationIdInfo = `\
 Fleets may be specified by fleet name or slug. Fleet slugs are
 the recommended option, as they are unique and unambiguous. Slugs can be
-listed with the \`balena fleets\` command. Note that slugs may change if the
+listed with the \`balena fleet list\` command. Note that slugs may change if the
 fleet is renamed. Fleet names are not unique and may result in  "Fleet is
 ambiguous" errors at any time (even if it "used to work in the past"), for
 example if the name clashes with a newly created public fleet, or with fleets
@@ -149,7 +149,7 @@ environments).`;
 
 export const applicationNameNote = `\
 Fleets may be specified by fleet name or slug. Slugs are recommended because
-they are unique and unambiguous. Slugs can be listed with the \`balena fleets\`
+they are unique and unambiguous. Slugs can be listed with the \`balena fleet list\`
 command. Note that slugs may change if the fleet is renamed. Fleet names are
 not unique and may result in "Fleet is ambiguous" errors at any time (even if
 "it used to work in the past"), for example if the name clashes with a newly

tests/test-data/pkg/expected-warnings-darwin-arm64.txt

@@ -145,6 +145,9 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/index.js
+> Warning Entry 'main' not found in %1
+  %1: node_modules/@oclif/core/package.json
+  %2: build/commands/fleet/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/pin.js
@@ -163,9 +166,6 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/track-latest.js
-> Warning Entry 'main' not found in %1
-  %1: node_modules/@oclif/core/package.json
-  %2: build/commands/fleets/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/internal/osinit.js

tests/test-data/pkg/expected-warnings-darwin-x64.txt

@@ -145,6 +145,9 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/index.js
+> Warning Entry 'main' not found in %1
+  %1: node_modules/@oclif/core/package.json
+  %2: build/commands/fleet/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/pin.js
@@ -163,9 +166,6 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/track-latest.js
-> Warning Entry 'main' not found in %1
-  %1: node_modules/@oclif/core/package.json
-  %2: build/commands/fleets/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/internal/osinit.js

tests/test-data/pkg/expected-warnings-linux-arm64.txt

@@ -145,6 +145,9 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/index.js
+> Warning Entry 'main' not found in %1
+  %1: node_modules/@oclif/core/package.json
+  %2: build/commands/fleet/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/pin.js
@@ -163,9 +166,6 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/track-latest.js
-> Warning Entry 'main' not found in %1
-  %1: node_modules/@oclif/core/package.json
-  %2: build/commands/fleets/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/internal/osinit.js

tests/test-data/pkg/expected-warnings-linux-x64.txt

@@ -145,6 +145,9 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/index.js
+> Warning Entry 'main' not found in %1
+  %1: node_modules/@oclif/core/package.json
+  %2: build/commands/fleet/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/pin.js
@@ -163,9 +166,6 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/fleet/track-latest.js
-> Warning Entry 'main' not found in %1
-  %1: node_modules/@oclif/core/package.json
-  %2: build/commands/fleets/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/internal/osinit.js

tests/test-data/pkg/expected-warnings-win32-x64.txt

@@ -145,6 +145,9 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules\@oclif\core\package.json
   %2: build\commands\fleet\index.js
+> Warning Entry 'main' not found in %1
+  %1: node_modules\@oclif\core\package.json
+  %2: build\commands\fleet\list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules\@oclif\core\package.json
   %2: build\commands\fleet\pin.js
@@ -163,9 +166,6 @@
 > Warning Entry 'main' not found in %1
   %1: node_modules\@oclif\core\package.json
   %2: build\commands\fleet\track-latest.js
-> Warning Entry 'main' not found in %1
-  %1: node_modules\@oclif\core\package.json
-  %2: build\commands\fleets\index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules\@oclif\core\package.json
   %2: build\commands\internal\osinit.js