CLI Usage

This guide shows overview of fireap subcommands and typical usecases of fireap CLI.

As for detailed usage of CLI, run fireap help.

General Information

Global options:

• -c|--config=/path/to/config.toml
  • Option to specify path of configuration file.
  • When you set $FIREAP_CONFIG_PATH environment variable, you can omit this option.

Subcommands

fireap task

fireap task [-w <WIDTH>] [OPTIONS]

This shows the task settings under [task] sections in the configuration file.
By this command, you can also check if the configuration is valid or not.

fireap fire

fireap fire -a <APP> [-v <VERSION>] [OPTIONS]
# To limit target node to execute the task
fireap fire -a <APP> --node-name|-n=<NODE_NAME> [-v <VERSION>] [OPTIONS]

This fires a fireap task propagation.

If you omit -v|--version=<VERSION> option, fireap start with version “1” if it is the first execution. When you have already executed the task, fireap increments the version which is taken in the last execution.
For example, when the version last executed is “v1.0.0”, next version will be “v1.0.1” without -v|--version option.

Read Getting Started for more information.

fireap clear

fireap clear -a <APP> [OPTIONS]

fireap fire holds lock for each <APP> during the command execution to avoid multiple execution of a task.

You do not need to run this in usual operation.
But fireap supports this subcommand for rare possibility.

fireap reap

fireap reap [OPTIONS]
fireap reap --dry-run [OPTIONS]

This receives contents of Consul Event from STDIN, then executes configured task.
It is supposed to be used as watch handler of consul agent.

However, if you want to check how this works preliminarily, you can do it by command like followings:

curl http://localhost:8500/v1/event/list | fireap reap [--dry-run] [OPTIONS]

With --dry-run option, this does not execute commands set in the task but prints them.

Read Getting Started for detailed instruction to use this as Consul Watch Handler.

fireap monitor

fireap monitor -a <APP> [OPTIONS]
fireap monitor -a <APP> --one-shot [OPTIONS]

This shows data in Consul Kv related to <APP>.
You can check task propagation by this.

Without -o|--one-shot option, it continuously shows the data until it receives INT signal (corresponds to Ctrl-C in many terminal environments).