diff --git a/.changelog/3580.txt b/.changelog/3580.txt new file mode 100644 index 00000000000..2f939694bea --- /dev/null +++ b/.changelog/3580.txt @@ -0,0 +1,3 @@ +```release-note:improvement +cli: Fix incorrect description for `destroy -h` command. +``` diff --git a/internal/cli/destroy.go b/internal/cli/destroy.go index 84226c3382b..7775dd3ff55 100644 --- a/internal/cli/destroy.go +++ b/internal/cli/destroy.go @@ -91,17 +91,19 @@ func (c *DestroyCommand) Help() string { return formatHelp(` Usage: waypoint destroy [options] - Delete all resources created for an app or project in the current workspace. + Delete all resources created for all apps or project in the current workspace. + Specify the -app to select a given app to delete resources for in a given + workspace. The workspace can continue to be used after this call, this just deletes - all the resources created for this app up to this point. + all the resources created for all apps in the workspace up to this point. This functionality must be supported by the plugins in use and is dependent on their behavior. The expected behavior is that any physical resources created as part of deploys and releases are destroyed. For example, any load balancers, VMs, containers, etc. - This targets one app in one workspace. You must call this for each workspace + This targets apps in one workspace. You must call this for each workspace you've used if you want to destroy everything. ` + c.Flags().Help()) diff --git a/website/content/commands/destroy.mdx b/website/content/commands/destroy.mdx index a99e2fcfc12..d4165c89141 100644 --- a/website/content/commands/destroy.mdx +++ b/website/content/commands/destroy.mdx @@ -17,17 +17,19 @@ Delete all the resources created Usage: `waypoint destroy [options]` -Delete all resources created for an app or project in the current workspace. +Delete all resources created for all apps or project in the current workspace. +Specify the -app to select a given app to delete resources for in a given +workspace. The workspace can continue to be used after this call, this just deletes -all the resources created for this app up to this point. +all the resources created for all apps in the workspace up to this point. This functionality must be supported by the plugins in use and is dependent on their behavior. The expected behavior is that any physical resources created as part of deploys and releases are destroyed. For example, any load balancers, VMs, containers, etc. -This targets one app in one workspace. You must call this for each workspace +This targets apps in one workspace. You must call this for each workspace you've used if you want to destroy everything. #### Global Options