status command

This command allows you to query the status of executed commands or the agent.

Usage

formae status [COMMAND]

Command status

Usage

formae status command [OPTIONS]

Options

Option	Description
--output-consumer	Consumer of the command result (human | machine) [default: "human"]
--output-layout	What to print as status output (summary
--output-schema	The schema to use for the result output (json | yaml) [default: "json"]
--query	Query that allows to find past and current commands by their attributes [default: " "]
--watch	Watch mode: continuously refresh the status until completion

Consumer

Currently, there are two consumers:

• human (default): The CLI assumes a human user is interacting with it. Output is less strictly formatted and more verbose
• machine: The CLI assumes the data printed to stdout will be processed by a machine or another tool

Query

This command, using the --query flag, allows you to search and retrieve past and current commands. The query language is simple and is described in detail here. A maximum of 10 most recent commands will be retrieved, in the time descending order. Following fields are available for search:

• client: the client ID of a CLI. Your own CLI can be referenced as client:me, or the ID found in ~/.pel/formae_cli_client_id
• status: status of the commands to search for. Possible values are (case doesn't matter):
  • NotStarted: commands that are yet queued
  • InProgress: commands currently being executed
  • Success: successfully finished commands
  • Failed: failed commands
• id: the command ID if known
• command: type of command. Possible values are:
  • apply: apply CLI command
  • destroy: destroy CLI command
  • sync: automatic background synchronization (always hidden by default)
• stack: stack the releated resources belong to (case sensitive)

Here are a few examples:

• formae status --query='client:me status:success': retrieve most recent successful commands this CLI has executed
• formae status --query='-command:apply': retrieve most recent commands that aren't of type apply (basically destroy commands)
• formae status --query='command:sync': retrieve mose recent background synchronizations

Status output

This command can output detailed information and summary of command(s) in question. The detailed information is self-explaining.

The summary output of the command looks as follows:

The columns Change through Fail count the number of changes in the corresponding state.

Watch

The --watch flag enables continuous monitoring of the command status. It's ideal for tracking long-running formae without manual status checks.

• Refreshes every 2 seconds
• Clears the screen between updates (in human mode)
• Exits automatically on Success or Failed state

Agent status

Usage

formae status command [OPTIONS]

Options

Option	Description
--output-consumer	Consumer of the command result (human | machine) [default: "human"]
--output-schema	The schema to use for the result output (json | yaml) [default: "json"]
--watch	Watch mode: continuously refresh the status until completion

Consumer

Currently, there are two consumers:

• human (default): The CLI assumes a human user is interacting with it. Output is less strictly formatted and more verbose
• machine: The CLI assumes the data printed to stdout will be processed by a machine or another tool

Status output

This command can output summary of a running agent.

The summary output of the command looks as follows:

All information is self-explaining.

Watch

The --watch flag enables continuous monitoring of the agent status. It's ideal for tracking long-running formae without manual status checks.

• Refreshes every 2 seconds
• Clears the screen between updates (in human mode)