craftr req run

Execute a request instance against an environment. Prints the response body by default.

Usage

craftr req run <resource/name> --env <env> [--api <api>] [--var <key=value>…] [--set <scope.key=value>…] [--enable-middleware <ref>…] [--disable-middleware <ref>…] [--trust] [--from-history] [--max-age <duration>] [--or-run] [--full] [--verbose <level>]

Flags

FlagDescription
--api-aAPI slug.
--env-erequiredEnvironment name.
--varrepeatableOverride an environment variable: key=value. The variable must be declared in the environment schema.
--setrepeatableOverride a request parameter: <path|query|header|cookie|body|middleware>.key=value. Body keys support dot-notation. middleware.<name[#export]>.<key>=<value> overrides a middleware option for this run and enables that middleware.
--enable-middlewarerepeatableEnable a middleware of the request chain for this run only: "name" (every export of that file) or "name#export". Not saved.
--disable-middlewarerepeatableDisable a middleware of the request chain for this run only: "name" or "name#export". Not saved.
--trustAllow this project's scripts to run for this invocation only. Never saved.
--from-historyDon't send the request: re-run after-response middlewares on the latest stored response for this request and environment. Writes no history entry.
--max-ageWith --from-history: only use a stored response younger than this (30s, 10m, 2h, 1d).
--or-runWith --from-history: send the request when no usable stored response exists.
--fullPrint the full execution result instead of just the response body.
--verbose-vPrint the trace to stderr. -v is info, -vv adds debug.

Examples

craftr req run Pet/get-pet -e dev
craftr req run Pet/get-pet -e dev --set path.petId=3 | jq '.name'
craftr req run Pet/get-pet -e dev --var apiKey=sk-test --full
craftr req run Pet/get-pet -e dev --disable-middleware tracing --set middleware.filters#byStatus.status=404
craftr req run Pet/get-pet -e dev --from-history | jq '.name'
craftr req run Pet/get-pet -e dev --from-history --max-age 10m --or-run

See also