How do I install resty on macOS?

Download the script via curl and source it in your shell profile, or use package managers like bpkg or Homebrew if available. The README provides methods for shell package managers like antigen for zsh.

Resty vs httpie: which is better for command-line REST clients?

Resty is lighter and integrates deeply with shell pipelines using functions, while httpie offers a more user-friendly syntax and built-in JSON support. Choose resty for scripting and Unix tool integration, httpie for ease of use and readability.

How to handle JSON responses with resty in a shell script?

Pipe the output to tools like jq for parsing. The README shows examples using jsawk to manipulate JSON data, and you can use the pp script for pretty-printing, but you need to install these dependencies separately.

Can resty handle OAuth authentication?

Resty relies on curl's capabilities, so you can pass OAuth tokens via headers using the -H option. However, it doesn't automate OAuth flows; you must manage token retrieval and renewal manually outside resty.

How to save different host configurations in resty?

Create per-host configuration files in ~/.resty or XDG directories, defining default curl options per HTTP method. The README provides an example format for localhost:8080 to automate common headers and auth.

What are the alternatives to resty for testing APIs from the terminal?

Alternatives include curl directly, httpie, and Postman CLI. Resty is unique for its shell function approach and pipeline integration, but others may offer better documentation or built-in features like request collections.

How to edit request data interactively before sending in resty?

Use the -V option with PUT, PATCH, or POST commands to pipe data into your editor. Set the EDITOR environment variable to customize the editor, as described in the 'Edit PUT/PATCH/POST Data In Vi' section of the README.

Open-Awesome

resty

MITShellv3.0

A tiny shell script wrapper for curl that provides a simple command-line interface for interacting with REST services in pipelines.

GitHub

2.7k stars140 forks0 contributors

What is resty?

Resty is a tiny shell script that wraps curl to provide a simple, function-based command-line interface for interacting with REST APIs. It allows developers to make HTTP requests (GET, POST, PUT, DELETE, etc.) directly from their terminal, integrate with shell pipelines, and process API responses using standard Unix tools.

Target Audience

Developers and DevOps engineers who work with REST APIs from the command line, especially those who need to automate API interactions in shell scripts or pipelines.

Value Proposition

Resty offers a lightweight, shell-native alternative to GUI REST clients or heavier CLI tools, enabling seamless integration with existing shell workflows, powerful pipeline processing, and persistent configuration for efficient API exploration and automation.

Overview

Little command line REST client that you can use in pipelines (bash or zsh).

Use Cases

Best For

Automating REST API interactions in shell scripts
Testing and debugging APIs directly from the terminal
Processing API responses with Unix tools like awk, sed, or jq
Integrating API calls into CI/CD pipelines
Quickly exploring REST endpoints without leaving the shell
Editing JSON payloads interactively before sending requests

Not Ideal For

Teams needing a graphical interface with request history and visual response inspection
Projects requiring built-in API schema validation or automated test generation
Environments where OAuth 2.0 or other complex authentication flows are central, as resty relies on curl's basic auth and manual header handling
Users who prefer all-in-one tools with integrated documentation and collaboration features

Pros & Cons

Pros

Seamless Shell Integration

Functions are loaded into the shell, allowing direct use with pipelines and tools like jq or sed, as shown in the README's examples with jsawk and pp for JSON processing.

Stateful Request Management

Remembers previous arguments and base URIs to reduce typing, and supports per-host configuration files for default curl options, enabling efficient workflow for repeated API calls.

Interactive Data Editing

With the -V option, users can edit PUT/PATCH/POST data in vi or their preferred editor before sending, similar to visudo, enhancing flexibility for payload adjustments.

Flexible Curl Passthrough

Any curl command-line arguments can be passed directly, enabling complex requests like custom headers or authentication, as highlighted in the 'Passing Command Line Options To Curl' section.

Cons

Dependent on Curl's Limitations

As a wrapper, resty inherits all curl's constraints, such as limited support for modern protocols like HTTP/3 or advanced features without manual configuration and external tooling.

Setup and Sourcing Overhead

Requires sourcing the script into the shell, which can be error-prone in scripts and depends on correct shell environment setup, as noted in the installation and usage sections.

No Built-in Data Processing

Output processing for HTML or JSON relies on external tools like lynx, html2text, or jq, which must be installed separately, adding dependency management overhead and complexity.

Frequently Asked Questions

Related Projects

yt-dlp

A feature-rich command-line audio/video downloader

Stars189,707

Forks16,466

Last commit8 days ago

Hoppscotch

Open-Source API Development Ecosystem • https://hoppscotch.io • Offline, On-Prem & Cloud • Web, Desktop & CLI • Open-Source Alternative to Postman, Insomnia

Stars80,240

Forks6,089

Last commit2 days ago

Bruno

Opensource IDE For Exploring and Testing API's (lightweight alternative to Postman/Insomnia)

Stars46,819

Forks2,854

Last commit20 hours ago

curl (k)

A command line tool and library for transferring data with URL syntax, supporting DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, MQTTS, POP3, POP3S, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS. libcurl offers a myriad of powerful features

Stars42,810

Forks7,349

Last commit14 hours ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub