dave-dredd/options.json

HTTP API Testing Framework

{
  "dry-run": {
    "alias": "y",
    "description": "Do not run any real HTTP transaction, only parse API description document and compile transactions.",
    "default": null
  },
  "hookfiles": {
    "alias": "f",
    "description": "Path to hook files. Can be used multiple times, supports glob patterns. Hook files are executed in alphabetical order.",
    "default": null
  },
  "language": {
    "alias": "a",
    "description": "Language of hookfiles. Possible options are: nodejs, ruby, python, php, perl, go, rust",
    "default": "nodejs"
  },
  "require": {
    "description": "When using nodejs hooks, require the given module before executing hooks",
    "default": null
  },
  "server": {
    "alias": "g",
    "description": "Run API backend server command and kill it after Dredd execution. E.g. `rails server`",
    "default": null
  },
  "server-wait": {
    "description": "Set delay time in seconds between running a server and test run.",
    "default": 3
  },
  "init": {
    "alias": "i",
    "description": "Run interactive configuration. Creates dredd.yml configuration file.",
    "default": false
  },
  "custom": {
    "alias": "j",
    "description": "Pass custom key-value configuration data delimited by a colon. E.g. -j 'a:b'",
    "default": []
  },
  "names": {
    "alias": "n",
    "description": "Only list names of requests (for use in a hookfile). No requests are made.",
    "default": false
  },
  "only": {
    "alias": "x",
    "description": "Run only specified transaction name. Can be used multiple times",
    "default": []
  },
  "reporter": {
    "alias": "r",
    "description": "Output additional report format. This option can be used multiple times to add multiple reporters. Options: xunit, nyan, dot, markdown, html, apiary.",
    "default": []
  },
  "output": {
    "alias": "o",
    "description": "Specifies output file when using additional file-based reporter. This option can be used multiple times if multiple file-based reporters are used.",
    "default": []
  },
  "header": {
    "alias": "h",
    "description": "Extra header to include in every request. This option can be used multiple times to add multiple headers.",
    "default": []
  },
  "sorted": {
    "alias": "s",
    "description": "Sorts requests in a sensible way so that objects are not modified before they are created. Order: CONNECT, OPTIONS, POST, GET, HEAD, PUT, PATCH, LINK, UNLINK, DELETE, TRACE.",
    "default": false
  },
  "user": {
    "alias": "u",
    "description": "Basic Auth credentials in the form username:password.",
    "default": null
  },
  "inline-errors": {
    "alias": "e",
    "description": "Determines whether failures and errors are displayed as they occur (true) or aggregated and displayed at the end (false).",
    "default": false
  },
  "details": {
    "alias": "d",
    "description": "Determines whether request/response details are included in passing tests.",
    "default": false
  },
  "method": {
    "alias": "m",
    "description": "Restrict tests to a particular HTTP method (GET, PUT, POST, DELETE, PATCH). This option can be used multiple times to allow multiple methods.",
    "default": []
  },
  "color": {
    "description": "Use --color/--no-color to enable/disable colored output",
    "boolean": true,
    "default": true
  },
  "loglevel": {
    "alias": "l",
    "description": "Application logging level. Supported levels: 'debug', 'warning', 'error', 'silent'. The value 'debug' also displays timestamps.",
    "default": "warning"
  },
  "path": {
    "alias": "p",
    "description": "Additional API description paths or URLs. Can be used multiple times with glob pattern for paths.",
    "default": []
  },
  "help": {
    "description": "Show usage information."
  },
  "version": {
    "description": "Show version number."
  },
  "hooks-worker-timeout": {
    "description": "How long to wait for hooks handler to start. [ms]",
    "default": 5000
  },
  "hooks-worker-connect-timeout": {
    "description": "Total hooks handler connection timeout (includes all retries). [ms]",
    "default": 1500
  },
  "hooks-worker-connect-retry": {
    "description": "How long to wait between attempts to connect to hooks handler. [ms]",
    "default": 500
  },
  "hooks-worker-after-connect-wait": {
    "description": "How long to wait between connecting to hooks handler and start of testing. [ms]",
    "default": 100
  },
  "hooks-worker-term-timeout": {
    "description": "How long to wait between trying to terminate hooks handler and killing it. [ms]",
    "default": 5000
  },
  "hooks-worker-term-retry": {
    "description": "How long to wait between attempts to terminate hooks handler. [ms]",
    "default": 500
  },
  "hooks-worker-handler-host": {
    "description": "Host of the hooks handler.",
    "default": "127.0.0.1"
  },
  "hooks-worker-handler-port": {
    "description": "Port of the hooks handler.",
    "default": 61321
  },
  "config": {
    "description": "Path to dredd.yml config file.",
    "default": "./dredd.yml"
  }
}