Skip to content

Command line ​

text
hurl-orchestra [options] [paths ...] [-- hurl options ...]

Options ​

OptionDefaultDescription
paths.A directory with .hurl files, or one or more .hurl files. The default is the current directory.
--report-zip FILEreport.zipWrite the hurl reports of all nodes to this zip file.
--report-ctrf FILE-Also write a CTRF JSON report to this file.
--env-file FILE-Give this variables file to each hurl call. The default is .env in the given directory, or in the current directory for files.
--no-deps-Run only the listed .hurl files. Do not add their declared deps from the same directory.
--dry-run-Show the execution plan. Do not run hurl.
--json-With --dry-run, write the plan as JSON for scripts and AI agents.
--strict-Make a failure that matches known_failures fail the run.
--diagram-Write a Mermaid diagram of the graph. Do not run the tests.
--diagram-output FILEdiagram.mdWrite the diagram to this file. Use '-' for stdout.
--diagram-overwrite-Replace the diagram file if it exists.

A script makes this table from the parser of the command. Thus the table and hurl-orchestra --help always agree.

Paths ​

PathsMode
NoneDirectory mode on the current directory.
One path that does not end in .hurlDirectory mode on that directory.
One or more .hurl filesFile mode. hurl-orchestra adds the dependencies from the same directories.

Hurl options ​

Put Hurl options after --. hurl-orchestra gives them to each Hurl call. For more information, read Give flags to Hurl.

hurl-orchestra always gives these options to Hurl: --test, --report-json and, if a variables file applies, --variables-file.

JSON plan ​

hurl-orchestra --dry-run --json writes one JSON document to stdout:

json
{
  "ok": true,
  "env_file": "tests/.env",
  "resolved": ["add_item", "auth", "create_cart"],
  "waves": [["auth"], ["create_cart"], ["add_item"], ["checkout"]],
  "nodes": [
    {
      "id": "add_item",
      "file": "tests/add_item.hurl",
      "deps": ["auth", "create_cart"],
      "outputs": [],
      "variables": ["auth_token", "create_cart_cart_id"],
      "priority": 0,
      "known_failures": [],
      "retry_attempts": 1
    }
  ]
}
FieldDescription
oktrue if the graph is valid.
errorThe error message. It shows only when ok is false.
env_fileThe variables file of the run, or null.
resolvedThe nodes that file mode added as dependencies.
wavesThe node IDs of each wave, in the sequence of execution.
nodes[].fileThe file of the node. For an alias, it is the file of the template.
nodes[].variablesThe variables that the node gets from its dependencies.
nodes[].retry_attemptsThe value of retry.attempts. 1 means no retry.