Using Efinity Command-Line Scripts

This topic overviews the format used by Efinity command-line scripts.

Script input at the command line includes the script name followed by positional arguments and/or options. Multiple arguments or options may be used depending on the script.

In each script topic, the script is listed with all arguments and options, including those that are not required. Optional inputs are listed in brackets. When an option is followed by the option name in capital letters, it takes an additional input. For example:

efx_run.py project [--flow FLOW]

efx_run.py is the script name, project is a positional argument, --flow is an option, and FLOW is the option input.

The following example command runs the full flow (--flow full) using the efx_run.py script on the helloworld project:

efx_run.py helloworld.xml --flow full