definitions

Usage

➜  ~ mprove definitions -h
Print the CLI definitions

━━━ Usage ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

$ mprove definitions

━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  --json    (default false)

━━━ Examples ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Print the CLI definitions
  $ mprove definitions

Example Output

➜  ~ mprove definitions
...
-
  path:        mprove get-query
  usage:       mprove get-query
  description:
    """
      Get query

    """
  examples:
    -
      -
        """
          Get query for Dev repo visualization

        """
      - mprove get-query --project-id DXYE72ODCP5LWPWH2EXQ --repo dev --branch main --env prod --viz-id v1 --get-sql --get-data
    -
      -
        """
          Get query for Dev repo dashboard

        """
      - mprove get-query --project-id DXYE72ODCP5LWPWH2EXQ --repo dev --branch main --env prod --dashboard-id d1 --get-sql --get-data
  options:
    -
      definition:  --project-id #0
      description: (required) Project Id
      required:    false
    -
      definition:  --repo #0
      description: (required, "dev" or "production")
      required:    true
    -
      definition:  --branch #0
      description: (required) Git Branch
      required:    true
    -
      definition:  --env #0
      description: (required) Environment
      required:    true
    -
      definition:  --dashboard-id #0
      description: (dashboard-id or viz-id required) Dashboard Id (name)
      required:    false
    -
      definition:  --report-index #0
      description: (optional) Dashboard Report Index starting with 0
      required:    false
    -
      definition:  --viz-id #0
      description: (dashboard-id or viz-id required) Visualization Id (name)
      required:    false
    -
      definition:  --get-sql
      description: (default false), show query sql in output
      required:    false
    -
      definition:  --get-data
      description: (default false), show query data in output
      required:    false
    -
      definition:  --json
      description: (default false)
      required:    false
    -
      definition:  --env-file-path #0
      description: (optional) Path to ".env" file
      required:    false
...