How do I get help for the CLI?

Table of Contents

Display global help showing all top-level commands and global options of ores.cli. See the CLI inventory for sibling recipes.

Question

How do I get help for the CLI?

Answer

./ores.cli --help
ORE Studio is a User Interface for Open Source Risk Engine (ORE).
CLI provides a command line version of the interface.
ORE Studio is created by the ORE Studio project.
ores.cli uses a domain-based interface: <domain> <entity> <operation> <options>.
See below for a list of valid domains and their entities.

Global options:

General:
  -h [ --help ]                       Display usage and exit.
  -v [ --version ]                    Output version information and exit.

Logging:
  -e [ --log-enabled ]                Generate a log file.
  -l [ --log-level ] arg (=info)      What level to use for logging. Valid
                                      values: trace, debug, info, warn, error.
  --log-to-console                    Output logging to the console, as well as
                                      to file.
  --log-directory arg (=log)          Where to place the log files.
  --log-filename arg (=ores.cli.log)  Name of the log file.

Domains:

   refdata        Reference data: currencies, countries.
   iam            Identity and access management: accounts, roles, permissions, login-info.
   dq             Data quality: change-reasons, change-reason-categories.
   variability    Feature flags and variability: feature-flags.

For entity and operation specific options, use: <domain> <entity> <operation> --help

Emacs 29.3 (Org mode 9.6.15)