🖥️ Gostman

A terminal-based API client built with Bubble Tea for creating, sending, and managing HTTP requests in an interactive and user-friendly way.

✨ Features

• Create and send HTTP requests (GET, POST, PUT, DELETE, etc.).
• Save, load, and manage requests.
• Edit and delete saved requests easily.
• Dynamic UI with support for status messages, and detailed responses.
• Auto-completion for Name/URL fields from your previous inputs.

📥 Install

Go

If you have Go already, install the executable yourself

1. Run the following command:

   go install github.com/halftoothed/gostman@latest

2. The tool is ready to use!

   gostman

Nix

If you are a Nixos user, you can try gostman via flake:

nix run github:HalfToothed/gostman

Or add it to your system:

flake.nix

{
  inputs = {
    ...
    # gostman input
    gostman.url = "github:HalfToothed/gostman";
    # optionally follow your nixpkgs version
    gostman.inputs.nixpkgs.follows = "nixpkgs";
  };
}

configuration.nix

{ inputs, pkgs, ...}: {
  environment.systemPackages =
    let gostman = inputs.gostman.packages.${pkgs.system}.default;
    in [ gostman ];
}

Now you can rebuild your system and run gostman

sudo nixos-rebuild switch && gostman

🧑‍💻 Usage

Use keyboard shortcuts to interact with the UI

• Ctrl + C: Quit the application.
• Tab: Move Around
• Ctrl + Arrow Keys: Change Tabs (Body/Param/Header)
• Enter: Send a request.
• Ctrl + S: Save the current request.
• Ctrl + E: Open Environment Variables page
• Ctrl + D: Open Dashboard.
• Ctrl + H: Open Help page
• Ctrl + Space / Ctrl + @ / Ctrl + F: Auto-complete Name/URL from history
• Up/Down on Method: Cycle HTTP method

Saving and Loading Requests

Requests are saved as JSON files in the user's home directory under a dedicated folder. The JSON file structure allows for efficient updates and deletions.

🤝 Contributing

Contributions are welcome! Please feel free to submit issues or pull requests to improve this project. 🙌