docs: include helpValue for flags that need UUIDs

.changeset/orange-fireants-hammer.md

@@ -0,0 +1,5 @@
+---
+"@smartthings/cli": patch
+---
+
+removed `-id` suffix from flags, update help text to reflect this

packages/cli/src/commands/devices.ts

@@ -17,6 +17,7 @@ export default class DevicesCommand extends APICommand<typeof DevicesCommand.fla
 			char: 'l',
 			description: 'filter results by location',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		capability: Flags.string({
 			char: 'c',
@@ -34,11 +35,13 @@ export default class DevicesCommand extends APICommand<typeof DevicesCommand.fla
 			char: 'd',
 			description: 'filter results by device',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		// eslint-disable-next-line @typescript-eslint/naming-convention
 		'installed-app': Flags.string({
 			char: 'a',
 			description: 'filter results by installed app that created the device',
+			helpValue: '<UUID>',
 		}),
 		status: Flags.boolean({
 			char: 's',

packages/cli/src/commands/installedapps.ts

@@ -16,6 +16,7 @@ export default class InstalledAppsCommand extends APICommand<typeof InstalledApp
 			char: 'l',
 			description: 'filter results by location',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		verbose: Flags.boolean({
 			description: 'include location name in output',

packages/cli/src/commands/installedapps/delete.ts

@@ -14,6 +14,7 @@ export default class InstalledAppDeleteCommand extends APICommand<typeof Install
 			char: 'l',
 			description: 'filter results by location',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		verbose: Flags.boolean({
 			description: 'include location name in output',

packages/cli/src/commands/installedapps/rename.ts

@@ -17,6 +17,7 @@ export default class InstalledAppRenameCommand extends APICommand<typeof Install
 			char: 'l',
 			description: 'filter results by location',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		verbose: Flags.boolean({
 			description: 'include location name in output',

packages/cli/src/commands/installedschema.ts

@@ -21,6 +21,7 @@ export default class InstalledSchemaAppsCommand extends APICommand<typeof Instal
 			char: 'l',
 			description: 'filter results by location',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		verbose: Flags.boolean({
 			description: 'include location name in output',

packages/cli/src/commands/installedschema/delete.ts

@@ -16,6 +16,7 @@ export default class InstalledSchemaAppDeleteCommand extends APICommand<typeof I
 			char: 'l',
 			description: 'filter results by location',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		verbose: Flags.boolean({
 			description: 'include location name in output',

packages/cli/src/commands/locations/rooms.ts

@@ -15,6 +15,7 @@ export default class RoomsCommand extends APICommand<typeof RoomsCommand.flags>
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 		verbose: Flags.boolean({
 			description: 'include location name in output',

packages/cli/src/commands/locations/rooms/create.ts

@@ -14,6 +14,7 @@ export default class RoomsCreateCommand extends APICommand<typeof RoomsCreateCom
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/locations/rooms/delete.ts

@@ -11,6 +11,7 @@ export default class RoomsDeleteCommand extends APICommand<typeof RoomsDeleteCom
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/locations/rooms/update.ts

@@ -13,6 +13,7 @@ export default class RoomsUpdateCommand extends APICommand<typeof RoomsUpdateCom
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/rules.ts

@@ -16,6 +16,7 @@ export default class RulesCommand extends APICommand<typeof RulesCommand.flags>
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/rules/create.ts

@@ -17,6 +17,7 @@ export default class RulesCreateCommand extends APICommand<typeof RulesCreateCom
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/rules/delete.ts

@@ -13,6 +13,7 @@ export default class RulesDeleteCommand extends APICommand<typeof RulesDeleteCom
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/rules/execute.ts

@@ -16,6 +16,7 @@ export default class RulesExecuteCommand extends APICommand<typeof RulesExecuteC
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/rules/update.ts

@@ -16,6 +16,7 @@ export default class RulesUpdateCommand extends APICommand<typeof RulesUpdateCom
 		location: Flags.string({
 			char: 'l',
 			description: 'a specific location to query',
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/scenes.ts

@@ -17,6 +17,7 @@ export default class ScenesCommand extends APICommand<typeof ScenesCommand.flags
 			char: 'l',
 			description: 'a specific location to query',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 	}
 

packages/cli/src/commands/virtualdevices.ts

@@ -26,11 +26,13 @@ export default class VirtualDevicesCommand extends APICommand<typeof VirtualDevi
 			char: 'l',
 			description: 'filter results by location',
 			multiple: true,
+			helpValue: '<UUID>',
 		}),
 		// eslint-disable-next-line @typescript-eslint/naming-convention
 		'installed-app': Flags.string({
 			char: 'a',
 			description: 'filter results by installed app that created the device',
+			helpValue: '<UUID>',
 		}),
 		verbose: Flags.boolean({
 			description: 'include location name in output',

packages/cli/src/commands/virtualdevices/create-standard.ts

@@ -43,10 +43,12 @@ export default class VirtualDeviceCreateStandardCommand extends APICommand<typeo
 		location: Flags.string({
 			char: 'l',
 			description: 'location into which device should be created',
+			helpValue: '<UUID>',
 		}),
 		room: Flags.string({
 			char: 'R',
 			description: 'the room to put the device into',
+			helpValue: '<UUID>',
 		}),
 		prototype: Flags.string({
 			char: 'T',

packages/cli/src/commands/virtualdevices/create.ts

@@ -45,15 +45,18 @@ export default class VirtualDeviceCreateCommand extends APIOrganizationCommand<t
 		location: Flags.string({
 			char: 'l',
 			description: 'location into which device should be created',
+			helpValue: '<UUID>',
 		}),
 		room: Flags.string({
 			char: 'R',
 			description: 'the room to put the device into',
+			helpValue: '<UUID>',
 		}),
 		/* eslint-disable @typescript-eslint/naming-convention */
 		'device-profile': Flags.string({
 			char: 'P',
 			description: 'the device profile ID',
+			helpValue: '<UUID>',
 		}),
 		'device-profile-file': Flags.string({
 			char: 'f',