CLI Document Handbook

 CLI (Command-Line Interface) 

A CLI (Command-Line Interface) is a text-based method for interacting with a computer program or operating system. Instead of using graphical icons, buttons, or menus (like in a GUI – Graphical User Interface), users type commands in a terminal or console window to perform tasks.

CLI is a command-line program that accepts text input to execute operating system functions.

In the 1960s, using only computer terminals, this was the only way to interact with computers.

In the 1970s and 1980s, command-line input was commonly used by Unix systems and PC systems like MS-DOS and Apple DOS.

Today, with graphical user interfaces (GUI), most users never use command-line interfaces (CLI).

However, CLI is still used by software developers and system administrators to configure computers, install software, and access features that are not available in the graphical interface.

Examples

Windows Example

C:\>npm install mysoftware

Mac OS Example

>npm install mysoftware

Note: – Use CLI commands with great attention!!!

Wrong use can easily delete files or destroy your computer system completely.

Good Example of CLI Documents– https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-welcome.html

You can search more on Google.

Requirement Gathering-

From whom do you gather your requirements to write a CLI guide

It is similar to any other document:

Always answer, I get it from developers, and then play with it.

Who reviews your CLI doc, and what is the process?

It is a typical document review cycle (watch video on DRLC in the app )

1. Draft by writer
2. SME review (accuracy)
3. QA review (functionality)
4. Peer writer/editor review (clarity & style)
5. PO review (business focus)
6. (Optional) User feedback
7. Final sign-off & publish

Typical Structure of CLI document