JSPM

reqzilla

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1
  • Score
    100M100P100Q22038F
  • License MIT

a lightweight and powerful CLI tool for testing REST APIs directly from the terminal

Package Exports

  • reqzilla

Readme

Table of Contents

  1. ReqZilla
  2. Features
  3. Installation
  4. Usage
  5. Examples
  6. Contributing
  7. License

ReqZilla

A lightweight and powerful CLI tool for testing REST APIs directly from the terminal.

Features

  • Simple and intuitive command-line interface.
  • Supports GET, POST, PATCH, and DELETE requests.
  • Allows sending JSON data.
  • Saves responses to a file.
  • Displays detailed response information in verbose mode.
  • Displays only headers if required.
  • Supports setting request headers, including Authorization headers (e.g., Bearer tokens for JWT).
  • Follows url redirects automatically

Installation

ReqZilla requires Node.js 14 or later. You can check your version by running:

npm -v

To install ReqZilla globally using npm, run:

npm install -g reqzilla

Usage

After installation, you can use reqzilla directly from your terminal.

You can get help:

reqzilla --help

also you can get help on every existing command or option

Sending Requests

GET Request

reqzilla get <url>

Example:

reqzilla get https://jsonplaceholder.typicode.com/posts/1

POST Request

reqzilla post <url> -d '<JSON data>'

Example:

reqzilla post https://jsonplaceholder.typicode.com/posts -d '{"title": "foo", "body": "bar", "userId": 1}'

PATCH Request

reqzilla patch <url> -d '<JSON data>'

Example:

reqzilla patch https://jsonplaceholder.typicode.com/posts/1 -d '{"title": "updated title"}'

DELETE Request

reqzilla delete <url>

Example:

reqzilla delete https://jsonplaceholder.typicode.com/posts/1

Additional Options

  • -H, --Header <header>: Add request headers (supports all types, including JWT Authorization headers).
  • -o, --outputFile <FileName>: Save response to a file.
  • -v, --verbose: Show detailed response info (status, headers, and body).
  • -I, --onlyHeaders: Show only response headers.

Examples

Example with Headers

reqzilla get https://jsonplaceholder.typicode.com/posts/1 -H 'Accept: application/json'

Example with Output to File

reqzilla get https://jsonplaceholder.typicode.com/posts/1 -o response.json

Example Verbose Mode

reqzilla get https://jsonplaceholder.typicode.com/posts/1 -v

Example with Only Headers

reqzilla get https://jsonplaceholder.typicode.com/posts/1 -I

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request on GitHub: ReqZilla Repository

License

This project is licensed under the MIT License.

Happy testing with ReqZilla!