httpie/cli
Cli
This project is a terminal-based HTTP client designed for interacting with web services, debugging APIs, and automating network requests. It provides a specialized command-line interface that simplifies the construction of complex HTTP exchanges, allowing users to test and inspect web services directly from the shell.
The tool distinguishes itself through a declarative syntax engine that translates shorthand command-line tokens into fully formed HTTP requests, including headers, parameters, and body payloads. It features a modular, plugin-based architecture that enables users to extend core functionality with custom authentication schemes, transport protocols, and data formatting logic. Furthermore, it supports persistent session management, allowing for the maintenance of cookies and authentication states across multiple related requests to simulate browser-like interactions.
Beyond its core request capabilities, the tool provides a comprehensive suite of features for handling network traffic, including automated shell scripting with error handling, remote file downloading with progress tracking, and robust proxy support. It also offers advanced configuration options for HTTPS security, response streaming for large payloads, and terminal-aware output formatting that provides syntax-highlighted, human-readable displays.
Features
- Command-Line HTTP Clients - Provides a terminal-based interface for constructing, sending, and inspecting web service requests.
- Terminal API Clients - Provides a human-readable interface for interacting with web services that features syntax-highlighted output.
- Declarative Request Builders - Translates shorthand tokens into fully formed HTTP requests including headers and payloads.
- API Testing - Provides tools for testing and inspecting web services directly from the terminal to verify request structures.
- Authentication Strategies - Supports authentication via basic, digest, or bearer schemes by providing credentials directly in the command line.
- Network Testing - Analyzes HTTP traffic through verbose logging and syntax-highlighted output for API testing.
- API Prototyping - Enables constructing and refining API calls using shorthand syntax to quickly iterate on request payloads and headers.
- Plugin Architectures - Uses a modular registration system to allow third-party code to inject custom authentication, transport, and formatting logic.
- Network Automation - Supports executing complex HTTP exchanges within shell scripts to automate data transfers and integrate with remote services.
- HTTP Request Builders - HTTPie allows specifying raw request bodies directly on the command line, useful for generating documentation examples or when piping is inconvenient.
- Request Debuggers - Displays full HTTP request and response exchanges to assist with debugging and documentation.
- Extensible Plugin Architectures - Supports third-party extensions for custom authentication, protocols, and data formatting.
- API Testing Tools - A user-friendly command-line HTTP client for API interaction.
- CLI Tools - Listed in the “CLI Tools” section of the Awesome Python awesome list.
- Command Line Tools - Listed in the “Command Line Tools” section of the The Book Of Secret Knowledge awesome list.
- Command Line Utilities - Simplifies API testing and debugging via CLI.
- CLI Tools - User-friendly HTTP client.
- JSON Request Serializers - Serializes request data as JSON by default for standard API interactions.
- Network Request Tools - Enables setting specific connection timeouts and ignoring standard input streams to prevent scripts from hanging.
- Session Management - Maintains persistent storage files to track cookies and authentication headers across multiple independent network requests.
- URL Parameter Parsers - HTTPie appends URL parameters to requests using dedicated syntax that automatically handles URL encoding and shell escaping for parameter names and values.
- Nested JSON Builders - Enables construction of complex, nested JSON structures directly from the command line.
- Plugin Managers - Supports installing third-party plugins to extend core command-line functionality.
- Automatic Redirect Handlers - Follows HTTP redirects automatically to simplify multi-step request workflows.
- Network Streaming - Handles large data payloads by processing network chunks in real-time to minimize memory usage during high-volume transfers.
- Offline Request Generators - HTTPie constructs and prints HTTP requests to the terminal without sending them over the network for dry runs or documentation generation.
- Request Payloads - HTTPie sends file contents as request bodies by referencing file paths, automatically detecting and setting appropriate content-type headers based on extensions.
- Extensible Authentication - Allows extending authentication capabilities by installing third-party plugins to support custom or proprietary security mechanisms.
- Command Line Parsers - Translates shorthand command-line tokens into structured HTTP request objects through a rule-based transformation engine.
- Command Line Utilities - HTTPie manages output behavior when redirecting to files or pipes by automatically disabling formatting and binary suppression, with options to force colorization.
- Persistent Configurations - Supports defining persistent default command-line arguments and specifying custom directories for plugin installations.
- HTTP Exchange Inspectors - Provides full visibility into the request-response chain, including redirects and authentication handshakes.
- HTTP Method Inference Engines - HTTPie determines HTTP methods automatically based on the presence of request data, defaulting to GET for requests without bodies and POST for those with data.
- Proxy Clients - HTTPie routes requests through SOCKS proxies by specifying the protocol and credentials in command-line arguments for individual HTTP or HTTPS requests.
- Request Header Configuration - Provides flexible configuration for custom request headers via arguments and file inputs.
- Response Streaming Utilities - HTTPie streams HTTP responses in real-time by disabling output buffering, allowing the client to process data chunks as they arrive from the server.
- Resumable Downloads - Enables resuming interrupted downloads by sending range requests to servers that support partial content.
- Stream Processing Utilities - HTTPie pipes data from standard input, files, or other programs into the request body, with support for streaming, chunked encoding, and compression.
- Client Certificate Authentication - Authenticates with servers using client-side SSL certificates and private keys.
- Terminal Output Formatters - Processes raw HTTP responses through a syntax-highlighting engine that adapts display logic based on terminal capabilities.
