CLI Commands
This page introduces the Pacemaker Command Line Interface (CLI) and explains how to configure and run Pacemaker and its components.
What is the Pacemaker CLI?
-
The Pacemaker Command Line Interface (Pacemaker CLI) is a simple tool that allows you to control, run, and optionally configure Pacemaker and all installed components and modules from your terminal application’s command prompt.
-
Pacemaker CLI uses as base command the well known Magento CLI
bin/magentocommand -
Pacemaker's CLI is the user’s primary entry point into Pacemaker
-
The use of the command line requires a basic knowledge of using a command-line tool (terminal) in general
-
When using the Pacemaker command-line interface, you can specify optional configuration overrides using CLI options or environment variables as needed
Usage
Open the CLI tool of your choice (Terminal, ITerm2,…), type the desired command in the prompt of your terminal application and then press Enter to execute it.
The command consists of the program name (or the program path), followed by the required command and/or the options and arguments needed for it.
In the next sections we will break these down in basic terms for the Pacemaker command line.
-
Every command starts with the base call (i.e., program name or path)
Command inputs and structure
bin/magento [command]:[action|shortcut] [--option1 --option2] [optional arguments]Example
bin/magento pacemaker:pipeline:statusbin/magento [command]:[step][action|shortcut] [--option1 --option2] [optional arguments] (1)| 1 | For some commands, it is possible to call a more defined command. |