OpenParable
Skip to content
← Back to skills

Httpie

Apps & Automation
httpie

Httpie is an Agent Skill for apps & automation published in the carapace-sh/carapace-bin repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when working with HTTPie (http/https CLI) — the command-line HTTP client for the API era. Covers request items syntax (headers, params, data fields, file uploads), authentication (basic, digest, bearer, plugins), session management, output formatting and printing, SSL/TLS configuration, download mode, configuration files, environment variables, plugin system, exit codes, scripting, and URL syntax. Triggers on: "httpie", "http command", "https command", "http --json", "http --form", "http --download", "http --session", "http --auth", "http --auth-type", "http --print", "http --verbose", "http --follow", "http --offline", "http --check-status", "http --proxy", "http --ssl", "http --cert", "http --verify", "http --format-options", "http --pretty", "http --style", "http --stream", "http --boundary", "http --multipart", "http --raw", "httpie config", "HTTPIE_CONFIG_DIR", "httpie cli plugins", "request items", "data fields", "URL parameters", "HTTP headers", "raw JSON fields", "file upload fields", "named session", "anonymous session", "read-only session", "Content-Disposition", "httpie-unixsocket", "httpie plugins", "AuthPlugin", "TransportPlugin", "ConverterPlugin", "FormatterPlugin".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/carapace-sh/carapace-bin/blob/HEAD/skills/httpie/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/httpie, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

HTTPie (http/https) In-Depth Reference

Comprehensive reference for HTTPie — a command-line HTTP client designed for the API era. Covers the full CLI surface, request items syntax, authentication, sessions, output formatting, SSL/TLS, downloads, configuration, plugins, scripting, and the carapace-bin completer.

Data Flow

http [flags] [METHOD] URL [REQUEST_ITEM ...]
  → parse flags & default_options from config.json
    → resolve URL (default scheme, localhost shortcuts, path normalization)
      → build request (method, headers, body from request items)
        → apply auth (basic/digest/bearer/plugin, .netrc, session)
          → send request (proxy, SSL/TLS, redirects, timeout)
            → receive response
              → format output (pretty, style, print options, stream)
                → stdout / file (--output) / download (--download)

Sub-Resources

Load the reference that matches your task. When in doubt, load multiple references.

KeywordsReference
invocation, command line, flags, options, --json, -j, --form, -f, --multipart, --boundary, --raw, --compress, -x, --verbose, -v, --all, --quiet, -q, --debug, --traceback, --help, --version, --offline, --ignore-stdin, -I, --timeout, --max-headers, --max-redirects, --check-status, --path-as-is, --chunked, http vs https, METHOD, GET, POST, PUT, DELETE, PATCH, HEAD, positional argumentsreferences/cli.md
request items, request item, separator, header, :, URL parameter, ==, data field, =, raw JSON, :=, file upload, @, embed file, =@, :=@, :@, ==@, escaping, backslash, --, nested JSON, key[subkey], array, escaping brackets, Content-Type, form data, JSON objectreferences/request-items.md
authentication, auth, --auth, -a, --auth-type, -A, basic, digest, bearer, token, .netrc, --ignore-netrc, password prompt, auth plugins, NTLM, OAuth, JWT, HMAC, AWS, EdgeGrid, SPNEGO, Hawkreferences/auth.md
session, --session, --session-read-only, named session, anonymous session, session file, cookie persistence, Set-Cookie, cookie domain, unbound cookie, session upgrade, sessions upgrade-all, --bind-cookies, session storage, session JSON formatreferences/sessions.md
output, --print, -p, --headers, -h, --body, -b, --meta, -m, --verbose, -v, --all, --stream, -S, --pretty, --style, -s, --sorted, --unsorted, --format-options, --response-charset, --response-mime, --output, -o, binary data, redirected output, terminal output, format options, headers.sort, json.format, json.indent, json.sort_keys, xml.format, xml.indent, Pie theme, color stylereferences/output.md
SSL, TLS, --verify, --ssl, --ciphers, --cert, --cert-key, --cert-key-pass, certificate verification, CA bundle, REQUESTS_CA_BUNDLE, protocol version, ssl2.3, tls1, tls1.1, tls1.2, tls1.3, OpenSSL cipher listreferences/ssl.md
download, --download, -d, --continue, -c, --output, -o, Content-Disposition, filename, resume, Range, 206 Partial Content, piping download, wget-like, progress barreferences/downloads.md
configuration, config file, config.json, default_options, plugins_dir, HTTPIE_CONFIG_DIR, XDG_CONFIG_HOME, legacy config, ~/.httpie, config directory resolution, --no-OPTION, unsetting options, http --debug, config_dirreferences/config.md
plugins, plugin manager, httpie cli plugins, install, list, upgrade, uninstall, AuthPlugin, TransportPlugin, ConverterPlugin, FormatterPlugin, PluginManager, entry points, httpie-unixsocket, httpie-ntlm, httpie-jwt-auth, httpie-oauth, httpie-aws-auth, httpie-edgegrid, httpie-hmac-auth, httpie-api-auth, httpie-negotiate, requests-hawk, plugin developmentreferences/plugins.md
scripting, exit codes, --check-status, shell script, automation, --ignore-stdin, --timeout, piping, stdin, redirected input, --raw, here string, piping output, best practices, cronreferences/scripting.md
URL, URL syntax, default scheme, --default-scheme, localhost shortcut, :/foo, :3000, ://, query string, ==, path normalization, path-as-is, dot segment, URL escaping, http+unixreferences/url-syntax.md

Quick Guide

Cross-Project References

  • For carapace completion integration (the http/https completers in completers/common/http_completer/ and completers/common/https_completer/), see the carapace-dev skill and the project's AGENTS.md. The completer uses shared actions from pkg/actions/net/http/ for request headers, methods, media types, and status codes.
  • For the carapace YAML spec format and spec-based completions, see the carapace skill → references/spec.md.
  • For shell quoting rules that affect how request items are passed on the command line, see the bash, zsh, or fish skills as appropriate.
  • For HTTP protocol fundamentals (status codes, headers, methods, content negotiation), consult RFC 7230/7231 or the MDN Web Docs — this skill covers HTTPie's CLI surface, not HTTP itself.