JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q47933F

Package Exports

  • postboy-tui
  • postboy-tui/dist/cli

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (postboy-tui) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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

  • 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

# Using bun
bun install

# Or using npm
npm install

Usage

Run in Development

# Start the TUI (Text User Interface)
bun run src/index.ts ui

# Or with npm
npm start -- ui

CLI Commands

  • Launch TUI interface:

    bun run src/index.ts ui
# or, if installed globally:
postboy ui

  • Send a test API request (interactive prompt):

    bun run src/index.ts test
# or
postboy test

  • List available mock API endpoints:

    bun run src/index.ts mock-list
# or
postboy mock-list

Build and Install Globally (Optional)

To use the postboy command anywhere:

bun run build
bun add -g .
# Now you can use:
postboy ui
postboy test
postboy 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.

image

2. Request Composer

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

image

3. History Management

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

image

4. Response Viewer

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

image

5. Theming

Switch between light and dark themes to suit your preference.

Screenshot: Theming

6. Mock Server

Spin up local mock endpoints for testing your API clients without needing a real backend.

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

License

MIT

Contact

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