CLI Reference

Flags

Help

Invoke with:

lucifer -h
lucifer --help

Use case:
View information about the project and how to invoke it.

Description:
Displays all flags and options to invoke the cli, useful links to help you use lucifer effectively, and information about the product such as author and version.

Version

Invoke with:

lucifer -v
lucifer --version

Use case:
View the current version.

Description:
Displays the current version in format: vX.X.X where X is the current version number.

Silent

Invoke with:

lucifer -s
lucifer --silent

Use case:
Suppress all console output.

Description:
Tells lucifer not to send any output to the console. In the case of a crash (which should be rare. Please report if you do run into this), the silent flag may not be honored.

No File

Invoke with:

lucifer -n
lucifer --no-file

Use case:
Suppress the results.json file.

Description:
Tells lucifer not to create a file with the results of the run. This can be helpful if you're running locally or have no need to output an extra file.

Options

Option definiton

Input Directory

Invoke with:

lucifer -i <directory_or_file>
lucifer --input-directory <directory_or_file>

Use case:
Change the input directory to a specified directory or file.

Description:
Changes the input directory (suite directory) from the default (.) to whereever you point to. This is useful when you want to run a specific feature file or have a tool that relies on the execution directory.

Output directory

Invoke with:

lucifer -o <directory>
lucifer --output-directory <directory>

Use case:
Change the output directory.

Description:
Changes the output directory from the default (.) to whereever you point to. The output directory is where results.json goes.

Keep learning