Merge pull request #2861 from balena-io/orgs-to-organization-list

Orgs to organization list

automation/capitanodoc/capitanodoc.ts

@@ -58,7 +58,7 @@ const commandHeadings: { [key: string]: string } = {
 	env: 'Environment Variables',
 	help: 'Help and Version',
 	'ssh-key': 'SSH Keys',
-	orgs: 'Organizations',
+	organization: 'Organizations',
 	os: 'OS',
 	util: 'Utilities',
 	ssh: 'Network',

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 fleet internal join leave local login logout logs notes orgs os preload push release scan settings ssh ssh-key support tag tunnel util version whoami )
+  main_commands=( api-key app block build config deploy device devices env fleet internal join leave local login logout logs notes organization os preload push release scan settings ssh ssh-key support tag tunnel util version whoami )
   # Sub-completions
   api_key_cmds=( generate list revoke )
   app_cmds=( create )
@@ -20,6 +20,7 @@ _balena() {
   fleet_cmds=( create list pin purge rename restart rm track-latest )
   internal_cmds=( osinit )
   local_cmds=( configure flash )
+  organization_cmds=( list )
   os_cmds=( build-config configure download initialize versions )
   release_cmds=( finalize invalidate list validate )
   ssh_key_cmds=( add list rm )
@@ -72,6 +73,9 @@ _balena_sec_cmds() {
       "local")
         _describe -t local_cmds 'local_cmd' local_cmds "$@" && ret=0
       ;;
+      "organization")
+        _describe -t organization_cmds 'organization_cmd' organization_cmds "$@" && ret=0
+      ;;
       "os")
         _describe -t os_cmds 'os_cmd' os_cmds "$@" && ret=0
       ;;

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 fleet internal join leave local login logout logs notes orgs os preload push release scan settings ssh ssh-key support tag tunnel util version whoami"
+  main_commands="api-key app block build config deploy device devices env fleet internal join leave local login logout logs notes organization os preload push release scan settings ssh ssh-key support tag tunnel util version whoami"
   # Sub-completions
   api_key_cmds="generate list revoke"
   app_cmds="create"
@@ -19,6 +19,7 @@ _balena_complete()
   fleet_cmds="create list pin purge rename restart rm track-latest"
   internal_cmds="osinit"
   local_cmds="configure flash"
+  organization_cmds="list"
   os_cmds="build-config configure download initialize versions"
   release_cmds="finalize invalidate list validate"
   ssh_key_cmds="add list rm"
@@ -66,6 +67,9 @@ _balena_complete()
       local)
         COMPREPLY=( $(compgen -W "$local_cmds" -- $cur) )
         ;;
+      organization)
+        COMPREPLY=( $(compgen -W "$organization_cmds" -- $cur) )
+        ;;
       os)
         COMPREPLY=( $(compgen -W "$os_cmds" -- $cur) )
         ;;

docs/balena-cli.md

@@ -257,7 +257,7 @@ are encouraged to regularly update the balena CLI to the latest version.
 
 - Organizations
 
