Note

This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.

brainprep.cli.main

brainprep.cli.main()

Entry point for the BrainPrep command-line interface.

This function exposes all BrainPrep workflows as Fire commands. Each workflow is wrapped so that global configuration parameters can be passed directly from the command line.

The CLI supports all workflows defined in brainprep.workflow and automatically displays them in the help message.

Notes

This function should not be called directly from Python code.

Examples

Listing available commands:

$ brainprep --help

Command help:

$ brainprep subject-level-qa --help