Skip to content

A simple and easy to use REST API client that runs in your terminal (TUI). Open-source alternative to Postman.

License

Notifications You must be signed in to change notification settings

cadamsdev/restman

Repository files navigation

RestMan Logo

RestMan

A simple and easy to use REST API client that runs in your terminal. Open-source alternative to Postman.

RestMan RestMan License PRs Welcome

RestMan Preview

❤️ Sponsors

Support development by becoming a sponsor! Your avatar or company logo will appear below.

Become a Sponsor

✨ Features

  • Make HTTP requests (GET, POST, PUT, PATCH, DELETE)
  • Add custom headers, query params, and request body
  • View response status, headers, timing, and formatted body
  • Save frequently-used requests and browse history
  • Manage environments with variable substitution ({{BASE_URL}}, {{API_KEY}}, etc.)
  • Fully keyboard-driven (no mouse required)

📸 Screenshots

Click to view screenshots

Main Interface

Main Interface

Request History

Request History

Save Requests

Save Request

Environment Management

Environments

Environment Editor

Edit Environment

View Full Response

View Response Body

Change HTTP Method

Change Method

Help Menu

Help

📦 Installation

Quick Install

Linux & macOS:

curl -fsSL https://userestman.vercel.app/install.sh | bash

Windows:

powershell -c "irm https://userestman.vercel.app/install.ps1 | iex"

Manual Installation

Download the latest release for your platform from GitHub Releases:

  • Linux: restman-linux-x64.tar.gz or restman-linux-arm64.tar.gz
  • macOS: restman-darwin-x64.zip or restman-darwin-arm64.zip
  • Windows: restman-windows-x64.zip

Extract the archive and add the binary to your PATH.

macOS users: After extracting, you may need to remove the quarantine attribute:

xattr -d com.apple.quarantine /path/to/restman

🚀 Usage

Running the Application

restman

📁 Project Structure

restman/
├── index.tsx           # Application entry point
├── src/                # Source code
│   ├── App.tsx         # Main application component
│   ├── components/     # React UI components
│   ├── *-storage.ts    # Data persistence modules
│   └── *.ts            # Core utilities (HTTP, variables, tokens)
├── website/            # Project website and landing page
├── docs/               # Documentation
├── media/              # Screenshots and assets
├── scripts/            # Build and utility scripts
├── .github/            # GitHub workflows and templates
└── package.json        # Dependencies and scripts

🛠️ Development

# Run the app
bun dev

🤝 Contributing

Contributions are welcome! Feel free to open issues or submit pull requests.

📚 Documentation

📄 License

MIT

About

A simple and easy to use REST API client that runs in your terminal (TUI). Open-source alternative to Postman.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published