-	- [orgs](#orgs)
+	- [organization list](#organization-list)
 
 - OS
 
@@ -403,7 +403,7 @@ Create a new balena app.
 You can specify the organization the app should belong to using
 the `--organization` option. The organization's handle, not its name,
 should be provided. Organization handles can be listed with the
-`balena orgs` command.
+`balena organization list` command.
 
 The app's default device type is specified with the `--type` option.
 The `balena devices supported` command can be used to list the available
@@ -533,7 +533,7 @@ Create a new balena block.
 You can specify the organization the block should belong to using
 the `--organization` option. The organization's handle, not its name,
 should be provided. Organization handles can be listed with the
-`balena orgs` command.
+`balena organization list` command.
 
 The block's default device type is specified with the `--type` option.
 The `balena devices supported` command can be used to list the available
@@ -2205,7 +2205,7 @@ Create a new balena fleet.
 You can specify the organization the fleet should belong to using
 the `--organization` option. The organization's handle, not its name,
 should be provided. Organization handles can be listed with the
-`balena orgs` command.
+`balena organization list` command.
 
 The fleet's default device type is specified with the `--type` option.
 The `balena devices supported` command can be used to list the available
@@ -2780,7 +2780,14 @@ device UUID
 
 # Organizations
 
-## orgs
+## organization list
+
+### Aliases
+
+- `orgs`
+
+
+To use one of the aliases, replace `organization list` with the alias.
 
 ### Description
 
@@ -2788,7 +2795,7 @@ list all the organizations that you are a member of.
 
 Examples:
 
-	$ balena orgs
+	$ balena organization list
 
 ### Options
 

src/commands/app/create.ts

@@ -28,7 +28,7 @@ export default class AppCreateCmd extends Command {
 		You can specify the organization the app should belong to using
 		the \`--organization\` option. The organization's handle, not its name,
 		should be provided. Organization handles can be listed with the
-		\`balena orgs\` command.
+		\`balena organization list\` command.
 
 		The app's default device type is specified with the \`--type\` option.
 		The \`balena devices supported\` command can be used to list the available

src/commands/block/create.ts

@@ -28,7 +28,7 @@ export default class BlockCreateCmd extends Command {
 		You can specify the organization the block should belong to using
 		the \`--organization\` option. The organization's handle, not its name,
 		should be provided. Organization handles can be listed with the
-		\`balena orgs\` command.
+		\`balena organization list\` command.
 
 		The block's default device type is specified with the \`--type\` option.
 		The \`balena devices supported\` command can be used to list the available

src/commands/fleet/create.ts

@@ -28,7 +28,7 @@ export default class FleetCreateCmd extends Command {
 		You can specify the organization the fleet should belong to using
 		the \`--organization\` option. The organization's handle, not its name,
 		should be provided. Organization handles can be listed with the
-		\`balena orgs\` command.
+		\`balena organization list\` command.
 
 		The fleet's default device type is specified with the \`--type\` option.
 		The \`balena devices supported\` command can be used to list the available

src/commands/organization/list.ts

@@ -19,13 +19,15 @@ import { Command } from '@oclif/core';
 import * as cf from '../../utils/common-flags';
 import { getBalenaSdk, getVisuals, stripIndent } from '../../utils/lazy';
 
-export default class OrgsCmd extends Command {
+export default class OrganizationListCmd extends Command {
+	public static aliases = ['orgs'];
+
 	public static description = stripIndent`
 		List all organizations.
 
 		list all the organizations that you are a member of.
 `;
-	public static examples = ['$ balena orgs'];
+	public static examples = ['$ balena organization list'];
 
 	public static flags = {
 		help: cf.help,
@@ -34,7 +36,7 @@ export default class OrgsCmd extends Command {
 	public static authenticated = true;
 
 	public async run() {
-		await this.parse(OrgsCmd);
+		await this.parse(OrganizationListCmd);
 
 		const { getOwnOrganizations } = await import('../../utils/sdk');
 

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

@@ -195,7 +195,7 @@
   %2: build/commands/notes/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
-  %2: build/commands/orgs/index.js
+  %2: build/commands/organization/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/os/build-config.js

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

@@ -195,7 +195,7 @@
   %2: build/commands/notes/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
-  %2: build/commands/orgs/index.js
+  %2: build/commands/organization/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/os/build-config.js

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

@@ -195,7 +195,7 @@
   %2: build/commands/notes/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
-  %2: build/commands/orgs/index.js
+  %2: build/commands/organization/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/os/build-config.js

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

@@ -195,7 +195,7 @@
   %2: build/commands/notes/index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
-  %2: build/commands/orgs/index.js
+  %2: build/commands/organization/list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules/@oclif/core/package.json
   %2: build/commands/os/build-config.js

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

@@ -195,7 +195,7 @@
   %2: build\commands\notes\index.js
 > Warning Entry 'main' not found in %1
   %1: node_modules\@oclif\core\package.json
-  %2: build\commands\orgs\index.js
+  %2: build\commands\organization\list.js
 > Warning Entry 'main' not found in %1
   %1: node_modules\@oclif\core\package.json
   %2: build\commands\os\build-config.js