Skip to content

YAML Wizard

Answer a few questions, get a working test.

curl-runner init asks for a URL, a method and a name and writes the file. The full wizard walks through headers, body, auth, retries and validation, starting from a template if you like — then offers to run it.

request.yaml
# curl-runner init --wizard, "API Test" template
request:
  name: List users
  url: https://api.example.com/users
  method: GET
  expect:
    status: 200
    responseTime: "< 2000"

Benefits

  • Start from a template

    Basic GET, basic POST, API test, file upload and auth flow templates fill in sensible defaults.

  • Edit what you have

    curl-runner edit opens an existing file in the wizard and keeps the keys it doesn’t ask about.

  • Run it straight away

    The wizard saves the file and offers to run it, so you see a real response in the first minute.

Good for

  1. Writing your first curl-runner file
  2. Teammates new to the YAML format
  3. Scaffolding a test for a new endpoint
  4. Adding auth or retries to an existing file