Sub-Commands

The provengo tool is invoked with a sub-command, telling it what to do and on which project to do it. The structure of the entire command is as follows:

provengo [global options] sub-command [sub-command options] [<path-to-project>]
If the path-to-project is omitted, provengo will use the current working directory. So when running provengo from a project directory, you can safely omit this parameter.
Some options take file path parameters (e.g. gen-scripts's --run-source). If the path is relative, it is resolved starting from the project directory, which may be different from the current directory of the terminal emulator. Naturally, absolute paths are used as provided by the user.

Global Run Options

These options affect all sub-commands.

--batch-mode

Skip user interactions. For example, do not open generated pdfs automatically, and do not pause when getting to Ctrl.doPause().

--config PATH

Specify which configuration file to use. Defaults to provengo.yml. The path to the file is relative to the project folder.

--no-color

Print to standard out using plain text, without any console colors. Useful when writing to a log or if your terminal does not support colors. The tool tries to detect these cases automatically; this option is here in case this automatic detection fails or if there’s a need to use plain text in the output.

-p/--profile NAME

Profile name, defined in the configuration file. More on profiles.

--verbose

Print more data to the console. Useful when debugging a project.

-c key=value /--custom key=value

Explicitly set configuration keys from the commandline. This is useful for quickly checking configuration variations, or for allowing external scripts and CI/CD systems to alter provengo's default behavior. To set multiple keys, add this option a multiple times.