gearshift.cli package

Module contents

Define gearshift command line interface.

gearshift

GEARSHIFT command line tool.

gearshift [OPTIONS] COMMAND [ARGS]...

Options

-v, --verbosity <LVL>

Either CRITICAL, ERROR, WARNING, INFO or DEBUG

demo

Writes a GEARSHIFT demo files into OUTPUT_FOLDER.

OUTPUT_FOLDER: Folder path. [default: ./inputs]]

gearshift demo [OPTIONS] [OUTPUT_FOLDER]

Arguments

OUTPUT_FOLDER

Optional argument

run

Run GEARSHIFT for all files into INPUT_FILES.

INPUT_FILES: List of input files and/or folders

(format: .xlsx).

gearshift run [OPTIONS] [INPUT_FILES]...

Options

-O, --output-folder <output_folder>

Output folder.

Default:

./outputs

-OT, --output-template <output_template>

Template output.

-PL, --plot-workflow

Open workflow-plot in browser, after run finished.

-OF, --output-format <output_format>

Output format.

Default:

xlsx

Arguments

INPUT_FILES

Optional argument(s)