Command Line Interface (CLI)
A command line interface has been developed to be used directly from a shell prompt to access SCT functionalities with an easy to use approach. All the main functionalities are supported with a dedicated command with its help documentation.
The main command line tool that can be accessed using the sct command in your favorite shell.
Main CLI
SCT command line can be invoked in the terminal session as:
This is the entry point for the console script. The configuration needed to perform the analysis must be provided
using the --config/-cfg argument. Each installed analysis plugin registers its command automatically under the
sct CLI but the above command alone won't perform any kind of operation.
To select the operation of choice, use the available commands that can be listed using the --help/-h option.
Available Analyses
Each installed analysis plugin exposes its own dedicated command.
Refer to the analyses plugins documentation site for more details on each analysis and its command.
SCT Info
The info command can be used to display information about the installed SCT version, core dependencies, and
list all the available plugins on PyPI.
Testing Interface
A Testing Interface is also available under the testing CLI group. This feature can be used to run analyses as Test
Cases written into a proper registry .json file.
sct testing test -r <path_to_registry_file> -out <output_dir> [--cli/-c] [--graphs/-g]
where --graphs/-g is used to enable graphs generation and --cli/-c is used to enable CLI testing instead of API.
Refer to the analyses plugins documentation site for more details on each analysis and its testing interface, if any.
Auxiliary utilities
Another set of companion utilities has been developed and added under the auxiliary CLI group.
Refer to the cli utilities documentation for more details.