bananareporter/oclif.manifest.json

Easily generate a report from multiple sources

{
  "version": "0.4.4",
  "commands": {
    "run": {
      "id": "run",
      "description": "Run report",
      "strict": true,
      "pluginName": "bananareporter",
      "pluginAlias": "bananareporter",
      "pluginType": "core",
      "aliases": [],
      "examples": [
        "$ banana-reporter run --from 2023-01-01 --to 2023-01-31\nreport with 138 entries saved to ./bananareporter.json\n"
      ],
      "flags": {
        "config": {
          "name": "config",
          "type": "option",
          "char": "c",
          "description": "config file location, by default ~/.config/bananareporter/config.yaml",
          "required": false,
          "multiple": false
        },
        "from": {
          "name": "from",
          "type": "option",
          "description": "from date (ISO8601)",
          "required": false,
          "helpValue": "2023-06-01",
          "multiple": false
        },
        "to": {
          "name": "to",
          "type": "option",
          "description": "to date (ISO8601)",
          "required": false,
          "helpValue": "2023-06-30",
          "multiple": false,
          "dependsOn": [
            "from"
          ]
        },
        "out": {
          "name": "out",
          "type": "option",
          "char": "o",
          "description": "file path or directory to save the output",
          "required": true,
          "multiple": false,
          "default": "./bananareporter_$FROM__$TO.json",
          "aliases": [
            "output"
          ]
        },
        "format": {
          "name": "format",
          "type": "option",
          "description": "output file format",
          "required": true,
          "multiple": false,
          "options": [
            "json",
            "jsonl",
            "csv"
          ],
          "default": "json"
        },
        "delay": {
          "name": "delay",
          "type": "option",
          "description": "global delay in millisecons between http requests",
          "multiple": false,
          "default": 300
        },
        "include-raw-object": {
          "name": "include-raw-object",
          "type": "boolean",
          "description": "include raw object in json/jsonl reporter output",
          "allowNo": false
        },
        "disable-welcome-emoji": {
          "name": "disable-welcome-emoji",
          "type": "boolean",
          "description": "disable banana welcome emoji",
          "hidden": true,
          "allowNo": false
        }
      },
      "args": {}
    }
  }
}