Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 8 additions & 30 deletions cli_reference/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,36 +6,14 @@ include::_attributes/common-attributes.adoc[]

toc::[]

A user performs a range of operations while working on {product-title} such as the following:
[role="_abstract"]
{product-title} offers a set of command-line interface (CLI) tools that enable users to perform various administration and development operations from the terminal. These tools expose simple commands to manage the applications, as well as interact with each component of the system.

* Managing clusters
* Building, deploying, and managing applications
* Managing deployment processes
* Creating and maintaining Operator catalogs
For example, you can use the CLI to complete the following operations:

{product-title} offers a set of command-line interface (CLI) tools that simplify these tasks by enabling users to perform various administration and development operations from the terminal.
These tools expose simple commands to manage the applications, as well as interact with each component of the system.
* Manage clusters
* Build, deploy, and manage applications
* Manage deployment processes
* Create and maintain Operator catalogs

[id="cli-tools-list"]
== List of CLI tools

The following set of CLI tools are available in {product-title}:

* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (`oc`)]:
ifndef::openshift-rosa[]
This is the most commonly used CLI tool by {product-title} users.
endif::openshift-rosa[]
ifdef::openshift-rosa[]
This is one of the more commonly used developer CLI tools.
endif::openshift-rosa[]
It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts.

* xref:../cli_reference/kn-cli-tools.adoc#kn-cli-tools[Knative CLI (kn)]: The Knative (`kn`) CLI tool provides simple and intuitive terminal commands that can be used to interact with OpenShift Serverless components, such as Knative Serving and Eventing.

* xref:../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[Pipelines CLI (tkn)]: OpenShift Pipelines is a continuous integration and continuous delivery (CI/CD) solution in {product-title}, which internally uses Tekton. The `tkn` CLI tool provides simple and intuitive commands to interact with OpenShift Pipelines using the terminal.

* xref:../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[opm CLI]: The `opm` CLI tool helps the Operator developers and cluster administrators to create and maintain the catalogs of Operators from the terminal.

ifdef::openshift-rosa,openshift-rosa-hcp[]
* xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI (`rosa`)]: Use the `rosa` CLI to create, update, manage, and delete {product-title} clusters and resources.
endif::openshift-rosa,openshift-rosa-hcp[]
include::modules/cli-tools-list.adoc[leveloffset=+1]
33 changes: 33 additions & 0 deletions modules/cli-tools-list.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// Module included in the following assemblies:
//
// * cli_reference/index.adoc
//
// This file is a navigation file - xrefs are allowed in this type of module, but it must only ever be included from one location

:_mod-docs-content-type: REFERENCE
[id="cli-tools-list_{context}"]
= List of CLI tools

[role="_abstract"]
Review the primary command-line interface (CLI) tools available for {product-title}, including tools for cluster administration, application development, and Operator management.

Use the following tools to manage your cluster from the terminal:

* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (`oc`)]:
Comment thread
bergerhoffer marked this conversation as resolved.
ifndef::openshift-rosa[]
This is the most commonly used CLI tool by {product-title} users.
endif::openshift-rosa[]
ifdef::openshift-rosa[]
This is one of the more commonly used developer CLI tools.
endif::openshift-rosa[]
It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts.

* xref:../cli_reference/kn-cli-tools.adoc#kn-cli-tools[Knative CLI (kn)]: The Knative (`kn`) CLI tool provides simple and intuitive terminal commands that can be used to interact with OpenShift Serverless components, such as Knative Serving and Eventing.
Comment thread
bergerhoffer marked this conversation as resolved.

* xref:../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[Pipelines CLI (tkn)]: OpenShift Pipelines is a continuous integration and continuous delivery (CI/CD) solution in {product-title}, which internally uses Tekton. The `tkn` CLI tool provides simple and intuitive commands to interact with OpenShift Pipelines using the terminal.
Comment thread
bergerhoffer marked this conversation as resolved.
Comment thread
bergerhoffer marked this conversation as resolved.
Comment thread
bergerhoffer marked this conversation as resolved.

* xref:../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[opm CLI]: The `opm` CLI tool helps the Operator developers and cluster administrators to create and maintain the catalogs of Operators from the terminal.
Comment thread
bergerhoffer marked this conversation as resolved.

ifdef::openshift-rosa,openshift-rosa-hcp[]
* xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI (`rosa`)]: Use the `rosa` CLI to create, update, manage, and delete {product-title} clusters and resources.
Comment thread
bergerhoffer marked this conversation as resolved.
endif::openshift-rosa,openshift-rosa-hcp[]