Quick Start

Get up and running with curl-runner in just a few minutes. Follow these simple steps to make your first HTTP request.

Copy Markdown
1

Install curl-runner

Install using your preferred package manager

bun install -g @curl-runner/cli
2

Create your first YAML file

Define your HTTP request configuration

simple.yaml
# simple.yaml
request:
  name: Get JSONPlaceholder Post
  url: https://jsonplaceholder.typicode.com/posts/1
  method: GET
3

Run the request

Execute your configuration file

curl-runner simple.yaml
4

View the results

See the formatted output in your terminal

ℹ Found 1 YAML file(s)
ℹ Processing: simple.yaml

✓ Get JSONPlaceholder Post [simple]
   ├─ GET: https://jsonplaceholder.typicode.com/posts/1
   ├─ ✓ Status: 200
   └─ Duration: 245ms | 292.00 B

Summary: 1 request completed successfully

More Examples

Try these more advanced examples to explore curl-runner's capabilities.

Request Collection

Sequential

Execute multiple requests in sequence with shared variables.

collection.yaml
# collection.yaml
global:
  variables:
    BASE_URL: https://jsonplaceholder.typicode.com
  execution: sequential

requests:
  - name: Get All Posts
    url: ${BASE_URL}/posts
    method: GET
    
  - name: Get Specific Post
    url: ${BASE_URL}/posts/1
    method: GET
    
  - name: Get Post Comments
    url: ${BASE_URL}/posts/1/comments
    method: GET
curl-runner collection.yaml

Parallel Execution

Parallel

Run multiple requests simultaneously for faster execution.

parallel.yaml
# parallel.yaml
global:
  execution: parallel
  continueOnError: true

requests:
  - name: Check API Health
    url: https://jsonplaceholder.typicode.com/posts/1
    method: GET
    
  - name: Check Users Endpoint
    url: https://jsonplaceholder.typicode.com/users/1
    method: GET
    
  - name: Check Albums Endpoint
    url: https://jsonplaceholder.typicode.com/albums/1
    method: GET
curl-runner parallel.yaml -v

Tips & Tricks

CLI Options

-v —Enable verbose output
-p —Run requests in parallel
-c —Continue on errors
--output results.json —Save results

File Patterns

*.yaml —Run all YAML files
tests/ —Run all files in directory
--all —Search recursively
api-*.yaml —Pattern matching

What's Next?

Learn YAML Structure

Understand the full configuration format

Read Guide

Explore Variables

Use variables and templating

Learn More

Browse Examples

Real-world use cases and patterns

View Examples

Continue Learning

Now that you've made your first request, explore these advanced features

Response Validation

Automatically validate API responses to ensure they meet your expectations

Request Collections

Organize multiple related requests into collections for better workflow management

CLI Commands

Master all command-line options and flags for advanced usage

Parallel Execution

Execute multiple requests concurrently for performance testing and faster workflows