status

Command-line tool subcommand

Output a module execution schedule for the pipeline and execution status for every module.

Usage:

pimlico.sh [...] status [module_name] [-h] [--all] [--alias] [--short] [--history] [--deps-of DEPS_OF] [--no-color] [--no-sections] [--expand-all] [--expand [EXPAND [EXPAND ...]]]

Positional arguments

Arg Description
[module_name] Optionally specify a module name (or number). More detailed status information will be outut for this module. Alternatively, use this arg to limit the modules whose status will be output to a range by specifying ‘A…B’, where A and B are module names or numbers

Options

Option Description
--all, -a Show all modules defined in the pipeline, not just those that can be executed
--alias Include module aliases after modules in the output. By default, they are not shown
--short, -s Use a brief format when showing the full pipeline’s status. Only applies when module names are not specified. This is useful with very large pipelines, where you just want a compact overview of the status
--history, -i When a module name is given, even more detailed output is given, including the full execution history of the module
--deps-of, -d Restrict to showing only the named/numbered module and any that are (transitive) dependencies of it. That is, show the whole tree of modules that lead through the pipeline to the given module
--no-color, --nc Don’t include terminal color characters, even if the terminal appears to support them. This can be useful if the automatic detection of color terminals doesn’t work and the status command displays lots of horrible escape characters
--no-sections, --ns Don’t show section headings, but just a list of all the modules
--expand-all, --xa Show section headings, expanding all
--expand, -x Expand this section number. May be used multiple times. Give a section number like ‘1.2.3’. To expand the full subtree, give ‘1.2.3.’