curl-runner Documentation

A powerful CLI tool for HTTP request management using YAML configuration files. Built with Bun for blazing-fast performance.

Features

YAML Configuration

Define HTTP requests using simple, readable YAML files with support for variables and templates.

Fast Execution

Built with Bun for blazing-fast performance. Execute requests sequentially or in parallel.

Powerful CLI

Comprehensive command-line interface with beautiful output, progress indicators, and error handling.

Flexible Configuration

Global settings, variable interpolation, response validation, and customizable output formats.

Quick Start

Get up and running with curl-runner in just a few minutes.

1. Create a YAML file

simple.yaml
# Basic API test configuration
collection:
  name: "My API Tests"
  requests:
    - name: "Get users"
      url: "https://jsonplaceholder.typicode.com/users"
      method: GET
      expect:
        status: 200
        
    - name: "Create user"
      url: "https://jsonplaceholder.typicode.com/users"
      method: POST
      headers:
        Content-Type: "application/json"
      body: |
        {
          "name": "John Doe",
          "email": "john@example.com"
        }
      expect:
        status: 201

2. Run curl-runner

# Install curl-runner globally
npm install -g curl-runner

# Or using yarn
yarn global add curl-runner

# Or using pnpm
pnpm install -g curl-runner

Next Steps

Installation Guide

Detailed installation instructions for all platforms

Get Started

YAML Structure

Learn the YAML configuration format and options

Learn More

Examples

Browse real-world examples and use cases

Explore