diff --git a/automation/capitanodoc/capitanodoc.ts b/automation/capitanodoc/capitanodoc.ts index 8b83b97f..1d0a9dd9 100644 --- a/automation/capitanodoc/capitanodoc.ts +++ b/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', diff --git a/docs/balena-cli.md b/docs/balena-cli.md index 19f31a37..638a9ed2 100644 --- a/docs/balena-cli.md +++ b/docs/balena-cli.md @@ -255,9 +255,9 @@ are encouraged to regularly update the balena CLI to the latest version. - [notes](#notes) -- Organization +- 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 @@ -2778,9 +2778,16 @@ device UUID -# Organization +# 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 diff --git a/src/commands/app/create.ts b/src/commands/app/create.ts index c6f4a21c..398c3603 100644 --- a/src/commands/app/create.ts +++ b/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 diff --git a/src/commands/block/create.ts b/src/commands/block/create.ts index dc2768c7..7b6a2301 100644 --- a/src/commands/block/create.ts +++ b/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 diff --git a/src/commands/fleet/create.ts b/src/commands/fleet/create.ts index da773dec..53fd8938 100644 --- a/src/commands/fleet/create.ts +++ b/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 diff --git a/src/commands/organization/list.ts b/src/commands/organization/list.ts index bd210d5b..544ebdea 100644 --- a/src/commands/organization/list.ts +++ b/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'); diff --git a/tests/test-data/pkg/expected-warnings-darwin-arm64.txt b/tests/test-data/pkg/expected-warnings-darwin-arm64.txt index 0c9d6467..366238b5 100644 --- a/tests/test-data/pkg/expected-warnings-darwin-arm64.txt +++ b/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 diff --git a/tests/test-data/pkg/expected-warnings-darwin-x64.txt b/tests/test-data/pkg/expected-warnings-darwin-x64.txt index f9f6649d..b13ae112 100644 --- a/tests/test-data/pkg/expected-warnings-darwin-x64.txt +++ b/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 diff --git a/tests/test-data/pkg/expected-warnings-linux-arm64.txt b/tests/test-data/pkg/expected-warnings-linux-arm64.txt index 0c9d6467..366238b5 100644 --- a/tests/test-data/pkg/expected-warnings-linux-arm64.txt +++ b/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 diff --git a/tests/test-data/pkg/expected-warnings-linux-x64.txt b/tests/test-data/pkg/expected-warnings-linux-x64.txt index f9f6649d..b13ae112 100644 --- a/tests/test-data/pkg/expected-warnings-linux-x64.txt +++ b/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 diff --git a/tests/test-data/pkg/expected-warnings-win32-x64.txt b/tests/test-data/pkg/expected-warnings-win32-x64.txt index 6961872a..10bca710 100644 --- a/tests/test-data/pkg/expected-warnings-win32-x64.txt +++ b/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