Quick Start

Send your first HTTP request with tgrs in seconds.

Basic Syntax

The tgrs Command

The basic syntax follows a natural pattern: method, URL, and optional key-value pairs.

tgrs [METHOD] URL [KEY:VALUE ...]

If you omit the method, tgrs defaults to GET. Specify the method explicitly for POST, PUT, PATCH, and DELETE requests.

Your First Request

Simple GET Request

Fetch data from an API endpoint.

# GET is the default method

tgrs https://api.example.com/users

POST with JSON Body

Send JSON data using key:value pairs. tgrs automatically sets the Content-Type to application/json.

tgrs POST https://api.example.com/users name:John email:john@example.com

This sends the following JSON body:

{"name": "John", "email": "john@example.com"}

Explicit Method

You can specify any HTTP method explicitly.

# GET request

tgrs GET https://api.example.com/users

# POST request

tgrs POST https://api.example.com/users name:John email:john@example.com

# PUT request

tgrs PUT https://api.example.com/users/1 name:Jane

# PATCH request

tgrs PATCH https://api.example.com/users/1 status:active

# DELETE request

tgrs DELETE https://api.example.com/users/1

Common Options

Frequently Used Flags

-vVerbose output — show request headers, response headers, timing, and size
-HAdd a custom header
-dSend a request body
-uBasic authentication
-aAdd an assertion
-LFollow redirects

Quick Examples

# Verbose output with headers and timing

tgrs GET https://api.example.com/users -v

# Add custom header

tgrs GET https://api.example.com/data -H "X-Api-Key: my-key"

# Basic auth

tgrs GET https://api.example.com/admin -u admin:secret

# Assert status code is 200

tgrs GET https://api.example.com/health -a "status eq 200"

# Follow redirects

tgrs GET https://example.com/redirect -L

Getting Help

Built-in Help

Access the full list of commands and flags anytime.

# Detailed help with full descriptions

tgrs --help

# Short summary of all flags

tgrs -h

# Show help for the run command

tgrs run --help

# Show version

tgrs --version

Note: --help shows detailed descriptions for each flag, while -h shows a compact summary. Use --help when you need more context about a specific flag.
Tip: Explore the rest of this guide to learn about every feature in detail — from authentication and assertions to load testing and flow automation.