Skip to content

statue

Statue is a static code analysis tools orchestrator.

Usage:

statue [OPTIONS] COMMAND [ARGS]...

Options:

  --version              Show the version and exit.
  --config FILE          Statue configuration file.
  --cache-dir DIRECTORY  Statue caching directory path
  --help                 Show this message and exit.

Subcommands

  • commands: Commands related actions such as list, install, show, etc.
  • config: Configuration related actions.
  • contexts: Contexts related actions such as list, show, etc.
  • history: History related actions such as list, show, etc.
  • run: Run static code analysis commands on sources.
  • show-tree: Show sources configuration as a tree.
  • templates: Template related actions such as list, show, etc.

statue commands

Commands related actions such as list, install, show, etc.

Usage:

statue commands [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • install: Install missing commands.
  • list: List matching commands to contexts, allow list and deny list.
  • show: Show information about specific command.

statue commands install

Install missing commands.

Usage:

statue commands install [OPTIONS]

Options:

  --silent                        Set verbosity to "silent".
  --verbose                       Set verbosity to "verbose".
  --verbosity [normal|silent|verbose]
                                  [default: normal]
  --help                          Show this message and exit.

statue commands list

List matching commands to contexts, allow list and deny list.

Usage:

statue commands list [OPTIONS]

Options:

  --help  Show this message and exit.

statue commands show

Show information about specific command.

Usage:

statue commands show [OPTIONS] COMMAND_NAME

Options:

  --help  Show this message and exit.

statue config

Configuration related actions.

Usage:

statue config [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

statue config add-command

Add new command to configuration.

Usage:

statue config add-command [OPTIONS]

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config add-context

Add new context to configuration.

Usage:

statue config add-context [OPTIONS]

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config add-source

Add new source to configuration.

Usage:

statue config add-source [OPTIONS] [SOURCES]...

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config disable-cache

Disabled caching in configuration.

Usage:

statue config disable-cache [OPTIONS]

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config edit-command

Edit context from configuration.

Usage:

statue config edit-command [OPTIONS] COMMAND_NAME

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config edit-context

Edit context from configuration.

Usage:

statue config edit-context [OPTIONS] CONTEXT_NAME

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config edit-source

Edit a source from configuration.

Usage:

statue config edit-source [OPTIONS] SOURCE

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config enable-cache

Enabled caching in configuration.

Usage:

statue config enable-cache [OPTIONS]

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config fix-versions

Fixate the installed version of the commands.

This helps you make sure that you use the same checkers in all commands across time.

Usage:

statue config fix-versions [OPTIONS]

Options:

  --config FILE  Statue configuration file.
  -l, --latest   Update commands to latest before fixing the version. If a
                 command is not installed, will install it.
  --verbose      Set verbosity to "verbose".
  --help         Show this message and exit.

statue config init

Initialize configuration for Statue.

By default, this command searches for sources files in the given directory (cwd by default) and sets them with default contexts.

You can run this command with the "-i" flag in order to choose interactively which source files to track and which contexts to assign to them.

Usage:

statue config init [OPTIONS]

Options:

  --config FILE                  Statue configuration file.
  -t, --template TEXT            Configuration template name
  --with-sources / --no-sources  Track available sources and add to
                                 configuration
  -e, --exclude PATH             Sources paths that Statue will ignore
                                 tracking
  -y
  --git / --no-git               Should use git to trace ignored files
  --fix-versions                 Fix versions in config when running
  -i, --install                  Install latest version for all commands in
                                 configuration
  --blank                        Initialize blank configuration
  --help                         Show this message and exit.

statue config remove-command

Remove command from configuration.

Usage:

statue config remove-command [OPTIONS] COMMAND_NAME

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config remove-context

Remove context from configuration.

Usage:

statue config remove-context [OPTIONS] CONTEXT_NAME

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config remove-source

Remove context from configuration.

Usage:

statue config remove-source [OPTIONS] SOURCE

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config set-history-size

Choose which runner mode will be used by default.

Usage:

statue config set-history-size [OPTIONS] SIZE

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config set-mode

Choose which runner mode will be used by default.

Usage:

statue config set-mode [OPTIONS] {sync|async}

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue config show

Show configuration file context.

Usage:

statue config show [OPTIONS]

Options:

  --config FILE  Statue configuration file.
  --help         Show this message and exit.

statue contexts

Contexts related actions such as list, show, etc.

Usage:

statue contexts [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • list: Print all available contexts.
  • show: Print all available contexts.

statue contexts list

Print all available contexts.

Usage:

statue contexts list [OPTIONS]

Options:

  --help  Show this message and exit.

statue contexts show

Print all available contexts.

Usage:

statue contexts show [OPTIONS] CONTEXT_NAME

Options:

  --help  Show this message and exit.

statue history

History related actions such as list, show, etc.

Usage:

statue history [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • clear: Clear records of previous statue runs.
  • list: List all recent evaluations.
  • show: Show past evaluation.

statue history clear

Clear records of previous statue runs.

Usage:

statue history clear [OPTIONS]

Options:

  -f, --force          Force deletion and avoid prompt.
  -l, --limit INTEGER  Limit the number of deleted records. Deletes earliest
                       evaluations.
  --help               Show this message and exit.

statue history list

List all recent evaluations.

Usage:

statue history list [OPTIONS]

Options:

  --head INTEGER  Show only the nth recent evaluations
  --help          Show this message and exit.

statue history show

Show past evaluation.

Usage:

statue history show [OPTIONS]

Options:

  -n INTEGER  Show nth recent evaluation. 1 by default
  --verbose   Set verbosity to "verbose".
  --help      Show this message and exit.

statue run

Run static code analysis commands on sources.

Source files to run Statue on can be presented as positional arguments. When no source files are presented, will use configuration file to determine on which files to run

Usage:

statue run [OPTIONS] [SOURCES]...

Options:

  -c, --context TEXT              Context in which to evaluate the commands.
  -a, --allow TEXT                Allowed command.
  -d, --deny TEXT                 Denied command.
  -i, --install                   Install commands before running if missing
  -p, --previous INTEGER          Run commands of the nth recent evaluation.
                                  combine this flag with "-f" in order to run
                                  only failed commands from that evaluation
  -r, --recent                    Run commands of the most recent evaluation.
                                  Same as "--previous 1".
  -f, --failed                    Run commands from the most recent failed run
  -fo, --failed-only              Same as "--failed", but will only run the
                                  commands and not those who ended
                                  successfully
  --cache / --no-cache            Save evaluation to cache or not
  --silent                        Set verbosity to "silent".
  --verbose                       Set verbosity to "verbose".
  --verbosity [normal|silent|verbose]
                                  [default: normal]
  --mode [sync|async]             Should run asynchronously or not.
  -o, --output FILE               Output path to save evaluation result
  --help                          Show this message and exit.

statue show-tree

Show sources configuration as a tree.

This method prints the sources' configuration as a tree, including: contexts, allow and deny lists and matching commands.

Usage:

statue show-tree [OPTIONS]

Options:

  -c, --context TEXT  Context in which to evaluate the commands.
  -a, --allow TEXT    Allowed command.
  -d, --deny TEXT     Denied command.
  --help              Show this message and exit.

statue templates

Template related actions such as list, show, etc.

Usage:

statue templates [OPTIONS] COMMAND [ARGS]...

Options:

  --help  Show this message and exit.

Subcommands

  • clear: Remove template by name.
  • list: List all available templates.
  • remove: Remove template by name.
  • save: Save current configuration as template.
  • show: Show template by name.

statue templates clear

Remove template by name.

Usage:

statue templates clear [OPTIONS]

Options:

  --help  Show this message and exit.

statue templates list

List all available templates.

Usage:

statue templates list [OPTIONS]

Options:

  --help  Show this message and exit.

statue templates remove

Remove template by name.

Usage:

statue templates remove [OPTIONS] TEMPLATE_NAME

Options:

  --help  Show this message and exit.

statue templates save

Save current configuration as template.

Usage:

statue templates save [OPTIONS] TEMPLATE_NAME

Options:

  --config FILE              Statue configuration file.
  --override / -no-override  Override template with given name if already
                             exists.
  --help                     Show this message and exit.

statue templates show

Show template by name.

Usage:

statue templates show [OPTIONS] TEMPLATE_NAME

Options:

  --help  Show this message and exit.