Postboy

A modern, terminal-based API testing and development tool with a clean TUI (Text User Interface). Postboy helps you design, test, and debug HTTP requests efficiently, all from your terminal.

Table of Contents

• Features
• Installation
• Usage
• Feature Details
• Contributing
• License
• Contact

Features

• Intuitive TUI: Clean, keyboard-driven interface for rapid API testing.
• Request Composer: Easily create and edit HTTP requests (GET, POST, PUT, DELETE, etc.).
• History Management: Automatically saves and organizes your request history.
• Response Viewer: Pretty-prints JSON, XML, and raw responses.
• Theming: Switch between ten different themes.
• Mock Server: Quickly spin up mock endpoints for local testing.
• Logging: Detailed request/response logs for debugging.
• Keyboard Shortcuts: Efficient navigation and actions.
• Configurable: Customize settings to fit your workflow.

Installation

npm i -g postboy-tui@latest
#or
bun i -g postboy-tui@latest

Usage

CLI Commands

• Launch TUI interface:

  postboy-tui ui

• Send a test API request (interactive prompt):

  postboy-tui run

• List available mock API endpoints:

  postboy-tui mock-list

Feature Details

1. Intuitive TUI

A clean, keyboard-driven interface designed for productivity. Navigate between panels, compose requests and view responses without leaving your terminal.

2. Request Composer

Create and edit HTTP requests with support for all major methods. Add headers, body and query parameters with ease.

3. History Management

Automatically saves every request you make. Browse, search and re-run previous requests.

4. Response Viewer

View responses in a pretty-printed format. Supports JSON, XML and raw text. Syntax highlighting for easy reading.

5. Theming

Switch between light and dark themes to suit your preference.

6. Mock APIs list

• categorized mock api lists
• get a bunch of mock apis for testing the clients under development.

7. Logging

Detailed logs of all requests and responses, including headers, status codes, and timings.

8. Keyboard Shortcuts

Navigate and perform actions quickly using intuitive keyboard shortcuts.

9. Configurable

Customize settings such as themes, default headers, and more to fit your workflow.

Contributing

Contributions are welcome! Please open issues or submit pull requests for new features, bug fixes, or improvements.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/YourFeature)
3. Commit your changes (git commit -m 'Add some feature')
4. Push to the branch (git push origin feature/YourFeature)
5. Open a pull request

Contact

For support, questions, or feedback, please open an issue or contact the maintainer.