1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/modules/rosa-common-commands.adoc
2025-09-17 00:56:10 +00:00

91 lines
2.1 KiB
Plaintext

// Module included in the following assemblies:
//
// * rosa_cli/rosa-manage-objects-cli.adoc
:_mod-docs-content-type: REFERENCE
[id="rosa-common-commands_{context}"]
= Common commands and arguments
These common commands and arguments are available for the {rosa-cli-first}.
[id="rosa-debug_{context}"]
== debug
Enables debug mode for the parent command to help with troubleshooting.
.Example
[source,terminal]
----
$ rosa create cluster --cluster-name=<cluster_name> --debug
----
[id="rosa-download_{context}"]
== download
Downloads the latest compatible version of the specified software to the current directory in an archive file. Extract the contents of the archive and add the contents to your path to use the software. To download the latest ROSA CLI, specify `rosa`. To download the latest OpenShift CLI, specify `oc`.
.Example
[source,terminal]
----
$ rosa download <software>
----
[id="rosa-help_{context}"]
== help
Displays general help information for the ROSA CLI (`rosa`) and a list of available commands. This option can also be used as an argument to display help information for a parent command, such as `version` or `create`.
.Examples
Displays general help for the ROSA CLI.
[source,terminal]
----
$ rosa --help
----
Displays general help for `version`.
[source,terminal]
----
$ rosa version --help
----
[id="rosa-interactive_{context}"]
== interactive
Enables interactive mode.
.Example
[source,terminal]
----
$ rosa create cluster --cluster-name=<cluster_name> --interactive
----
[id="rosa-profile-string_{context}"]
== profile
Specifies an AWS profile from your credential file.
.Example
[source,terminal]
----
$ rosa create cluster --cluster-name=<cluster_name> --profile=myAWSprofile
----
[id="rosa-version_{context}"]
== version
Displays the `rosa` version and checks whether a newer version is available.
.Example
[source,terminal]
----
$ rosa version [arguments]
----
.Example output
Displayed when a newer version of the ROSA CLI is available.
[source,terminal]
----
1.2.12
There is a newer release version '1.2.15', please consider updating: https://mirror.openshift.com/pub/openshift-v4/clients/rosa/latest/
----