id = "rosa-cli" name = "ROSA CLI" homepage = "https://github.com/openshift/rosa" description = "Red Hat OpenShift Service on AWS (ROSA) Command Line Tool." executables = ["rosa"] [dotfiles] paths = [] secret = ["~/.ocm.json", "[configHome]/ocm/ocm.json"] # ROSA's official config package uses an existing ~/.ocm.json for backwards # compatibility and otherwise the XDG config path; both files hold OAuth # access/refresh tokens and must be treated as credentials. # https://pkg.go.dev/github.com/openshift/rosa/pkg/config # https://github.com/openshift/rosa#secure-credentials-storage [commands] format = 1 label = "ROSA CLI" description = "Describe a cluster or list clusters. Flag names come from the project's Go sources; other flags are left out." quality = "ai-draft" parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false } [[commands.subcommand]] path = ["describe", "cluster"] label = "Describe a cluster" [[commands.subcommand.source]] id = "src" kind = "help" url = "https://github.com/openshift/rosa/blob/master/cmd/describe/cluster/cmd.go" evidence = """ Short: "Show details of a cluster", Example: ` # Describe a cluster named "mycluster" rosa describe cluster --cluster=mycluster`, // This file contains functions used to implement the '--output' command line option. fmt.Sprintf("Output format. Allowed formats are %s", formats) JSON = "json" YAML = "yaml" // AddProfileFlag adds the '--profile' flag to the given set of command line flags. // AddRegionFlag adds the '--region' flag to the given set of command line flags. """ [[commands.subcommand.field]] id = "cluster" label = "Cluster" description = "Cluster name or ID." type = "string" option = ["--cluster"] sources = ["src"] [[commands.subcommand.field]] id = "output" label = "Output format" type = "enum" option = ["--output"] choices = [{ value = "json", label = "JSON" }, { value = "yaml", label = "YAML" }] sources = ["src"] [[commands.subcommand.field]] id = "profile" label = "AWS profile" type = "string" option = ["--profile"] sources = ["src"] [[commands.subcommand.field]] id = "region" label = "AWS region" type = "string" option = ["--region"] sources = ["src"] [[commands.subcommand.task]] id = "describe" label = "Describe a cluster" fields = ["cluster", "output"] required = ["cluster"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["cluster", "output"] [[commands.subcommand.group]] id = "advanced" label = "Advanced" fields = ["profile", "region"] [[commands.subcommand]] path = ["list", "clusters"] label = "List clusters" [[commands.subcommand.source]] id = "src" kind = "help" url = "https://github.com/openshift/rosa/blob/master/cmd/list/cluster/cmd.go" evidence = """ Short: "List clusters", Example: ` # List all clusters rosa list clusters`, // This file contains functions used to implement the '--output' command line option. fmt.Sprintf("Output format. Allowed formats are %s", formats) JSON = "json" YAML = "yaml" // AddProfileFlag adds the '--profile' flag to the given set of command line flags. // AddRegionFlag adds the '--region' flag to the given set of command line flags. """ [[commands.subcommand.field]] id = "output" label = "Output format" type = "enum" option = ["--output"] choices = [{ value = "json", label = "JSON" }, { value = "yaml", label = "YAML" }] sources = ["src"] [[commands.subcommand.field]] id = "profile" label = "AWS profile" type = "string" option = ["--profile"] sources = ["src"] [[commands.subcommand.field]] id = "region" label = "AWS region" type = "string" option = ["--region"] sources = ["src"] [[commands.subcommand.task]] id = "list" label = "List clusters" fields = ["output"] required = [] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["output"] [[commands.subcommand.group]] id = "advanced" label = "Advanced" fields = ["profile", "region"]