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 <k=v>…] [--set <ns.k=v>…] [--full] [--trust] [--verbose]

Flags

FlagDescription
--env-erequiredEnvironment name.
--api-aAPI slug.
--varrepeatableOverride an environment variable: key=value. The variable must be declared in the environment schema.
--setrepeatableOverride a request parameter: <path|query|header|body>.key=value. Body keys support dot-notation.
--fullPrint the full execution result instead of just the response body.
--trustAllow this project's scripts to run for this invocation only. Never saved.
--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

See also