This command, without arguments, shows you an overview of the custom reports you have configured. With an argument, it will show you that report.

Usage: smos-query report [REPORT] [--pretty | --yaml | --json | --pretty-json]

  Run prepared reports

Available options:
  REPORT                   The prepared report to run
  --pretty                 pretty text
  --yaml                   Yaml
  --json                   single-line JSON
  --pretty-json            pretty JSON
  -h,--help                Show this help text

Global options:
  --config-file FILE_PATH  The config file to use
  --workflow-dir DIRECTORY_PATH
                           The workflow directory to use
  --archive-dir DIRECTORY_PATH
                           The archive directory to use
  --projects-dir DIRECTORY_PATH
                           The projects directory to use
  --archived-projects-dir DIRECTORY_PATHPATH
                           The archived projects directory to use

This command does not use any extra environment variables.

# Configuration
report: # optional
  # PreparedReportConfiguration
  reports: # optional
    # Custom reports
    # or null
    <key>: 
      # PreparedReport
      description: # optional
        # A description of the report
        # or null
        <string>
      filter: # optional
        # The entry filter to get the results in the report
        # or null
        def: EntryFilter
        # A filter is a string of one of the following forms:
        # 
        # tag:<tag>
        # state:<state>
        # file:<file>
        # level:<level>
        # header:<header>
        # property:<property-name>
        # property:<property-name>:<property-value>
        # property:<property-name>:time:<comparison>:<time>
        # parent:<filter>
        # ancestor:<filter>
        # child:<filter>
        # legacy:<filter>
        # not:<filter>
        # (<filter> and <filter>)
        # (<filter> or <filter>)
        <string>
      columns: # optional
        # The columns of the report
        # or null
        - def: Projection
          # A column (projection) is a string of one of the following forms:
          # 
          # file
          # state
          # header
          # tag:<tag-name>
          # property:<property-name>
          # timestamp:<timestamp-name>
          # ancestor:<projection>
          <string>
      sorter: # optional
        # The sorter to sort the rows of the report by
        # or null
        def: Sorter
        # A sorter is a string of one of the following forms:
        # 
        # file
        # header
        # state
        # tag:<tag>
        # property:<property-name>
        # property-as-time:<property-name>
        # timestamp:<timestamp-name>
        # reverse:<sorter>
        # (<sorter> then <sorter>)
        <string>
      hide-archive: # optional
        # Whether to consider the archive for the report
        # or null
        <boolean>