Quick Start

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

Install curl-runner

Install using your preferred package manager

bun install -g @curl-runner/cli

bun install -g @curl-runner/cli

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

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

Run the request

Execute your configuration file

curl-runner simple.yaml

curl-runner simple.yaml

View the results

See the formatted output in your terminal

✅ Get JSONPlaceholder Post
   Status: 200 OK
   Time: 245ms
   Size: 292 bytes

📊 Execution Summary
   ✅ Successful: 1
   ❌ Failed: 0
   ⏱️  Total Time: 245ms

✅ Get JSONPlaceholder Post
   Status: 200 OK
   Time: 245ms
   Size: 292 bytes

📊 Execution Summary
   ✅ Successful: 1
   ❌ Failed: 0
   ⏱️  Total Time: 245ms

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

# 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

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

# 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