modules/cli-about-cli.adoc

// Module included in the following assemblies:
//
// * cli_reference/openshift_cli/getting-started.adoc

:_content-type: CONCEPT
[id="cli-about-cli_{context}"]
= About the OpenShift CLI

With the OpenShift command-line interface (CLI), the `oc` command, you can create applications and manage {product-title} projects from a terminal. The OpenShift CLI is ideal in the following situations:

* Working directly with project source code
* Scripting {product-title} operations
ifndef::microshift[]
* Managing projects while restricted by bandwidth resources and the web console is unavailable
endif::microshift[]
ifdef::microshift[]
* Managing projects while restricted by bandwidth resources
endif::microshift[]
OSDOCS-241: Add getting started with CLI 2019-03-11 20:59:48 -04:00			`// Module included in the following assemblies:`
			`//`
Renaming CLI reference bucket to CLI tools 2019-10-02 11:30:49 -04:00			`// * cli_reference/openshift_cli/getting-started.adoc`
OSDOCS-241: Add getting started with CLI 2019-03-11 20:59:48 -04:00
Adding auto-generated concept and procedure content type labels 2022-02-04 15:22:10 +00:00			`:_content-type: CONCEPT`
changed -{context} to _{context} 2019-05-13 08:55:00 +10:00			`[id="cli-about-cli_{context}"]`
Use 'OpenShift CLI' name unambiguously 2021-02-04 08:45:01 -07:00			`= About the OpenShift CLI`
OSDOCS-241: Add getting started with CLI 2019-03-11 20:59:48 -04:00
Pt 2: Use 'OpenShift CLI' name unambiguously 2021-02-04 08:45:01 -07:00			With the OpenShift command-line interface (CLI), the `oc` command, you can create applications and manage {product-title} projects from a terminal. The OpenShift CLI is ideal in the following situations:
OSDOCS-241: Add getting started with CLI 2019-03-11 20:59:48 -04:00
Use 'OpenShift CLI' name unambiguously 2021-02-04 08:45:01 -07:00			`* Working directly with project source code`
			`* Scripting {product-title} operations`
microshift: initial structure - start topic list with about, welcome, legal notice - stub introduction with understanding section - stub in API reference - stub in storage and networking topics (These aren't filled in yet, but we need to cover them so include them in the topic map.) - add troubleshooting section - stub in installation section - add cli tools section - add links to index pages Co-Authored-By: Kathryn Alexander <kalexand@redhat.com> 2022-09-05 08:47:15 -04:00			`ifndef::microshift[]`
Pt 2: Use 'OpenShift CLI' name unambiguously 2021-02-04 08:45:01 -07:00			`* Managing projects while restricted by bandwidth resources and the web console is unavailable`
microshift: initial structure - start topic list with about, welcome, legal notice - stub introduction with understanding section - stub in API reference - stub in storage and networking topics (These aren't filled in yet, but we need to cover them so include them in the topic map.) - add troubleshooting section - stub in installation section - add cli tools section - add links to index pages Co-Authored-By: Kathryn Alexander <kalexand@redhat.com> 2022-09-05 08:47:15 -04:00			`endif::microshift[]`
			`ifdef::microshift[]`
			`* Managing projects while restricted by bandwidth resources`
			`endif::microshift[]`