github.com/jenspinney/cli@v6.42.1-0.20190207184520-7450c600020e+incompatible/command/common/command_list_v7.go (about) 1 // +build V7 2 3 package common 4 5 import ( 6 "reflect" 7 8 "code.cloudfoundry.org/cli/command/plugin" 9 "code.cloudfoundry.org/cli/command/v6" 10 "code.cloudfoundry.org/cli/command/v7" 11 ) 12 13 var Commands commandList 14 var FallbackCommands V2CommandList 15 16 type V2CommandList struct { 17 V2App v6.V3AppCommand `command:"app" description:"Display health and status for an app"` 18 } 19 20 type commandList struct { 21 VerboseOrVersion bool `short:"v" long:"version" description:"verbose and version flag"` 22 23 App v7.AppCommand `command:"app" description:"Display health and status for an app"` 24 V3ApplyManifest v6.V3ApplyManifestCommand `command:"v3-apply-manifest" description:"Applies manifest properties to an application"` 25 V3Apps v6.V3AppsCommand `command:"v3-apps" description:"List all apps in the target space"` 26 V3CancelZdtPush v6.V3CancelZdtPushCommand `command:"v3-cancel-zdt-push" description:"Cancel the most recent deployment for an app"` 27 V3CreateApp v6.V3CreateAppCommand `command:"v3-create-app" description:"Create a V3 App"` 28 V3CreatePackage v6.V3CreatePackageCommand `command:"v3-create-package" description:"Uploads a V3 Package"` 29 V3Droplets v6.V3DropletsCommand `command:"v3-droplets" description:"List droplets of an app"` 30 V3Packages v6.V3PackagesCommand `command:"v3-packages" description:"List packages of an app"` 31 V3Restart v6.V3RestartCommand `command:"v3-restart" description:"Stop all instances of the app, then start them again. This causes downtime."` 32 V3RestartAppInstance v6.V3RestartAppInstanceCommand `command:"v3-restart-app-instance" description:"Terminate, then instantiate an app instance"` 33 V3SetDroplet v6.V3SetDropletCommand `command:"v3-set-droplet" description:"Set the droplet used to run an app"` 34 V3Stage v6.V3StageCommand `command:"v3-stage" description:"Create a new droplet for an app"` 35 V3Start v6.V3StartCommand `command:"v3-start" description:"Start an app"` 36 V3Stop v6.V3StopCommand `command:"v3-stop" description:"Stop an app"` 37 V3ZdtRestart v6.V3ZeroDowntimeRestartCommand `command:"v3-zdt-restart" description:"Sequentially restart each instance of an app."` 38 39 AddPluginRepo plugin.AddPluginRepoCommand `command:"add-plugin-repo" description:"Add a new plugin repository"` 40 AddNetworkPolicy v6.AddNetworkPolicyCommand `command:"add-network-policy" description:"Create policy to allow direct network traffic from one app to another"` 41 AllowSpaceSSH v6.AllowSpaceSSHCommand `command:"allow-space-ssh" description:"Allow SSH access for the space"` 42 Api v6.ApiCommand `command:"api" description:"Set or view target api url"` 43 Apps v6.AppsCommand `command:"apps" alias:"a" description:"List all apps in the target space"` 44 Auth v6.AuthCommand `command:"auth" description:"Authenticate non-interactively"` 45 BindRouteService v6.BindRouteServiceCommand `command:"bind-route-service" alias:"brs" description:"Bind a service instance to an HTTP route"` 46 BindRunningSecurityGroup v6.BindRunningSecurityGroupCommand `command:"bind-running-security-group" description:"Bind a security group to the list of security groups to be used for running applications"` 47 BindSecurityGroup v6.BindSecurityGroupCommand `command:"bind-security-group" description:"Bind a security group to a particular space, or all existing spaces of an org"` 48 BindService v6.BindServiceCommand `command:"bind-service" alias:"bs" description:"Bind a service instance to an app"` 49 BindStagingSecurityGroup v6.BindStagingSecurityGroupCommand `command:"bind-staging-security-group" description:"Bind a security group to the list of security groups to be used for staging applications"` 50 Buildpacks v7.BuildpacksCommand `command:"buildpacks" description:"List all buildpacks"` 51 CheckRoute v6.CheckRouteCommand `command:"check-route" description:"Perform a simple check to determine whether a route currently exists or not"` 52 Config v6.ConfigCommand `command:"config" description:"Write default values to the config"` 53 CopySource v6.CopySourceCommand `command:"copy-source" description:"Copies the source code of an application to another existing application (and restarts that application)"` 54 CreateAppManifest v7.CreateAppManifestCommand `command:"create-app-manifest" description:"Create an app manifest for an app that has been pushed successfully"` 55 CreateBuildpack v7.CreateBuildpackCommand `command:"create-buildpack" description:"Create a buildpack"` 56 CreateDomain v6.CreateDomainCommand `command:"create-domain" description:"Create a domain in an org for later use"` 57 CreateIsolationSegment v6.CreateIsolationSegmentCommand `command:"create-isolation-segment" description:"Create an isolation segment"` 58 CreateOrg v6.CreateOrgCommand `command:"create-org" alias:"co" description:"Create an org"` 59 CreateQuota v6.CreateQuotaCommand `command:"create-quota" description:"Define a new resource quota"` 60 CreateRoute v6.CreateRouteCommand `command:"create-route" description:"Create a url route in a space for later use"` 61 CreateSecurityGroup v6.CreateSecurityGroupCommand `command:"create-security-group" description:"Create a security group"` 62 CreateServiceBroker v6.CreateServiceBrokerCommand `command:"create-service-broker" alias:"csb" description:"Create a service broker"` 63 CreateServiceKey v6.CreateServiceKeyCommand `command:"create-service-key" alias:"csk" description:"Create key for a service instance"` 64 CreateService v6.CreateServiceCommand `command:"create-service" alias:"cs" description:"Create a service instance"` 65 CreateSharedDomain v6.CreateSharedDomainCommand `command:"create-shared-domain" description:"Create a domain that can be used by all orgs (admin-only)"` 66 CreateSpaceQuota v6.CreateSpaceQuotaCommand `command:"create-space-quota" description:"Define a new space resource quota"` 67 CreateSpace v6.CreateSpaceCommand `command:"create-space" description:"Create a space"` 68 CreateUserProvidedService v6.CreateUserProvidedServiceCommand `command:"create-user-provided-service" alias:"cups" description:"Make a user-provided service instance available to CF apps"` 69 CreateUser v6.CreateUserCommand `command:"create-user" description:"Create a new user"` 70 Curl v6.CurlCommand `command:"curl" description:"Executes a request to the targeted API endpoint"` 71 DeleteBuildpack v7.DeleteBuildpackCommand `command:"delete-buildpack" description:"Delete a buildpack"` 72 DeleteDomain v6.DeleteDomainCommand `command:"delete-domain" description:"Delete a domain"` 73 DeleteIsolationSegment v6.DeleteIsolationSegmentCommand `command:"delete-isolation-segment" description:"Delete an isolation segment"` 74 DeleteOrg v6.DeleteOrgCommand `command:"delete-org" description:"Delete an org"` 75 DeleteOrphanedRoutes v6.DeleteOrphanedRoutesCommand `command:"delete-orphaned-routes" description:"Delete all orphaned routes (i.e. those that are not mapped to an app)"` 76 DeleteQuota v6.DeleteQuotaCommand `command:"delete-quota" description:"Delete a quota"` 77 DeleteRoute v6.DeleteRouteCommand `command:"delete-route" description:"Delete a route"` 78 DeleteSecurityGroup v6.DeleteSecurityGroupCommand `command:"delete-security-group" description:"Deletes a security group"` 79 DeleteServiceBroker v6.DeleteServiceBrokerCommand `command:"delete-service-broker" description:"Delete a service broker"` 80 DeleteServiceKey v6.DeleteServiceKeyCommand `command:"delete-service-key" alias:"dsk" description:"Delete a service key"` 81 DeleteService v6.DeleteServiceCommand `command:"delete-service" alias:"ds" description:"Delete a service instance"` 82 DeleteSharedDomain v6.DeleteSharedDomainCommand `command:"delete-shared-domain" description:"Delete a shared domain"` 83 DeleteSpaceQuota v6.DeleteSpaceQuotaCommand `command:"delete-space-quota" description:"Delete a space quota definition and unassign the space quota from all spaces"` 84 DeleteSpace v6.DeleteSpaceCommand `command:"delete-space" description:"Delete a space"` 85 DeleteUser v6.DeleteUserCommand `command:"delete-user" description:"Delete a user"` 86 Delete v7.DeleteCommand `command:"delete" alias:"d" description:"Delete an app"` 87 DisableFeatureFlag v6.DisableFeatureFlagCommand `command:"disable-feature-flag" description:"Prevent use of a feature"` 88 DisableOrgIsolation v6.DisableOrgIsolationCommand `command:"disable-org-isolation" description:"Revoke an organization's entitlement to an isolation segment"` 89 DisableServiceAccess v6.DisableServiceAccessCommand `command:"disable-service-access" description:"Disable access to a service or service plan for one or all orgs"` 90 DisableSSH v6.DisableSSHCommand `command:"disable-ssh" description:"Disable ssh for the application"` 91 DisallowSpaceSSH v6.DisallowSpaceSSHCommand `command:"disallow-space-ssh" description:"Disallow SSH access for the space"` 92 Domains v6.DomainsCommand `command:"domains" description:"List domains in the target org"` 93 EnableFeatureFlag v6.EnableFeatureFlagCommand `command:"enable-feature-flag" description:"Allow use of a feature"` 94 EnableOrgIsolation v6.EnableOrgIsolationCommand `command:"enable-org-isolation" description:"Entitle an organization to an isolation segment"` 95 EnableServiceAccess v6.EnableServiceAccessCommand `command:"enable-service-access" description:"Enable access to a service or service plan for one or all orgs"` 96 EnableSSH v6.EnableSSHCommand `command:"enable-ssh" description:"Enable ssh for the application"` 97 Env v7.EnvCommand `command:"env" alias:"e" description:"Show all env variables for an app"` 98 Events v6.EventsCommand `command:"events" description:"Show recent app events"` 99 FeatureFlags v6.FeatureFlagsCommand `command:"feature-flags" description:"Retrieve list of feature flags with status"` 100 FeatureFlag v6.FeatureFlagCommand `command:"feature-flag" description:"Retrieve an individual feature flag with status"` 101 GetHealthCheck v7.GetHealthCheckCommand `command:"get-health-check" description:"Show the type of health check performed on an app"` 102 Help HelpCommand `command:"help" alias:"h" description:"Show help"` 103 InstallPlugin InstallPluginCommand `command:"install-plugin" description:"Install CLI plugin"` 104 IsolationSegments v6.IsolationSegmentsCommand `command:"isolation-segments" description:"List all isolation segments"` 105 NetworkPolicies v6.NetworkPoliciesCommand `command:"network-policies" description:"List direct network traffic policies"` 106 ListPluginRepos plugin.ListPluginReposCommand `command:"list-plugin-repos" description:"List all the added plugin repositories"` 107 Login v6.LoginCommand `command:"login" alias:"l" description:"Log user in"` 108 Logout v6.LogoutCommand `command:"logout" alias:"lo" description:"Log user out"` 109 Logs v6.LogsCommand `command:"logs" description:"Tail or show recent logs for an app"` 110 MapRoute v6.MapRouteCommand `command:"map-route" description:"Add a url route to an app"` 111 Marketplace v6.MarketplaceCommand `command:"marketplace" alias:"m" description:"List available offerings in the marketplace"` 112 OauthToken v6.OauthTokenCommand `command:"oauth-token" description:"Retrieve and display the OAuth token for the current session"` 113 Orgs v6.OrgsCommand `command:"orgs" alias:"o" description:"List all orgs"` 114 OrgUsers v6.OrgUsersCommand `command:"org-users" description:"Show org users by role"` 115 Org v6.OrgCommand `command:"org" description:"Show org info"` 116 Passwd v6.PasswdCommand `command:"passwd" alias:"pw" description:"Change user password"` 117 Plugins plugin.PluginsCommand `command:"plugins" description:"List commands of installed plugins"` 118 PurgeServiceInstance v6.PurgeServiceInstanceCommand `command:"purge-service-instance" description:"Recursively remove a service instance and child objects from Cloud Foundry database without making requests to a service broker"` 119 PurgeServiceOffering v6.PurgeServiceOfferingCommand `command:"purge-service-offering" description:"Recursively remove a service and child objects from Cloud Foundry database without making requests to a service broker"` 120 Push v7.PushCommand `command:"push" alias:"p" description:"Push a new app or sync changes to an existing app"` 121 V3Push v7.PushCommand `command:"v3-push" description:"Push a new app or sync changes to an existing app" hidden:"true"` 122 Quotas v6.QuotasCommand `command:"quotas" description:"List available usage quotas"` 123 Quota v6.QuotaCommand `command:"quota" description:"Show quota info"` 124 RemoveNetworkPolicy v6.RemoveNetworkPolicyCommand `command:"remove-network-policy" description:"Remove network traffic policy of an app"` 125 RemovePluginRepo plugin.RemovePluginRepoCommand `command:"remove-plugin-repo" description:"Remove a plugin repository"` 126 RenameBuildpack v6.RenameBuildpackCommand `command:"rename-buildpack" description:"Rename a buildpack"` 127 RenameOrg v6.RenameOrgCommand `command:"rename-org" description:"Rename an org"` 128 RenameServiceBroker v6.RenameServiceBrokerCommand `command:"rename-service-broker" description:"Rename a service broker"` 129 RenameService v6.RenameServiceCommand `command:"rename-service" description:"Rename a service instance"` 130 RenameSpace v6.RenameSpaceCommand `command:"rename-space" description:"Rename a space"` 131 Rename v6.RenameCommand `command:"rename" description:"Rename an app"` 132 RepoPlugins plugin.RepoPluginsCommand `command:"repo-plugins" description:"List all available plugins in specified repository or in all added repositories"` 133 ResetOrgDefaultIsolationSegment v6.ResetOrgDefaultIsolationSegmentCommand `command:"reset-org-default-isolation-segment" description:"Reset the default isolation segment used for apps in spaces of an org"` 134 ResetSpaceIsolationSegment v6.ResetSpaceIsolationSegmentCommand `command:"reset-space-isolation-segment" description:"Reset the space's isolation segment to the org default"` 135 Restage v6.RestageCommand `command:"restage" alias:"rg" description:"Recreate the app's executable artifact using the latest pushed app files and the latest environment (variables, service bindings, buildpack, stack, etc.). This action will cause app downtime."` 136 RestartAppInstance v6.RestartAppInstanceCommand `command:"restart-app-instance" description:"Terminate, then restart an app instance"` 137 Restart v6.RestartCommand `command:"restart" alias:"rs" description:"Stop all instances of the app, then start them again. This causes downtime."` 138 RouterGroups v6.RouterGroupsCommand `command:"router-groups" description:"List router groups"` 139 Routes v6.RoutesCommand `command:"routes" alias:"r" description:"List all routes in the current space or the current organization"` 140 RunningEnvironmentVariableGroup v6.RunningEnvironmentVariableGroupCommand `command:"running-environment-variable-group" alias:"revg" description:"Retrieve the contents of the running environment variable group"` 141 RunningSecurityGroups v6.RunningSecurityGroupsCommand `command:"running-security-groups" description:"List security groups in the set of security groups for running applications"` 142 RunTask v6.RunTaskCommand `command:"run-task" alias:"rt" description:"Run a one-off task on an app"` 143 Scale v7.ScaleCommand `command:"scale" description:"Change or view the instance count, disk space limit, and memory limit for an app"` 144 SecurityGroups v6.SecurityGroupsCommand `command:"security-groups" description:"List all security groups"` 145 SecurityGroup v6.SecurityGroupCommand `command:"security-group" description:"Show a single security group"` 146 ServiceAccess v6.ServiceAccessCommand `command:"service-access" description:"List service access settings"` 147 ServiceBrokers v6.ServiceBrokersCommand `command:"service-brokers" description:"List service brokers"` 148 ServiceKeys v6.ServiceKeysCommand `command:"service-keys" alias:"sk" description:"List keys for a service instance"` 149 ServiceKey v6.ServiceKeyCommand `command:"service-key" description:"Show service key info"` 150 Services v6.ServicesCommand `command:"services" alias:"s" description:"List all service instances in the target space"` 151 Service v6.ServiceCommand `command:"service" description:"Show service instance info"` 152 SetEnv v7.SetEnvCommand `command:"set-env" alias:"se" description:"Set an env variable for an app"` 153 SetHealthCheck v7.SetHealthCheckCommand `command:"set-health-check" description:"Change type of health check performed on an app's process"` 154 SetOrgDefaultIsolationSegment v6.SetOrgDefaultIsolationSegmentCommand `command:"set-org-default-isolation-segment" description:"Set the default isolation segment used for apps in spaces in an org"` 155 SetOrgRole v6.SetOrgRoleCommand `command:"set-org-role" description:"Assign an org role to a user"` 156 SetQuota v6.SetQuotaCommand `command:"set-quota" description:"Assign a quota to an org"` 157 SetRunningEnvironmentVariableGroup v6.SetRunningEnvironmentVariableGroupCommand `command:"set-running-environment-variable-group" alias:"srevg" description:"Pass parameters as JSON to create a running environment variable group"` 158 SetSpaceIsolationSegment v6.SetSpaceIsolationSegmentCommand `command:"set-space-isolation-segment" description:"Assign the isolation segment for a space"` 159 SetSpaceQuota v6.SetSpaceQuotaCommand `command:"set-space-quota" description:"Assign a space quota definition to a space"` 160 SetSpaceRole v6.SetSpaceRoleCommand `command:"set-space-role" description:"Assign a space role to a user"` 161 SetStagingEnvironmentVariableGroup v6.SetStagingEnvironmentVariableGroupCommand `command:"set-staging-environment-variable-group" alias:"ssevg" description:"Pass parameters as JSON to create a staging environment variable group"` 162 SharePrivateDomain v6.SharePrivateDomainCommand `command:"share-private-domain" description:"Share a private domain with an org"` 163 ShareService v6.ShareServiceCommand `command:"share-service" description:"Share a service instance with another space"` 164 SpaceQuotas v6.SpaceQuotasCommand `command:"space-quotas" description:"List available space resource quotas"` 165 SpaceQuota v6.SpaceQuotaCommand `command:"space-quota" description:"Show space quota info"` 166 SpaceSSHAllowed v6.SpaceSSHAllowedCommand `command:"space-ssh-allowed" description:"Reports whether SSH is allowed in a space"` 167 Spaces v6.SpacesCommand `command:"spaces" description:"List all spaces in an org"` 168 SpaceUsers v6.SpaceUsersCommand `command:"space-users" description:"Show space users by role"` 169 Space v6.SpaceCommand `command:"space" description:"Show space info"` 170 SSHCode v6.SSHCodeCommand `command:"ssh-code" description:"Get a one time password for ssh clients"` 171 SSHEnabled v6.SSHEnabledCommand `command:"ssh-enabled" description:"Reports whether SSH is enabled on an application container instance"` 172 SSH v7.SSHCommand `command:"ssh" description:"SSH to an application container instance"` 173 Stack v7.StackCommand `command:"stack" description:"Show information for a stack (a stack is a pre-built file system, including an operating system, that can run apps)"` 174 Stacks v7.StacksCommand `command:"stacks" description:"List all stacks (a stack is a pre-built file system, including an operating system, that can run apps)"` 175 StagingEnvironmentVariableGroup v6.StagingEnvironmentVariableGroupCommand `command:"staging-environment-variable-group" alias:"sevg" description:"Retrieve the contents of the staging environment variable group"` 176 StagingSecurityGroups v6.StagingSecurityGroupsCommand `command:"staging-security-groups" description:"List security groups in the staging set for applications"` 177 Start v6.StartCommand `command:"start" alias:"st" description:"Start an app"` 178 Stop v6.StopCommand `command:"stop" alias:"sp" description:"Stop an app"` 179 Target v7.TargetCommand `command:"target" alias:"t" description:"Set or view the targeted org or space"` 180 Tasks v6.TasksCommand `command:"tasks" description:"List tasks of an app"` 181 TerminateTask v6.TerminateTaskCommand `command:"terminate-task" description:"Terminate a running task of an app"` 182 UnbindRouteService v6.UnbindRouteServiceCommand `command:"unbind-route-service" alias:"urs" description:"Unbind a service instance from an HTTP route"` 183 UnbindRunningSecurityGroup v6.UnbindRunningSecurityGroupCommand `command:"unbind-running-security-group" description:"Unbind a security group from the set of security groups for running applications"` 184 UnbindSecurityGroup v6.UnbindSecurityGroupCommand `command:"unbind-security-group" description:"Unbind a security group from a space"` 185 UnbindService v6.UnbindServiceCommand `command:"unbind-service" alias:"us" description:"Unbind a service instance from an app"` 186 UnbindStagingSecurityGroup v6.UnbindStagingSecurityGroupCommand `command:"unbind-staging-security-group" description:"Unbind a security group from the set of security groups for staging applications"` 187 UninstallPlugin plugin.UninstallPluginCommand `command:"uninstall-plugin" description:"Uninstall CLI plugin"` 188 UnmapRoute v6.UnmapRouteCommand `command:"unmap-route" description:"Remove a url route from an app"` 189 UnsetEnv v7.UnsetEnvCommand `command:"unset-env" alias:"ue" description:"Remove an env variable from an app"` 190 UnsetOrgRole v6.UnsetOrgRoleCommand `command:"unset-org-role" description:"Remove an org role from a user"` 191 UnsetSpaceQuota v6.UnsetSpaceQuotaCommand `command:"unset-space-quota" description:"Unassign a quota from a space"` 192 UnsetSpaceRole v6.UnsetSpaceRoleCommand `command:"unset-space-role" description:"Remove a space role from a user"` 193 UnsharePrivateDomain v6.UnsharePrivateDomainCommand `command:"unshare-private-domain" description:"Unshare a private domain with an org"` 194 UnshareService v6.UnshareServiceCommand `command:"unshare-service" description:"Unshare a shared service instance from a space"` 195 UpdateBuildpack v7.UpdateBuildpackCommand `command:"update-buildpack" description:"Update a buildpack"` 196 UpdateQuota v6.UpdateQuotaCommand `command:"update-quota" description:"Update an existing resource quota"` 197 UpdateSecurityGroup v6.UpdateSecurityGroupCommand `command:"update-security-group" description:"Update a security group"` 198 UpdateServiceBroker v6.UpdateServiceBrokerCommand `command:"update-service-broker" description:"Update a service broker"` 199 UpdateService v6.UpdateServiceCommand `command:"update-service" description:"Update a service instance"` 200 UpdateSpaceQuota v6.UpdateSpaceQuotaCommand `command:"update-space-quota" description:"Update an existing space quota"` 201 UpdateUserProvidedService v6.UpdateUserProvidedServiceCommand `command:"update-user-provided-service" alias:"uups" description:"Update user-provided service instance"` 202 Version VersionCommand `command:"version" description:"Print the version"` 203 } 204 205 // HasCommand returns true if the command name is in the command list. 206 func (c commandList) HasCommand(name string) bool { 207 if name == "" { 208 return false 209 } 210 211 cType := reflect.TypeOf(c) 212 _, found := cType.FieldByNameFunc( 213 func(fieldName string) bool { 214 field, _ := cType.FieldByName(fieldName) 215 return field.Tag.Get("command") == name 216 }, 217 ) 218 219 return found 220 } 221 222 // HasAlias returns true if the command alias is in the command list. 223 func (c commandList) HasAlias(alias string) bool { 224 if alias == "" { 225 return false 226 } 227 228 cType := reflect.TypeOf(c) 229 _, found := cType.FieldByNameFunc( 230 func(fieldName string) bool { 231 field, _ := cType.FieldByName(fieldName) 232 return field.Tag.Get("alias") == alias 233 }, 234 ) 235 236 return found 237 }