Command line interface (CLI)

The ecFlow command line interface (CLI) is provided by the ecflow_client executable. A large number of commands/options enabled by the ecFlowUI are also available as CLI commands.

ecflow_client accepts a variety of commands, specified as --<command>. For example, the command --load can be used, as in the example below, to load the given file into the server.

ecflow_client --load host1.3141.check

The comprehensive list of ecflow_client commands is presented below. These commands can be combined with ecflow_client common options to further customise the ecflow_client behaviour.

Getting help

The list of commands, amongst other details, can be displayed by using the option --help.

ecflow_client --help

The elements that can appear in a suite definition file (node types and attributes, such as trigger or cron) are listed and documented the same way, using --help=definition and --help=defs/<item> respectively.

ecflow_client --help=definition
ecflow_client --help=defs/trigger

• Handling CLI options
• Using ecflow_client in Tasks
• Using Backup Servers

---

• Commands
• Options
• Command internals