Command-Line Interface (CLI)

Go up to Terms and Definitions

A Command-Line Interface (CLI) provides a text-based interface through which a person or automated process invokes software operations by supplying commands, options, arguments, and input values.

A CLI can receive input from:

• An interactive terminal session
• A shell script
• A Workflow
• A CI/CD Pipeline
• Another software process

A CLI can produce:

• Command output
• Operation status
• Diagnostic information
• Error information
• Structured output
• Process exit status

Within Crucible documentation, a CLI provides one possible interface for invoking noninteractive operations within a Workspace or automated Workflow.

text-based interface through which a person or automated process invokes software operations by supplying commands, options, arguments, and input values

DIDO-controlled term adapted from established operating-system, shell, and software-interface practices.

The acronym CLI means Command-Line Interface.

A Command-Line Interface differs from a command line. A command line is the textual command and associated arguments supplied through the interface.

A CLI can support interactive or noninteractive execution.

The existence of a CLI does not require an operation to prompt for user input. Automated processes can invoke a CLI using predefined commands, arguments, configuration, environment variables, or input files.

A CLI differs from a graphical user interface and an application programming interface, although software can provide more than one interface to the same operation.

A CI/CD Pipeline invokes the Crucible CLI with a Workspace location, selected Baselines, operation parameters, and an output location. Crucible performs the requested operation without prompting for interactive input and returns an exit status and execution result.