curl(1)

NAME โœจ

okay so this is the curl(1) manual page โ€” literally the curl Manual, bestie โ€” and curl is the tool for transfer a URL. ๐Ÿ’–


SYNOPSIS ๐ŸŽ€

the whole vibe is extremely simple:

curl [options / URLs]

DESCRIPTION ๐Ÿฆ‹

curl is a tool for transferring data from or to a server using URLs. It supports these protocols: DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, MQTT, MQTTS, POP3, POP3S, RTSP, SCP, SFTP, SMTP, SMTPS, TELNET, TFTP, WS and WSS. ๐ŸŒˆ

curl is powered by libcurl for all transfer-related features. See libcurl(3) for details.


URL ๐Ÿ’…

The URL syntax is protocol-dependent. You can find a detailed description in RFC 3986.

If you provide a URL without a leading protocol:// scheme, curl guesses what protocol you want. It then defaults to HTTP but assumes others based on often-used hostname prefixes. For example, for hostnames starting with "ftp.", curl assumes you want FTP. ๐Ÿ‘‘

You can specify any amount of URLs on the command line. They are fetched in a sequential manner in the specified order unless you use --parallel. You can specify command line options and URLs mixed and in any order on the command line.

curl attempts to reuse connections when doing multiple transfers, so that getting many files from the same server does not use multiple connects and setup handshakes. This improves speed. Connection reuse can only be done for URLs specified for a single command line invocation and cannot be performed between separate curl runs.

curl assumes everything provided on the command line that is not a command line option or its argument is a URL and treats it as such. fr fr.


GLOBBING ๐ŸŒธ

You can specify multiple URLs or parts of URLs by writing lists within braces or ranges within brackets. We call this "globbing". โœจ

Provide a list with three different names like this:

https://fun.example/{one,two,three}.jpg
sftp://{one,two,three}.example/README

Do sequences of alphanumeric series by using [] as in:

ftp://ftp.example.com/file[1-100].txt

With leading zeroes:

ftp://ftp.example.com/file[001-100].txt

With letters through the alphabet:

ftp://ftp.example.com/file[a-z].txt
nested sequences are not supported, bestie โ€” but you can use several ones next to each other, and that's honestly iconic.
https://example.com/archive[1996-1999]/vol[1-4]/part{a,b,c}.html

You can specify a step counter for the ranges to get every Nth number or letter:

https://example.com/file[1-100:10].txt
https://example.com/file[a-z:2].txt

When using [] or {} sequences when invoked from a command line prompt, you probably have to put the full URL within double quotes to avoid the shell from interfering with it. This also goes for other characters treated special, like for example '&', '?' and '*'. ๐Ÿซถ

The separate globbing components can be referenced in the --output option to allow pieces to be reused in the target filename.

Starting in curl 8.21.0, the separate globbing parts can be named and referenced by their names. The case sensitive alphanumeric name is set enclosed within angle brackets after the opening character. Examples:

https://fun.example/{<number>one,two,three}.jpg
ftp://ftp.example.com/file[<range>1-100].txt

Setting the same glob name twice is an error.

Switch off globbing with --globoff.


VARIABLES ๐Ÿงš

curl supports command line variables (added in 8.3.0). Set variables with --variable name=content or --variable name@file (where "file" can be stdin if set to a single dash (-)).

Variable contents can be expanded in option parameters using "{{name}}" if the option name is prefixed with "--expand-". This gets the contents of the variable "name" inserted, or a blank if the name does not exist as a variable. Insert "{{" verbatim in the string by prefixing it with a backslash, like "\{{". ๐Ÿ’œ

You can access and expand environment variables by importing them with "--variable %name". This imports the variable called "name" but exits with an error if that environment variable is not already set. To provide a default value in case it is not already set, use "--variable %name=content" or "--variable %name@content".

Example: get the USER environment variable and expand into the URL, fail if USER is not set:

--variable '%USER'
--expand-url = "https://example.com/api/{{USER}}/method"

When expanding variables, curl supports a set of functions that can make the variable contents more convenient to use. It can trim leading and trailing white space with "trim", output the contents as a JSON quoted string with "json", URL encode the string with "url", base64 encode it with "b64" and base64 decode it with "64dec". To apply functions to a variable expansion, add them colon separated to the right side of the variable. Variable content holding null bytes that are not encoded when expanded causes an error. ๐Ÿ˜ญ

Example: get the contents of a file called $HOME/.secret into a variable called "fix". Make sure that the content is trimmed and percent-encoded when sent as POST data:

--variable %HOME
--expand-variable fix@{{HOME}}/.secret
--expand-data "{{fix:trim:url}}"
https://example.com/

Command line variables and expansions were added in 8.3.0.


OUTPUT ๐ŸŽ€

If not told otherwise, curl writes the received data to stdout. It can be instructed to instead save that data into a local file, using the --output or --remote-name options. If curl is given multiple URLs to transfer on the command line, it similarly needs multiple options for where to save them.

curl does not parse or otherwise "understand" the content it gets or writes as output. It does no encoding or decoding, unless explicitly asked to with dedicated command line options. periodt.


PROTOCOLS ๐ŸŒˆ

curl supports numerous protocols, or put in URL terms: schemes. Your particular build may not support them all. ๐Ÿ‘‘

  • DICT โ€” Lets you lookup words using online dictionaries.
  • FILE โ€” Read or write local files. curl does not support accessing "file://" URL remotely, but when running on Microsoft Windows using the native UNC approach works. Only absolute paths.
  • FTP(S) โ€” curl supports the File Transfer Protocol with a lot of tweaks and levers. With or without using TLS.
  • GOPHER(S) โ€” Retrieve files.
  • HTTP(S) โ€” curl supports HTTP with numerous options and variations. It can speak HTTP version 0.9, 1.0, 1.1, 2 and 3 depending on build options and the correct command line options.
  • IMAP(S) โ€” Using the mail reading protocol, curl can download emails for you. With or without using TLS.
  • LDAP(S) โ€” curl can do directory lookups for you, with or without TLS.
  • MQTT โ€” curl supports MQTT version 3. Downloading over MQTT equals subscribing to a topic while uploading/posting equals publishing on a topic. MQTT over TLS is not supported (yet).
  • POP3(S) โ€” Downloading from a pop3 server means getting an email. With or without using TLS.
  • RTSP โ€” curl supports RTSP 1.0 downloads.
  • SCP โ€” curl supports SSH version 2 scp transfers.
  • SFTP โ€” curl supports SFTP (draft 5) done over SSH version 2.
  • SMTP(S) โ€” Uploading contents to an SMTP server means sending an email. With or without TLS.
  • TELNET โ€” Fetching a telnet URL starts an interactive session where it sends what it reads on stdin and outputs what the server sends it.
  • TFTP โ€” curl can do TFTP downloads and uploads.
  • WS(S) โ€” WebSocket done over HTTP/1. WSS implies that it works over HTTPS.

PROGRESS METER โญ

curl normally displays a progress meter during operations, indicating the amount of transferred data, transfer speeds and estimated time left, etc. The progress meter displays the transfer rate in bytes per second. The used suffixes ("k" for kilo, "M" for mega, "G" for giga, "T" for tera, "P" for peta and "E" for exa) are 1024 based. For example 1k is 1024 bytes. 1M is 1048576 bytes. Strictly speaking this makes the units kibibyte and mebibyte etc.

curl displays this data to the terminal by default, so if you invoke curl to do an operation and it is about to write data to the terminal, it disables the progress meter as otherwise it would mess up the output mixing progress meter and response data.

If you want a progress meter for HTTP POST or PUT requests, you need to redirect the response output to a file, using shell redirect (>), --output or similar.

This does not apply to FTP upload as that operation does not spit out any response data to the terminal.

If you prefer a progress bar instead of the regular meter, --progress-bar is your friend. You can also disable the progress meter completely with the --silent option. ๐Ÿ’…


VERSION ๐Ÿ’–

This man page describes curl 8.23.0. If you use a later version, chances are this man page does not fully document it. If you use an earlier version, this document tries to include version information about which specific version that introduced changes.

You can always learn which the latest curl version is by running

curl https://curl.se/info

The online version of this man page is always showing the latest incarnation: https://curl.se/docs/manpage.html

๐Ÿ’… OPTIONS ๐Ÿ’…

okay bestie so here's the whole deal with how options work in curl, and honestly it's giving "simple but with lore" โœจ

  • Options start with one or two dashes. Many of them need an extra value right next to them.
  • If the text you provide does not start with a dash, curl presumes it's a URL and treats it as one. (rude? no, just how it is ๐Ÿซถ)

The short "single-dash" form โ€” like -d โ€” can be used with or without a space between it and its value, though a space is the recommended separator. The long double-dash form, like --data, requires a space between it and its value. no cap, it will not figure it out for you ๐Ÿ’€

Short version options that don't need any extra values can be stacked immediately next to each other. Like, you can specify all the options -O, -L and -v at once as -OLv. so efficient, we love a multitasking icon ๐Ÿ‘‘

In general, all boolean options are enabled with --option and then disabled again with --no-option. Same option name, you just prefix it with no-. In this list we mostly show the --option version of them.

When --next is used, it resets the parser state and you start again with a clean option state โ€” except for the options that are global. Global options retain their values and meaning even after --next.

If the long option name ends with an equals sign ("="), the argument is the text following on its right side. (Added in 8.16.0)

The first argument that is exactly two dashes ("--") marks the end of options. Any argument after the end of options is interpreted as a URL argument, even if it starts with a dash. periodt ๐Ÿ’…

โš ๏ธ real talk: curl does little to no verification of the contents of command line arguments. Passing in "creative octets" like newlines might trigger unexpected results. so maybe don't get too creative, bestie ๐Ÿ˜ญ

The following options are global โ€” these babies keep their vibe across --next:

  • --fail-early
  • --libcurl
  • --parallel-immediate
  • --parallel-max-host
  • --parallel-max
  • --parallel
  • --progress-bar
  • --rate
  • --show-error
  • --stderr
  • --styled-output
  • --trace-ascii
  • --trace-config
  • --trace-ids
  • --trace-time
  • --trace
  • --verbose

โœจ ALL OPTIONS โœจ

  • --abstract-unix-socket <path> โ€” (HTTP) Connect to the server through an abstract Unix domain socket instead of using the network. Note: netstat shows the path of an abstract socket prefixed with "@", however the <path> argument should not have this leading character.
    • If --abstract-unix-socket is provided several times, the last set value is used.
    • Example: curl --abstract-unix-socket socketpath https://example.com
    • See also --unix-socket.
  • --alt-svc <filename> โ€” (HTTPS) Enable the alt-svc parser. If the filename points to an existing alt-svc cache file, that gets used. After a completed transfer, the cache is saved to the filename again if it has been modified.
    • Specify a "" filename (zero length) to avoid loading/saving and make curl handle the cache in memory. โœจ
    • You may want to restrict your umask to prevent other users on the same system from accessing the created file. (protect your stuff, bestie ๐Ÿซถ)
    • If this option is used several times, curl loads contents from all the files but the last one is used for saving.
    • --alt-svc can be used several times in a command line.
    • Example: curl --alt-svc svc.txt https://example.com
    • See also --resolve and --connect-to.
  • --anyauth โ€” (HTTP) Figure out the authentication method automatically, and use the most secure one the remote site claims to support. This is done by first doing a request and checking the response-headers, thus possibly inducing an extra network round-trip. This option is used instead of setting a specific authentication method, which you can do with --basic, --digest, --ntlm, and --negotiate.
    • Using --anyauth is not recommended if you do uploads from stdin, since it may require data to be sent twice and then the client must be able to rewind. If the need should arise when uploading from stdin, the upload operation fails. ๐Ÿ˜ญ
    • Used together with --user.
    • Example: curl --anyauth --user me:pwd https://example.com
    • See also --proxy-anyauth, --basic and --digest.
  • -a, --append โ€” (FTP SFTP) When used in an upload, this option makes curl append to the target file instead of overwriting it. If the remote file does not exist, it is created. Note that this flag is ignored by some SFTP servers (including OpenSSH). ๐Ÿ’€
    • Providing --append multiple times has no extra effect. Disable it again with --no-append.
    • Example: curl --upload-file local --append ftp://example.com/
    • See also --range and --continue-at.
  • --aws-sigv4 <provider1[:prvdr2[:reg[:srv]]]> โ€” (HTTP) Use AWS V4 signature authentication in the transfer.
    • The provider argument is a string that is used by the algorithm when creating outgoing authentication headers.
    • The region argument is a string that points to a geographic area of a resources collection (region-code) when the region name is omitted from the endpoint.
    • The service argument is a string that points to a function provided by a cloud (service-code) when the service name is omitted from the endpoint.
    • If --aws-sigv4 is provided several times, the last set value is used.
    • Example: curl --aws-sigv4 "aws:amz:us-east-2:es" --user "key:secret" https://example.com
    • Added in 7.75.0. See also --basic and --user.
  • --basic โ€” (HTTP) Use HTTP Basic authentication with the remote host. This method is the default and this option is usually pointless, unless you use it to override a previously set option that sets a different authentication method (such as --ntlm, --digest, or --negotiate). lowkey just a vibe reset button ๐ŸŒธ
    • Used together with --user.
    • Providing --basic multiple times has no extra effect. Disable it again with --no-basic.
    • Example: curl -u name:password --basic https://example.com
    • See also --proxy-basic.
  • --ca-native โ€” (TLS) Use the operating system's native CA store for certificate verification.
    • This option is independent of other CA certificate locations set at run time or build time. Those locations are searched in addition to the native CA store.
    • This option works with OpenSSL and its forks (BoringSSL, LibreSSL, etc) on Windows (Added in 7.71.0) and on Apple OS when libcurl is built with Apple SecTrust enabled. (Added in 8.17.0)
    • This option works with wolfSSL on Windows, Linux (Debian, Ubuntu, Gentoo, Fedora, RHEL), macOS, Android and iOS. (Added in 8.3.0) ๐Ÿ‘‘
    • This option works with GnuTLS (Added in 8.5.0) and also uses Apple SecTrust when libcurl is built with it. (Added in 8.17.0)
    • This option works with Rustls on Windows, macOS, Android and iOS. On Linux it is equivalent to using the Mozilla CA certificate bundle. When used with Rustls only the native CA store is consulted, not other locations set at run time or build time. (Added in 8.13.0)
    • This option currently has no effect for Schannel. This is the native TLS library from Microsoft, that by default uses the native CA store for verification unless overridden by a CA certificate location setting.
    • Providing --ca-native multiple times has no extra effect. Disable it again with --no-ca-native.
    • Example: curl --ca-native https://example.com
    • Added in 8.2.0. See also --cacert, --capath, --dump-ca-embed, --insecure and --proxy-ca-native.
  • --cacert <file> โ€” (TLS) Use the specified certificate file to verify the peer. The file may contain multiple CA certificates. The certificate(s) must be in PEM format. Normally curl is built to use a default file for this, so this option is typically used to alter that default file.
    • curl recognizes the environment variable named 'CURL_CA_BUNDLE' if it is set and the TLS backend is not Schannel, and uses the given path as a path to a CA cert bundle. This option overrides that variable.
    • (Windows) curl automatically looks for a CA certs file named 'curl-ca-bundle.crt', either in the same directory as curl.exe, or in the Current Working Directory, or in any folder along your PATH.
    • curl 8.11.0 added a build-time option to disable this search behavior, and another option to restrict search to the application's directory.
    • (Schannel) This option is supported for Schannel in Windows 7 or later (added in 7.60.0). This option is supported for backward compatibility with other SSL engines; instead it is recommended to use Windows' store of root certificates (the default for Schannel).
    • If --cacert is provided several times, the last set value is used.
    • Example: curl --cacert CA-file.txt https://example.com
    • See also --capath, --dump-ca-embed and --insecure.
  • --capath <dir> โ€” (TLS) Use the specified certificate directory to verify the peer. If curl is built against OpenSSL, multiple paths can be provided by separating them with the appropriate platform-specific separator (e.g. "path1:path2:path3" on Unix-style platforms for "path1;path2;path3" on Windows).
    • The certificates must be in PEM format, and if curl is built against OpenSSL, the directory must have been processed using the c_rehash utility supplied with OpenSSL. Using --capath can allow OpenSSL-powered curl to make SSL-connections much more efficiently than using --cacert if the --cacert file contains many CA certificates. efficiency slay โšก
    • If this option is set, the default capath value is ignored.
    • If --capath is provided several times, the last set value is used.
    • Example: curl --capath /local/directory https://example.com
    • See also --cacert, --dump-ca-embed and --insecure.
  • -E, --cert <certificate[:password]> โ€” (TLS) Use the specified client certificate file when getting a file with HTTPS, FTPS or another SSL-based protocol. The certificate must be PEM format. If the optional password is not specified, it is queried for on the terminal. Note that this option assumes a certificate file that is the private key and the client certificate concatenated. See --cert and --key to specify them independently. ๐Ÿ”

In the <certificate> part of the argument, bestie, you have to escape the : character as \: so curl doesn't think it's the password delimiter. Same energy with the double quote โ€” write it as \" so it doesn't get mistaken for an escape character. ๐Ÿ’…

If curl is built against OpenSSL and the engine pkcs11 or pkcs11 provider is available, then a PKCS#11 URI (RFC 7512) can be used to specify a certificate living on a PKCS#11 device. Any string starting with pkcs11: gets read as a PKCS#11 URI. And if you do hand over a PKCS#11 URI, then --engine gets set to pkcs11 if none was provided, and --cert-type gets set to ENG or PROV if none was provided (depends on your OpenSSL version, iykyk).

If curl is built against GnuTLS, a PKCS#11 URI can be used to point at a certificate on a PKCS#11 device. String starts with pkcs11: โ†’ it's a PKCS#11 URI. Simple as that. โœจ

(Schannel girlies listen up ๐Ÿ‘‘) Client certificates must be specified by a path expression to a certificate store. Loading PFX is not supported (you can import it to a store first, no biggie). You can use <store location>\<store name>\<thumbprint> to refer to a certificate in the system certificates store, like for example CurrentUser\MY\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a. Thumbprint is usually a SHA-1 hex string which you can see in certificate details. These store locations are supported: CurrentUser, LocalMachine, CurrentService, Services, CurrentUserGroupPolicy, LocalMachineGroupPolicy and LocalMachineEnterprise. Slay.

If --cert is provided several times, the last set value is used. (Last one wins, always. ๐Ÿ™ˆ)

Example:

curl --cert certfile --key keyfile https://example.com

See also --cert-type, --key and --key-type.

  • --cert-status โ€” (TLS) Verify the status of the server certificate by using the Certificate Status Request (aka. OCSP stapling) TLS extension. ๐Ÿ’–

If this option is enabled and the server sends an invalid (e.g. expired) response, if the response suggests that the server certificate has been revoked, or no response at all is received, the verification fails. Like, it's over at that point. ๐Ÿ˜ญ

This support is currently only implemented in the OpenSSL and GnuTLS backends.

Providing --cert-status multiple times has no extra effect. Disable it again with --no-cert-status.

Example:

curl --cert-status https://example.com

See also --pinnedpubkey.

  • --cert-type <type> โ€” (TLS) Set type of the provided client certificate. PEM, DER, ENG, PROV and P12 are recognized types. ๐ŸŽ€

The default type depends on the TLS backend and is usually PEM. For Schannel it is P12. If --cert is a pkcs11: URI then ENG or PROV is the default type (depending on OpenSSL version).

If --cert-type is provided several times, the last set value is used.

Example:

curl --cert-type PEM --cert file https://example.com

See also --cert, --key and --key-type.

  • --ciphers <list> โ€” (TLS) Specify which cipher suites to use in the connection if it negotiates TLS 1.2 (1.1, 1.0). The list of ciphers suites must specify valid ciphers. Read up on cipher suite details on this URL:
https://curl.se/docs/ssl-ciphers.html

If --ciphers is provided several times, the last set value is used.

Example:

curl --ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256 https://example.com

See also --tls13-ciphers, --proxy-ciphers and --curves.

  • --compressed โ€” (HTTP) Request a compressed response using one of the algorithms curl supports, and automatically decompress the content. ๐Ÿซถ

Response headers are not modified when saved, so if they are "interpreted" separately again at a later point they might appear to be saying that the content is (still) compressed; while in fact it has already been decompressed. Awkward, but that's the vibe.

If this option is used and the server sends an unsupported encoding, curl reports an error. This is a request, not an order; the server may or may not deliver data compressed. (You asked nicely. That's all you can do. ๐Ÿ˜Œ)

WARNING: when decompressing data, even tiny transfers might be expanded and generate a huge amount of bytes. You might want to limit using this option to only known and trusted sites using secure protocols, perhaps in combination with --max-filesize. Lowkey important โ€” a zip bomb is not the serve you think it is. ๐Ÿ’€

Providing --compressed multiple times has no extra effect. Disable it again with --no-compressed.

Example:

curl --compressed https://example.com

See also --compressed-ssh.

  • --compressed-ssh โ€” (SCP SFTP) Enable SSH compression. This is a request, not an order; the server may or may not do it. This allows the data to be sent compressed over the wire, and automatically decompressed in the receiving end, to save bandwidth. Saving bandwidth is so main character of you. โœจ

Providing --compressed-ssh multiple times has no extra effect. Disable it again with --no-compressed-ssh.

Example:

curl --compressed-ssh sftp://example.com/

See also --compressed.

  • -K, --config <file> โ€” Specify a text file to read curl arguments from. The command line arguments found in the text file are used as if they were provided on the command line. It's giving "copy paste but for options". ๐Ÿ“‹

Options and their parameters must be specified on the same line in the file, separated by whitespace, colon, or the equals sign. Long option names can optionally be given in the config file without the initial double dashes and if so, the colon or equals characters can be used as separators. If the option is specified with one or two dashes, there can be no colon or equals character between the option and its parameter.

If the parameter contains whitespace or starts with a colon (:) or equals sign (=), it must be specified enclosed within double quotes ("like this"). Within double quotes the following escape sequences are available: \\, \", \t, \n, \r and \v. A backslash preceding any other letter is ignored.

If the first non-blank column of a config line is a # character, that line is treated as a comment. ๐ŸŽ€

Only write one option per physical line in the config file. A single line is required to be no more than 10 megabytes (since 8.2.0).

Specify the filename to --config as minus - to make curl read the file from stdin.

Note that to be able to specify a URL in the config file, you need to specify it using the --url option, and not by writing the URL on its own line. It could look similar to this:

url = "https://curl.se/docs/"
# --- Example file ---
# this is a comment
url = "example.com"
output = "curlhere.html"
user-agent = "superagent/1.0"

# and fetch another URL too
url = "example.com/docs/manpage.html"
-O
referer = "http://nowhereatall.example.com/"
# --- End of example file ---

When curl is invoked, it (unless --disable is used) checks for a default config file and uses it if found, even when --config is used. The default config file is checked for in the following places in this order:

  1. "$CURL_HOME/.curlrc"
  2. "$XDG_CONFIG_HOME/curlrc" (Added in 7.73.0)
  3. "$HOME/.curlrc"
  4. Windows: "%USERPROFILE%\.curlrc"
  5. Windows: "%APPDATA%\.curlrc"
  6. Windows: "%USERPROFILE%\Application Data\.curlrc"
  7. Non-Windows: use getpwuid to find the home directory
  8. On Windows, if it finds no .curlrc file in the sequence described above, it checks for one in the same directory the curl executable is placed.

On Windows two filenames are checked per location: .curlrc and _curlrc, preferring the former. Older versions on Windows checked for _curlrc only.

--config can be used several times in a command line.

Example:

curl --config file.txt https://example.com

See also --disable.

  • --connect-timeout <seconds> โ€” Maximum time in seconds that you allow curl's connection to take. This only limits the connection phase, so if curl connects within the given period it continues โ€” if not it exits. โฐ No cap, it's a hard deadline.

This option accepts decimal values. The decimal value needs to be provided using a dot (.) as decimal separator โ€” not the local version even if it might be using another separator. (Yes, even if your locale is doing the most. Use the dot. ๐Ÿ’…)

The connection phase is considered complete when the DNS lookup and requested TCP, TLS or QUIC handshakes are done.

If --connect-timeout is provided several times, the last set value is used.

Examples:

curl --connect-timeout 20 https://example.com
curl --connect-timeout 3.14 https://example.com

See also --max-time.

  • --connect-to <HOST1:PORT1:HOST2:PORT2> โ€” For a request intended for the "HOST1:PORT1" pair, connect to "HOST2:PORT2" instead. This option is only used to establish the network connection. It does NOT affect the hostname/port number that is used for TLS/SSL (e.g. SNI, certificate verification) or for the application protocols. Like, you're rerouting the car but the destination on the paperwork stays the same. ๐Ÿš—

"HOST1" and "PORT1" may be empty strings, meaning any host or any port number. "HOST2" and "PORT2" may also be empty strings, meaning use the request's original hostname and port number.

A hostname specified to this option is compared as a string, so it needs to match the name used in the request URL. It can be either numerical such as "127.0.0.1" or the full hostname such as "example.org".

Example: redirect connects from the example.com hostname to 127.0.0.1 independently of port number:

curl --connect-to example.com::127.0.0.1: https://example.com/

Example: redirect connects from all hostnames to 127.0.0.1 independently of port number:

curl --connect-to ::127.0.0.1: http://example.com/

--connect-to can be used several times in a command line.

Example:

curl --connect-to example.com:443:example.net:8443 https://example.com

See also --resolve and --header.

-C, --continue-at <offset>

okay so bestie, this one picks up a transfer right where it left off โœจ You give it a byte offset, and that offset is literally the exact number of bytes curl skips, counting from the top of the source file before anything gets moved to the destination. No vibes-based guessing, just math ๐Ÿ’…

One lil caveat for uploads: if you use this with uploads, the FTP server command SIZE is not used by curl. Noted, moving on ๐Ÿซถ

Now the iconic part: write -C - and curl will automatically figure out where/how to resume the transfer all on its own. It uses the given output/input files to work that out. main character energy fr fr ๐Ÿ‘‘

Heads up: HTTP uploads using POST or PUT cannot be resumed. curl returns an error if you combine this option with such an upload ๐Ÿ˜ญ
  • This command line option is mutually exclusive with --range โ€” you can only use one of them for a single transfer.
  • The --no-clobber and --remove-on-error options cannot be used together with --continue-at.
  • If --continue-at is provided several times, the last set value is used.

Examples, because we love a demo:

curl -C - https://example.com
curl -C 400 https://example.com

See also --range.


(HTTP) bestie this option is lowkey doing two jobs ๐Ÿ’… It has two slightly separate cookie sending functions, and which one you get depends on what you hand it.

Option one โ€” you pass the actual data: curl sends exactly that data to the HTTP server in the Cookie header. It is supposedly data you previously got from the server in a Set-Cookie: line. Format it like "NAME1=VALUE1; NAME2=VALUE2". When you give a set of specific cookies like this, curl populates its cookie header with this content explicitly in all outgoing request(s). And if multiple requests happen because of authentication, followed redirects or similar โ€” every single one of them gets this cookie header passed on ๐ŸŒธ

Option two โ€” no = symbol in the argument: then it's treated as a filename to read previously stored cookies from. This option also activates the cookie engine, which makes curl record incoming cookies โ€” super handy if you're using it together with the --location option or doing multiple URL transfers on the same invoke ๐Ÿ“

  • If the filename is a single minus (-), curl reads the contents from stdin.
  • If the filename is an empty string ("") and is the only cookie input, curl activates the cookie engine without any cookies.

About that file ๐Ÿ” The file format of the file to read cookies from should be plain HTTP headers (Set-Cookie style) or the Netscape/Mozilla cookie file format. We discourage the use of the HTTP header style. (ngl, respect the classic but don't do it.)

Reminder: the file specified with --cookie is only used as input. No cookies are written to that file. To store cookies, use the --cookie-jar option ๐Ÿ’–

Another thing โ€” if you read cookies from a plain HTTP headers file, make sure each Set-Cookie line specifies a Domain attribute. Without an explicit domain, the cookie cannot be reliably matched to a target host and may be applied in unexpected ways ๐Ÿ˜ญ We suggest using the Netscape file format instead. Learn from our chaos.

Users often want to both read cookies from a file and write updated cookies back to a file, so using both --cookie and --cookie-jar in the same command line is common. curl ignores filenames specified with --cookie which do not exist or point to a directory.

If curl is built with PSL (Public Suffix List) support, it detects and discards cookies that are specified for such suffix domains that should not be allowed to have cookies. If curl is not built with PSL support, it has no ability to stop super cookies ๐Ÿ’€ yikes but true.

--cookie can be used several times in a command line.

Examples:

curl -b "" https://example.com
curl -b cookiefile https://example.com
curl -b cookiefile -c cookiefile https://example.com
curl -b name=Jane https://example.com

See also --cookie-jar and --junk-session-cookies.


(HTTP) this is the output half of the cookie story, bestie ๐ŸŽ€ You specify which file you want curl to write all cookies to after a completed operation. curl writes all cookies from its in-memory cookie storage to the given file at the end of operations. And even if no cookies are known, a file is created โ€” so it removes any formerly existing cookies from the file ๐Ÿงน The file uses the Netscape cookie file format. If you set the filename to a single minus, -, the cookies are written to stdout โœจ

Nope, the file specified with --cookie-jar is only used for output. No cookies are read from the file. To read cookies, use the --cookie option. Both options can specify the same file though ๐Ÿ‘€

This command line option activates the cookie engine that makes curl record and use cookies. The --cookie option also activates it.

And now the scary part ๐Ÿ˜ญ If the cookie jar cannot be created or written to, the whole curl operation does not fail or even report an error clearly. Using --verbose gets a warning displayed, but that is the only visible feedback you get about this possibly lethal situation. Like, the silence is the warning. terrifying.

You may want to restrict your umask to prevent other users on the same system to access the created file ๐Ÿ’…

If --cookie-jar is provided several times, the last set value is used.

Examples:

curl -c store-here.txt https://example.com
curl -c store-here.txt -b read-these https://example.com

See also --cookie and --junk-session-cookies.


--create-dirs

When used in conjunction with the --output option, curl creates the necessary local directory hierarchy as needed ๐Ÿ—๏ธ It creates the directories mentioned with the --output option combined with the path possibly set with --output-dir. If the combined output filename uses no directory, or if the directories it mentions already exist, no directories are created. Respect the lazy genius of it.

Created directories are made with mode 0750 on Unix-style file systems ๐Ÿ”

  • To create remote directories when using FTP or SFTP, try --ftp-create-dirs.
  • Providing --create-dirs multiple times has no extra effect. Disable it again with --no-create-dirs.

Example:

curl --create-dirs --output local/dir/file https://example.com

See also --ftp-create-dirs and --output-dir.


--create-file-mode <mode>

(SFTP SCP FILE) so when curl is used to create files remotely using one of the supported protocols, this option lets you set which 'mode' to set on the file at creation time, instead of the default 0644 ๐ŸŒˆ Very "I choose my own permissions" of you.

This option takes an octal number as argument ๐Ÿ”ข

If --create-file-mode is provided several times, the last set value is used.

Example:

curl --create-file-mode 0777 -T localfile sftp://example.com/new

Added in 7.75.0. See also --ftp-create-dirs.


--crlf

(FTP SMTP) Convert line feeds to carriage return plus line feeds in upload ๐Ÿ’ซ Useful for MVS (OS/390). That's it, that's the whole vibe. Vintage but iconic.

  • Providing --crlf multiple times has no extra effect. Disable it again with --no-crlf.

Example:

curl --crlf -T file ftp://example.com/

See also --use-ascii.


--crlfile <file>

(TLS) Provide a file using PEM format with a Certificate Revocation List that may specify peer certificates that are to be considered revoked ๐Ÿšซ๐ŸŽ€ Like a block list but make it certificate authority.

If --crlfile is provided several times, the last set value is used.

Example:

curl --crlfile rejects.txt https://example.com

See also --cacert and --capath.


--curves <list>

(TLS) Set specific curves to use during SSL session establishment according to RFC 8422, 5.1 ๐ŸŒธ Multiple algorithms can be provided by separating them with : (e.g. "X25519:P-521"). The parameter is available identically in the OpenSSL s_client and s_server utilities. Look at us, speaking OpenSSL fluently ๐Ÿ’…

--curves allows a OpenSSL powered curl to make SSL-connections with exactly the (EC) curve requested by the client, avoiding nontransparent client/server negotiations. No sneaky side convos, we said what we said โœจ

If this option is set, the default curves list built into OpenSSL are ignored ๐Ÿ‘€

If --curves is provided several times, the last set value is used.

Example:

curl --curves X25519 https://example.com

Added in 7.73.0. See also --ciphers.


-d, --data <data>

(HTTP MQTT) Send the specified data to a server ๐Ÿš€ the classic, the blueprint, the moment.

  • For HTTP(S), this is done with the POST method in the same way that a browser does when a user has filled in an HTML form and presses the submit button. This option makes curl pass the data to the server using the content-type application/x-www-form-urlencoded.
  • For MQTT, the data is sent as a PUBLISH.

okay so a few siblings you should know about ๐Ÿซถ --data-raw is almost the same but does not have a special interpretation of the @ character. To post data purely binary, you should instead use the --data-binary option. To URL-encode the value of a form field you may use --data-urlencode.

If any of these options is used more than once on the same command line, the data pieces specified are merged with a separating &-symbol. So using -d name=daniel -d skill=lousy would generate a post chunk that looks like name=daniel&skill=lousy โ€” look at them, holding hands ๐Ÿฅฐ

If you start the data with the letter @, the rest should be a filename to read the data from, or - if you want curl to read the data from stdin. Posting data from a file named foobar would thus be done with --data @foobar. When --data is told to read from a file like that, carriage returns, newlines and null bytes are stripped out ๐Ÿงฝ If you do not want the @ character to have a special interpretation use --data-raw instead.

Real talk: the data for this option is passed on to the server exactly as provided on the command line. curl does not convert, change or improve it. It is up to you to provide the data in the correct form ๐Ÿ˜ญ no glow-ups happening here, you're on your own bestie.

--data can be used several times in a command line.

Examples:

curl -d "name=curl" https://example.com
curl -d "name=curl" -d "tool=cmdline" https://example.com
curl -d @filename https://example.com

This option is mutually exclusive with --form, --head and --upload-file. See also --data-binary, --data-urlencode, --data-raw and --form.


--data-ascii <data>

(HTTP) This option is an alias for --data. That's it, that's the whole entry ๐Ÿ’– short and slay.

--data-ascii can be used several times in a command line โ€” stack 'em up, bestie ๐Ÿ’…

Example:

curl --data-ascii @file https://example.com

See also --data-binary, --data-raw and --data-urlencode ๐Ÿซถ


  • --data-binary <data> โ€” (HTTP) Posts data exactly as you typed it, zero extra processing, no notes, no edits, no nothing. It's giving "raw and unfiltered" โœจ

If you start the data with the letter @, everything after it should be a filename. And "@-" makes curl read the data from stdin ๐Ÿ‘€. Data gets posted in a similar manner as --data does, except that newlines and carriage returns are preserved and conversions are never done โ€” so your precious formatting survives, periodt.

Like --data, the default content-type sent to the server is application/x-www-form-urlencoded. But if you want the server to treat the data as arbitrary binary data, then set the content-type to octet-stream:

-H "Content-Type: application/octet-stream"

If this option is used several times, the ones following the first append data as described in --data ๐ŸŒธ

--data-binary can be used several times in a command line.

Example:

curl --data-binary @filename https://example.com

See also --data-ascii.


  • --data-raw <data> โ€” (HTTP) Posts data similarly to --data but without the special interpretation of the @ character. So an @ is just an @, bestie, no sneaky file reading ๐ŸŽ€

--data-raw can be used several times in a command line.

Examples:

curl --data-raw "hello" https://example.com
curl --data-raw "@at@at@" https://example.com

See also --data.


  • --data-urlencode <data> โ€” (HTTP) Posts data, similar to the other --data options, with one exception: this one performs URL-encoding ๐Ÿ”ฅ

To be CGI-compliant, the <data> part should begin with a name followed by a separator and a content specification. You can pass the <data> part to curl using one of these syntaxes:

  • content โ€” URL-encodes the content and passes that on. Be careful so that the content does not contain any = or @ symbols, because that makes the syntax match one of the other cases below. Trust me, that plot twist is not the vibe ๐Ÿ’€
  • =content โ€” URL-encodes the content and passes that on. The preceding = symbol is not included in the data.
  • name=content โ€” URL-encodes the content part and passes that on. Note that the name part is expected to be URL-encoded already ๐Ÿฆ‹
  • @filename โ€” loads data from the given file (including any newlines), URL-encodes that data and passes it on in the POST. Using "@-" makes curl read the data from stdin.
  • name@filename โ€” loads data from the given file (including any newlines), URL-encodes that data and passes it on in the POST. The name part gets an equal sign appended, resulting in name=urlencoded-file-content. Note that the name is expected to be URL-encoded already โœจ

--data-urlencode can be used several times in a command line.

Examples:

curl --data-urlencode name=val https://example.com
curl --data-urlencode =encodethis https://example.com
curl --data-urlencode name@file https://example.com
curl --data-urlencode @fileonly https://example.com

See also --data and --data-raw.


  • --delegation <LEVEL> โ€” (GSS/kerberos) Sets the LEVEL of what curl is allowed to delegate when it comes to user credentials. Very "who's allowed to speak on my behalf" energy ๐Ÿ‘‘
    • none โ€” Do not allow any delegation. Absolutely not. Blocked ๐Ÿšซ
    • policy โ€” Delegates if and only if the OK-AS-DELEGATE flag is set in the Kerberos service ticket, which is a matter of realm policy.
    • always โ€” Unconditionally allows the server to delegate. All in, no questions ๐Ÿ’œ

If --delegation is provided several times, the last set value is used.

Example:

curl --delegation "none" https://example.com

See also --insecure and --ssl.


  • --digest โ€” (HTTP) Enables HTTP Digest authentication ๐Ÿ”. This auth scheme avoids sending the password over the wire in clear text โ€” so your password isn't out here doing a public speech, iykyk. Use this in combination with the normal --user option to set username and password.

Providing --digest multiple times has no extra effect. Disable it again with --no-digest.

Example:

curl -u name:password --digest https://example.com

See also --user, --proxy-digest and --anyauth.


  • -q, --disable โ€” If used as the first parameter on the command line, the curlrc config file is not read or used. Sneaky how it only works first, right? ๐Ÿ™ˆ See --config for details on the default config file search path.

Providing --disable multiple times has no extra effect. Disable it again with --no-disable.

Example:

curl -q https://example.com

See also --config.


  • --disable-eprt โ€” (FTP) Disables the use of the EPRT and LPRT commands when doing active FTP transfers. curl normally first attempts to use EPRT before using PORT, but with this option it uses PORT right away. EPRT is an extension to the original FTP protocol, and does not work on all servers โ€” but it enables more functionality in a better way than the traditional PORT command ๐ŸŒˆ

--eprt can be used to explicitly enable EPRT again, and --no-eprt is an alias for --disable-eprt.

If the server is accessed using IPv6, this option has no effect since EPRT is necessary then. Sorry bestie, IPv6 said no ๐Ÿ’€

Disabling EPRT only changes the active behavior. If you want to switch to passive mode you need to not use --ftp-port or force it with --ftp-pasv.

Providing --disable-eprt multiple times has no extra effect. Disable it again with --no-disable-eprt.

Example:

curl --disable-eprt ftp://example.com/

See also --disable-epsv and --ftp-port.


  • --disable-epsv โ€” (FTP) Disables the use of the EPSV command when doing passive FTP transfers. curl normally first attempts to use EPSV before PASV, but with this option it does not try EPSV at all ๐Ÿฆ‹

--epsv can be used to explicitly enable EPSV again, and --no-epsv is an alias for --disable-epsv.

If the server is an IPv6 host, this option has no effect since EPSV is necessary then. Same deal as its sibling, no cap.

Disabling EPSV only changes the passive behavior. If you want to switch to active mode you need to use --ftp-port.

Providing --disable-epsv multiple times has no extra effect. Disable it again with --no-disable-epsv.

Example:

curl --disable-epsv ftp://example.com/

See also --disable-eprt and --ftp-port.


  • --disallow-username-in-url โ€” Exits with error if it's passed a URL containing a username ๐Ÿ˜ค. Probably most useful when the URL is being provided at runtime or similar.

Accepting and using credentials in a URL is normally considered a security hazard as they are easily leaked that way. So yeah, this is the "no secrets in the group chat" option ๐Ÿ”ฅ

Providing --disallow-username-in-url multiple times has no extra effect. Disable it again with --no-disallow-username-in-url.

Example:

curl --disallow-username-in-url https://example.com

See also --proto.


  • --dns-interface <interface> โ€” (DNS) Sends outgoing DNS requests through the given interface. This option is a counterpart to --interface (which does not affect DNS). The supplied string must be an interface name, not an address ๐Ÿ’…

If --dns-interface is provided several times, the last set value is used.

Example:

curl --dns-interface eth0 https://example.com

For --dns-interface to work, it requires that the underlying libcurl is built to support c-ares. See also --dns-ipv4-addr and --dns-ipv6-addr.


  • --dns-ipv4-addr <address> โ€” (DNS) Binds to a specific IP address when making IPv4 DNS requests, so that the DNS requests originate from this address. The argument should be a single IPv4 address ๐ŸŽ€

If --dns-ipv4-addr is provided several times, the last set value is used.

Example:

curl --dns-ipv4-addr 10.1.2.3 https://example.com

For --dns-ipv4-addr to work, it requires that the underlying libcurl is built to support c-ares. See also --dns-interface and --dns-ipv6-addr.


  • --dns-ipv6-addr <address> โ€” (DNS) Binds to a specific IP address when making IPv6 DNS requests, so that the DNS requests originate from this address. The argument should be a single IPv6 address ๐ŸŒธ

If --dns-ipv6-addr is provided several times, the last set value is used.

Example:

curl --dns-ipv6-addr 2a04:4e42::561 https://example.com

For --dns-ipv6-addr to work, it requires that the underlying libcurl is built to support c-ares. See also --dns-interface and --dns-ipv4-addr.


  • --dns-servers <addresses> โ€” (DNS) Sets the list of DNS servers to be used instead of the system default. The list of IP addresses should be separated with commas. Port numbers may also optionally be given, appended to the IP address separated with a colon ๐Ÿ‘‘

If --dns-servers is provided several times, the last set value is used.

Examples:

curl --dns-servers 192.168.0.1,192.168.0.2 https://example.com
curl --dns-servers 10.0.0.1:53 https://example.com

For --dns-servers to work, it requires that the underlying libcurl is built to support c-ares. See also --dns-interface and --dns-ipv4-addr.


  • --doh-cert-status โ€” (DNS) Same as --cert-status but used for DoH (DNS-over-HTTPS) ๐Ÿ”

Verifies the status of the DoH servers' certificate by using the Certificate Status Request (aka. OCSP stapling) TLS extension.

If this option is enabled and the DoH server sends an invalid (e.g. expired) response, if the response suggests that the server certificate has been revoked, or no response at all is received, the verification fails ๐Ÿ’€

This support is currently only implemented in the OpenSSL and GnuTLS backends.

Providing --doh-cert-status multiple times has no extra effect. Disable it again with --no-doh-cert-status.

Example:

curl --doh-cert-status --doh-url https://doh.example https://example.com

Added in 7.76.0. See also --doh-insecure ๐Ÿฆ‹

  • --doh-insecure โ€” okay so, by default every connection curl makes to a DoH server gets verified as secure before the transfer even happens. This flag tells curl to skip that whole verification step and just go. ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ
    • WARNING: using this option makes the DoH transfer and name resolution insecure. Not a vibe for production, bestie. ๐Ÿ’€
    • It's the DoH-only twin of --insecure and --proxy-insecure โ€” same energy, but strictly for DoH (DNS-over-HTTPS).
    • Providing --doh-insecure multiple times has no extra effect. Disable it again with --no-doh-insecure.
    • Example:
curl --doh-insecure --doh-url https://doh.example https://example.com
  • Added in 7.76.0. See also --doh-url, --insecure and --proxy-insecure.
  • --doh-url <URL> โ€” (DNS) tells curl which DNS-over-HTTPS (DoH) server to use for resolving hostnames instead of the default name resolver mechanism. The URL must be HTTPS, no exceptions. ๐Ÿ”
    • Some SSL options you set for your transfer also apply to DoH, since the name lookups happen over SSL. But the certificate verification settings are not inherited โ€” those are controlled separately via --doh-insecure and --doh-cert-status. ๐ŸŽ€
    • By default, DoH is bypassed when initially looking up DNS records of the DoH server itself. You can specify the IP address(es) of the DoH server with --resolve to avoid this. iykyk ๐Ÿ’…
    • This option is unset if an empty string "" is used as the URL. (Added in 7.85.0)
    • If --doh-url is provided several times, the last set value is used.
    • Examples:
curl --doh-url https://doh.example https://example.com
curl --doh-url https://doh.example --resolve doh.example:443:192.0.2.1 https://example.com
  • See also --doh-insecure.

  • --dump-ca-embed โ€” (TLS) writes the CA bundle that's embedded in curl to standard output, then quits. Literally just dumps the tea and dips. ๐Ÿซ–โœจ
    • If curl was not built with a default CA bundle embedded, the output is empty. No bundle, no bytes, no drama.
    • Providing --dump-ca-embed multiple times has no extra effect. Disable it again with --no-dump-ca-embed.
    • Example:
curl --dump-ca-embed
  • Added in 8.10.0. See also --ca-native, --cacert, --capath, --proxy-ca-native, --proxy-cacert and --proxy-capath.
  • -D, --dump-header <filename> โ€” (HTTP FTP) writes the received protocol headers to the specified file. If no headers are received, using this option creates an empty file โ€” yes, an actual empty file, that's not a bug it's a feature. ๐Ÿ—‚๏ธ
    • Specify - as filename (a single minus) to have it written to stdout.
    • Starting in curl 8.10.0, specify % (a single percent sign) as filename and the output goes to stderr. fancy โœจ
    • When used in FTP, the FTP server response lines are considered being "headers" and thus are saved there.
    • Starting in curl 8.11.0, using the --create-dirs option can also create missing directory components for the path provided in --dump-header.
    • Having multiple transfers in one set of operations (i.e. the URLs in one --next clause) appends them to the same file, separated by a blank line.
    • If --dump-header is provided several times, the last set value is used.
    • Examples:
curl --dump-header store.txt https://example.com
curl --dump-header - https://example.com -o save
  • See also --output.
  • --ech <config> โ€” (HTTPS) specifies how to do ECH (Encrypted Client Hello). Super main character TLS behavior, ngl. ๐Ÿ‘‘
    • The values allowed for <config> can be:
      • false โ€” do not attempt ECH. This is the default.
      • grease โ€” send a GREASE ECH extension.
      • true โ€” attempt ECH if possible, but do not fail if ECH is not attempted. (The connection fails if ECH is attempted but fails.)
      • hard โ€” attempt ECH and fail if that is not possible. ECH only works with TLS 1.3 and also requires using DoH or providing an ECHConfigList on the command line.
      • ecl:<b64val> โ€” a base64 encoded ECHConfigList that is used for ECH.
      • pn:<name> โ€” a name to use to over-ride the "public_name" field of an ECHConfigList (only available with OpenSSL TLS support).
    • Most ECH related errors cause error CURLE_ECH_REQUIRED (101). ๐Ÿ˜ญ
    • If --ech is provided several times, the last set value is used.
    • Example:
curl --ech true https://example.com
  • Added in 8.8.0. See also --doh-url.
  • --egd-file <file> โ€” (TLS) deprecated option (added in 7.84.0). Prior to that it only had an effect on curl if built to use old versions of OpenSSL. It's giving legacy, bestie โ€” it's still documented but it's not the moment anymore. ๐Ÿ’€
    • Specify the path name to the Entropy Gathering Daemon socket. The socket is used to seed the random engine for SSL connections.
    • If --egd-file is provided several times, the last set value is used.
    • Example:
curl --egd-file /random/here https://example.com
  • See also --random-file.
  • --engine <name> โ€” (TLS) selects the OpenSSL crypto engine to use for cipher operations. Use --engine list to print a list of build-time supported engines. ๐Ÿ’…
    • Note that not all (and possibly none) of the engines may be available at runtime. So likeโ€ฆ check before you commit, fr fr.
    • The OpenSSL concept "engines" has been superseded by "providers" in OpenSSL 3, and this option should work fine to specify such as well.
    • If --engine is provided several times, the last set value is used.
    • Example:
curl --engine flavor https://example.com
  • See also --ciphers and --curves.
  • --etag-compare <file> โ€” (HTTP) makes a conditional HTTP request for the specific ETag read from the given file, by sending a custom If-None-Match header using the stored ETag. caching queen behavior ๐ŸŽ€
    • For correct results, make sure that the specified file contains only a single line with the desired ETag. A non-existing or empty file is treated as an empty ETag.
    • Use the option --etag-save to first save the ETag from a response, and then use this option to compare against the saved ETag in a subsequent request.
    • Use this option with a single URL only.
    • If --etag-compare is provided several times, the last set value is used.
    • Example:
curl --etag-compare etag.txt https://example.com
  • Added in 7.68.0. See also --etag-save and --time-cond.
  • --etag-save <file> โ€” (HTTP) saves an HTTP ETag to the specified file. An ETag is a caching related header, usually returned in a response. Use this option with a single URL only. ๐Ÿ—ƒ๏ธ
    • If no ETag is sent by the server, an empty file is created.
    • In many situations you want to use an existing etag in the request to avoid downloading the same resource again but also save the new etag if it has indeed changed, by using both etag options --etag-save and --etag-compare with the same filename, in the same command line. iconic combo tbh โœจ
    • Starting in curl 8.12.0, using the --create-dirs option can also create missing directory components for the path provided in --etag-save.
    • If --etag-save is provided several times, the last set value is used.
    • Example:
curl --etag-save storetag.txt https://example.com
  • Added in 7.68.0. See also --etag-compare.
  • --expect100-timeout <seconds> โ€” (HTTP) the maximum time in seconds that you allow curl to wait for a 100-continue response when curl emits an Expects: 100-continue header in its request. By default curl waits one second. โฑ๏ธ
    • This option accepts decimal values. When curl stops waiting, it continues as if a response was received.
    • The decimal value needs to be provided using a dot (.) as decimal separator โ€” not the local version even if it might be using another separator. so no commas, bestie ๐Ÿšซ
    • If --expect100-timeout is provided several times, the last set value is used.
    • Example:
curl --expect100-timeout 2.5 -T file https://example.com
  • See also --connect-timeout.

  • -f, --fail โ€” (HTTP) fails with error code 22 and with no response body output at all for HTTP transfers returning HTTP response codes at 400 or greater. Just absolutely refuses to engage. ๐Ÿ™…โ€โ™€๏ธ
    • In normal cases when an HTTP server fails to deliver a document, it returns a body of text stating so (which often also describes why and more) and a 4xx HTTP response code. This command line option prevents curl from outputting that data and instead returns error 22 early. By default, curl does not consider HTTP response codes to indicate failure.
    • To get both the error code and also save the content, use --fail-with-body instead.
    • This method is not fail-safe and there are occasions where non-successful response codes slip through, especially when authentication is involved (response codes 401 and 407). lowkey the messy part ๐Ÿ’€
    • Providing --fail multiple times has no extra effect. Disable it again with --no-fail.
    • Example:
curl --fail https://example.com
  • This option is mutually exclusive with --fail-with-body. See also --fail-with-body and --fail-early.
  • --fail-early โ€” fail and exit on the first detected transfer error. like ripping off the bandaid instead of refreshing the group chat ๐Ÿฉน
    • When curl is used to do multiple transfers on the command line, it attempts to operate on each given URL, one by one. By default, it ignores errors if there are more URLs given and the last URL's success determines the error code curl returns. Early failures are "hidden" by subsequent successful transfers.
    • Using this option, curl instead returns an error on the first transfer that fails, independent of the amount of URLs that are given on the command line. This way, no transfer failures go undetected by scripts and similar. ๐Ÿซถ
    • This option does not imply --fail, which causes transfers to fail due to the server's HTTP status code. You can combine the two options, however note --fail is not global and is therefore contained by --next.
    • This option is global and does not need to be specified for each use of --next. โœจ
    • Providing --fail-early multiple times has no extra effect. Disable it again with --no-fail-early.
    • Example:
curl --fail-early https://example.com https://two.example
  • See also --fail and --fail-with-body.
  • --fail-with-body โ€” omg okay so (HTTP) this one makes curl return an error when the server sends an HTTP response code of 400 or greater. Normally when an HTTP server fails to deliver a document it sends back an HTML document saying so (which often also says why and more, the drama ๐Ÿ’…). This option lets curl output and save that content but also return error 22. It's the alternative to --fail, which makes curl fail for the same circumstances but without saving the content. Providing --fail-with-body multiple times has no extra effect, and you turn it off again with --no-fail-with-body.
curl --fail-with-body https://example.com

This option is mutually exclusive with --fail. Added in 7.76.0. See also --fail and --fail-early.

  • --false-start โ€” (TLS) bestie no TLS backend currently supports this feature, it's giving vaporware ๐Ÿ˜ญ but anyway: use false start during the TLS handshake. False start is a mode where a TLS client starts sending application data before verifying the server's Finished message, thus saving a round trip when performing a full handshake. Providing --false-start multiple times has no extra effect. Disable it again with --no-false-start.
curl --false-start https://example.com

See also --tcp-fastopen.

  • --follow โ€” (HTTP) tells curl to follow HTTP redirects and to do the custom request method set with --request when following redirects, as the HTTP specification says. The method string set with --request is used in subsequent requests for the status codes 307 or 308, but may be reset to GET for 301, 302 and 303. This is subtly different than --location, because that option always sets the custom method in all subsequent requests regardless of response code. Restrict which protocols a redirect is accepted to follow with --proto-redir. When --netrc is used in combination with this option, credentials for the followed-to hosts may also be selected from that file. Providing --follow multiple times has no extra effect. Disable it again with --no-follow.
curl -X POST --follow https://example.com

Added in 8.16.0. See also --request, --location, --proto-redir and --max-redirs.

  • -F, --form <name=content> โ€” (HTTP SMTP IMAP) okay this one is a whole main character โœจ For the HTTP protocol family, this emulates a filled-in form where a user has pressed the submit button โ€” curl POSTs data using the Content-Type multipart/form-data according to RFC 2388. For SMTP and IMAP protocols, this composes a multipart mail message to transmit. It enables uploading of binary files etc.

To force the content part to be a file, prefix the filename with an @ sign. To get the content part from a file, prefix the filename with the symbol <. The difference between @ and < is that @ makes a file get attached in the post as a file upload, while the < makes a text field and gets the contents for that text field from a file.

Read content from stdin instead of a file by using a single - as filename โ€” this goes for both @ and < constructs. When stdin is used, the contents is buffered in memory first by curl to determine its size and allow a possible resend. Defining a part's data from a named non-regular file (such as a named pipe or similar) is not subject to buffering and is instead read at transmission time; since the full size is unknown before the transfer starts, such data is sent as chunks by HTTP and rejected by IMAP. ๐Ÿ’€

Example โ€” send an image to an HTTP server, where profile is the name of the form-field to which the file portrait.jpg is the input:

curl -F profile=@portrait.jpg https://example.com/upload.cgi

Example โ€” send your name and shoe size in two text fields to the server:

curl -F name=John -F shoesize=11 https://example.com/

Example โ€” send your essay in a text field to the server, as a plain text field but getting the contents for it from a local file:

curl -F "story=<hugefile.txt" https://example.com/

You can also instruct curl what Content-Type to use by using type=, in a manner similar to:

curl -F "web=@index.html;type=text/html" example.com

or

curl -F "name=daniel;type=text/foo" example.com

You can also explicitly change the name field of a file upload part by setting filename=, like this:

curl -F "file=@localfile;filename=nameinpost" example.com

If filename/path contains , or ;, it must be quoted by double-quotes like:

curl -F "file=@\"local,file\";filename=\"name;in;post\"" \
    https://example.com

or

curl -F 'file=@"local,file";filename="name;in;post"' \
    https://example.com

Note that if a filename/path is quoted by double-quotes, any double-quote or backslash within the filename must be escaped by backslash.

Quoting must also be applied to non-file data if it contains semicolons, leading/trailing spaces or leading double quotes:

curl -F 'colors="red; green; blue";type=text/x-myapp' \
   https://example.com

You can add custom headers to the field by setting headers=, like

curl -F "submit=OK;headers=\"X-submit-type: OK\"" example.com

or

curl -F "submit=OK;headers=@headerfile" example.com

The headers= keyword may appear more than once and the above notes about quoting apply. When headers are read from a file, empty lines and lines starting with # are ignored; each header can be folded by splitting between two words and starting the continuation line with a space; embedded carriage-returns and trailing spaces are stripped. Here is an example of a header file contents:

# This file contains two headers.
X-header-1: this is a header

# The following header is folded.
X-header-2: this is
 another header

To support sending multipart mail messages, the syntax is extended as follows:

  • name can be omitted: the equal sign is the first character of the argument,
  • if data starts with (, this signals to start a new multipart: it can be followed by a content type specification.
  • a multipart can be terminated with a =) argument.

Example โ€” the following command sends an SMTP mime email consisting in an inline part in two alternative formats: plain text and HTML. It attaches a text file:

curl -F '=(;type=multipart/alternative' \
     -F '=plain text message' \
     -F '= <body>HTML message</body>;type=text/html' \
     -F '=)' -F '=@textfile.txt' ... smtp://example.com

Data can be encoded for transfer using encoder=. Available encodings are binary and 8bit that do nothing else than adding the corresponding Content-Transfer-Encoding header, 7bit that only rejects 8-bit characters with a transfer error, quoted-printable and base64 that encodes data according to the corresponding schemes, limiting lines length to 76 characters.

Example โ€” send multipart mail with a quoted-printable text message and a base64 attached file:

curl -F '=text message;encoder=quoted-printable' \
     -F '=@localfile;encoder=base64' ... smtp://example.com

--form can be used several times in a command line.

curl --form "name=curl" --form "file=@loadthis" https://example.com

This option is mutually exclusive with --data, --head and --upload-file. See also --data, --form-string and --form-escape.

  • --form-escape โ€” (HTTP IMAP SMTP) passes on names of multipart form fields and files using backslash-escaping instead of percent-encoding. If --form-escape is provided several times, the last set value is used.
curl --form-escape -F 'field\name=curl' -F 'file=@load"this' https://example.com

Added in 7.81.0. See also --form.

  • --form-string <name=string> โ€” (HTTP SMTP IMAP) similar to --form except that the value string for the named parameter is used literally. Leading @ and < characters, and the ;type= string in the value have no special meaning. Use this in preference to --form if there is any possibility that the string value may accidentally trigger the @ or < features of --form ๐Ÿ™ˆ

--form-string can be used several times in a command line.

curl --form-string "name=data" https://example.com

See also --form.

  • --ftp-account <data> โ€” (FTP) when an FTP server asks for "account data" after username and password has been provided, this data is sent off using the ACCT command. If --ftp-account is provided several times, the last set value is used.
curl --ftp-account "mr.robot" ftp://example.com/

See also --user.

  • --ftp-alternative-to-user <command> โ€” (FTP) if authenticating with the USER and PASS commands fails, send this command. When connecting to Tumbleweed's Secure Transport server over FTPS using a client certificate, using SITE AUTH tells the server to retrieve the username from the certificate ๐ŸŽ€ If --ftp-alternative-to-user is provided several times, the last set value is used.
curl --ftp-alternative-to-user "U53r" ftp://example.com

See also --ftp-account and --user.

  • --ftp-create-dirs โ€” (FTP SFTP) when an FTP or SFTP URL/operation uses a path that does not currently exist on the server, the standard behavior of curl is to fail. Using this option, curl instead attempts to create missing directories ๐ŸŒˆ Providing --ftp-create-dirs multiple times has no extra effect. Disable it again with --no-ftp-create-dirs.
curl --ftp-create-dirs -T file ftp://example.com/remote/path/file

See also --create-dirs.

  • --ftp-method <method> โ€” (FTP) controls what method curl should use to reach a file on an FTP(S) server. The method argument should be one of the following alternatives:
and bestie that's where this part cuts off โ€” the alternatives list is coming up next, stay tuned ๐Ÿ‘€
  • multicwd โ€” does one single CWD operation for each path part in the URL you handed over. Bestie, if your hierarchy is deep that means likeโ€ฆ many commands. It's literally how RFC 1738 says it should be done. This is the default, but it's also the slowest behavior ๐ŸŒ
    • nocwd โ€” does no CWD at all. curl just does SIZE, RETR, STOR, etc. and hands the full path to the server for each of these commands. This is the fastest behavior โšก
    • singlecwd โ€” does one CWD with the full target directory, and then operates on the file "normally" (like in the multicwd case). This is somewhat more standards compliant than nocwd but without the full penalty of multicwd. The middle child, and honestly? it's serving balance ๐Ÿ’…

If --ftp-method is provided several times, the last set value is used.

Examples, go off:

curl --ftp-method multicwd ftp://example.com/dir1/dir2/file
curl --ftp-method nocwd ftp://example.com/dir1/dir2/file
curl --ftp-method singlecwd ftp://example.com/dir1/dir2/file

See also --list-only.


  • --ftp-pasv โ€” (FTP) uses passive mode for the data connection ๐ŸŽ€ Passive is the internal default behavior, but using this option can be used to override a previous --ftp-port option.

Ngl, reversing an enforced passive really is not doable โ€” but you must then instead enforce the correct --ftp-port again. No cap.

Passive mode means that curl tries the EPSV command first and then PASV, unless --disable-epsv is used.

Providing --ftp-pasv multiple times has no extra effect.

Example:

curl --ftp-pasv ftp://example.com/

This option is mutually exclusive with --ftp-port. See also --disable-epsv.


  • -P, --ftp-port <address> โ€” (FTP) reverses the default initiator/listener roles when connecting with FTP ๐Ÿ”„ This option makes curl use active mode. curl then commands the server to connect back to the client's specified address and port, while passive mode asks the server to set up an IP address and port for it to connect to. <address> should be one of:
    • interface โ€” e.g. eth0 to specify which interface's IP address you want to use (Unix only)
    • IP address โ€” e.g. 192.168.10.1 to specify the exact IP address
    • hostname โ€” e.g. my.host.domain to specify the machine
    • - โ€” make curl pick the same IP address that is already used for the control connection. This is the recommended choice ๐Ÿ‘‘

Disable the use of PORT with --ftp-pasv. Disable the attempt to use the EPRT command instead of PORT by using --disable-eprt. EPRT is really PORT++.

You can also append ":[start]-[end]" to the right of the address, to tell curl what TCP port range to use. That means you specify a port range, from a lower to a higher number. A single number works as well, but do note that it increases the risk of failure since the port may not be available ๐Ÿ˜ฌ

If --ftp-port is provided several times, the last set value is used.

Examples:

curl -P - ftp:/example.com
curl -P eth0 ftp:/example.com
curl -P 192.168.0.2 ftp:/example.com

See also --ftp-pasv and --disable-eprt.


  • --ftp-pret โ€” (FTP) sends a PRET command before PASV (and EPSV) ๐ŸŽ€ Certain FTP servers, mainly drftpd, require this non-standard command for directory listings as well as up and downloads in PASV mode.

Providing --ftp-pret multiple times has no extra effect. Disable it again with --no-ftp-pret.

Example:

curl --ftp-pret ftp://example.com/

See also --ftp-port and --ftp-pasv.


  • --ftp-skip-pasv-ip โ€” (FTP) do not use the IP address the server suggests in its response to curl's PASV command when curl connects the data connection ๐Ÿ™ˆ Instead curl reuses the same IP address it already uses for the control connection.

This option is enabled by default (added in 7.74.0).

This option has no effect if PORT, EPRT or EPSV is used instead of PASV.

Providing --ftp-skip-pasv-ip multiple times has no extra effect. Disable it again with --no-ftp-skip-pasv-ip.

Example:

curl --ftp-skip-pasv-ip ftp://example.com/

See also --ftp-pasv.


  • --ftp-ssl-ccc โ€” (FTP) use CCC (Clear Command Channel) ๐Ÿ’… Shuts down the SSL/TLS layer after authenticating. The rest of the control channel communication is unencrypted. This allows NAT routers to follow the FTP transaction. The default mode is passive.

Providing --ftp-ssl-ccc multiple times has no extra effect. Disable it again with --no-ftp-ssl-ccc.

Example:

curl --ftp-ssl-ccc ftps://example.com/

See also --ssl and --ftp-ssl-ccc-mode.


  • --ftp-ssl-ccc-mode <active/passive> โ€” (FTP) sets the CCC mode ๐Ÿฆ‹ The passive mode does not initiate the shutdown, but instead waits for the server to do it, and does not reply to the shutdown from the server. The active mode initiates the shutdown and waits for a reply from the server.

Providing --ftp-ssl-ccc-mode multiple times has no extra effect. Disable it again with --no-ftp-ssl-ccc-mode.

Example:

curl --ftp-ssl-ccc-mode active --ftp-ssl-ccc ftps://example.com/

See also --ftp-ssl-ccc.


  • --ftp-ssl-control โ€” (FTP) require SSL/TLS for the FTP login, clear for transfer ๐Ÿ” Allows secure authentication, but non-encrypted data transfers for efficiency. Fails the transfer if the server does not support SSL/TLS โ€” so like, it's not playing around.

If set, this option overrides --ssl.

Providing --ftp-ssl-control multiple times has no extra effect. Disable it again with --no-ftp-ssl-control.

Example:

curl --ftp-ssl-control ftp://example.com

See also --ssl.


  • -G, --get โ€” (HTTP) when used, this option makes all data specified with --data, --data-binary or --data-urlencode be used in an HTTP GET request instead of the POST request that otherwise would be used ๐Ÿซถ curl appends the provided data to the URL as a query string.

If used in combination with --head, the POST data is instead appended to the URL with a HEAD request.

Providing --get multiple times has no extra effect. Disable it again with --no-get.

Examples:

curl --get https://example.com
curl --get -d "tool=curl" -d "age=old" https://example.com
curl --get -I -d "tool=curl" https://example.com

See also --data and --request.


  • -g, --globoff โ€” switches off the URL globbing function ๐Ÿšซ When you set this option, you can specify URLs that contain the letters {}[] without having curl itself interpret them. Note that these letters are not normal legal URL contents but they should be encoded according to the URI standard.

curl detects numerical IPv6 addresses when used in URLs and excludes them from the treatment, so they can still be used without having to disable globbing โœจ

Providing --globoff multiple times has no extra effect. Disable it again with --no-globoff.

Example:

curl -g "https://example.com/{[]}}}}"

See also --config and --disable.


  • --happy-eyeballs-timeout-ms <ms> โ€” sets the timeout for Happy Eyeballs ๐ŸŒˆ

Happy Eyeballs is an algorithm that attempts to connect to both IPv4 and IPv6 addresses for dual-stack hosts, giving IPv6 a head-start of the specified number of milliseconds. If the IPv6 address cannot be connected to within that time, then a connection attempt is made to the IPv4 address in parallel. The first connection to be established is the one that is used ๐Ÿ

The range of suggested useful values is limited. Happy Eyeballs RFC 6555 says "It is RECOMMENDED that connection attempts be paced 150-250 ms apart to balance human factors against network load." libcurl currently defaults to 200 ms. Firefox and Chrome currently default to 300 ms.

If --happy-eyeballs-timeout-ms is provided several times, the last set value is used.

Example:

curl --happy-eyeballs-timeout-ms 500 https://example.com

See also --max-time and --connect-timeout.


  • --haproxy-clientip <ip> โ€” (HTTP) sets a client IP in HAProxy PROXY protocol v1 header at the beginning of the connection ๐Ÿ‘‘

For valid requests, IPv4 addresses must be indicated as a series of exactly 4 integers in the range [0..255] inclusive written in decimal representation separated by exactly one dot between each other. Heading zeroes are not permitted in front of numbers in order to avoid any possible confusion with octal numbers. IPv6 addresses must be indicated as series of 4 hexadecimal digits (upper or lower case) delimited by colons between each other, with the acceptance of one double colon sequence to replace the largest acceptable range of consecutive zeroes. The total number of decoded bits must be exactly 128.

Otherwise, any string can be accepted for the client IP and get sent.

It replaces --haproxy-protocol if used, it is not necessary to specify both flags.

If --haproxy-clientip is provided several times, the last set value is used.

Example:

curl --haproxy-clientip $IP

Added in 8.2.0. See also --proxy.


  • --haproxy-protocol โ€” (HTTP) sends a HAProxy PROXY protocol v1 header at the beginning of the connection ๐Ÿ“จ This is used by some load balancers and reverse proxies to indicate the client's true IP address and port.

This option is primarily useful when sending test requests to a service that expects this header.

Providing --haproxy-protocol multiple times has no extra effect. Disable it again with --no-haproxy-protocol.

Example:

curl --haproxy-protocol https://example.com

See also --proxy.


  • -I, --head โ€” (HTTP FTP FILE) fetch the headers only ๐ŸŽ€ HTTP servers feature the command HEAD which this uses to get nothing but the header of a document. When used on an FTP or FILE URL, curl displays the file size and last modification time only.
Heads up bestie: it's headers only โ€” no body, no tea, no goss. Just the metadata ๐Ÿ’…

Giving --head more than once? literally zero extra effect ๐Ÿ’… turn it back off again with --no-head.

Example, bestie:

curl -I https://example.com

See also --get, --verbose and --trace-ascii ๐Ÿซถ


  • -H, --header <header/@file> โ€” ok this one's the moment โœจ (HTTP IMAP SMTP) extra header to include in the info being sent. When you use it inside an HTTP request, it gets added to the regular request headers. No cap.

For an IMAP or SMTP MIME uploaded mail built with --form options, it's prepended to the resulting MIME document โ€” effectively including it at the mail global level ๐ŸŒธ it does not affect raw uploaded mails, so don't @ me.

You can specify any number of extra headers, literally as many as you want. But listen: if you add a custom header that has the same name as one of the internal ones curl would use, your externally set header wins instead of the internal one. That's what lets you do even trickier stuff than curl would normally do ๐Ÿ”ฅ Justโ€ฆ you should not replace internally set headers without knowing perfectly well what you're doing, bestie, i'm serious. Wanna remove an internal header? Give a replacement with no content on the right side of the colon, like: -H "Host:". And if you send the custom header with no-value, then its header must be terminated with a semicolon โ€” like -H "X-Custom-Header;" โ€” to send X-Custom-Header: ๐Ÿ‘‘

curl makes sure that each header you add/replace is sent with the proper end-of-line marker, so you should not add that as part of the header content: do not add newlines or carriage returns, they only mess things up for you ๐Ÿ˜ญ curl passes on the verbatim string you give it without any filter or other safe guards. That includes white space and control characters. fr fr.

This option can take an argument in @filename style, which then adds a header for each line in the input file ๐Ÿ“„ using @- makes curl read the header file from stdin.

Please note that most anti-spam utilities check the presence and value of several MIME mail headers ๐Ÿงš these are "From:", "To:", "Date:" and "Subject:" among others, and they should be added with this option.

You need --proxy-header to send custom headers intended for an HTTP proxy, iykyk.

Passing on a "Transfer-Encoding: chunked" header when doing an HTTP request with a request body, makes curl send the data using chunked encoding ๐Ÿ’ซ

WARNING: headers set with this option are set in all HTTP requests โ€” even after redirects are followed, like when told with --location. This can lead to the header being sent to other hosts than the original host, so sensitive headers should be used with caution combined with following redirects. bestie pls be careful with this one ๐Ÿ™ˆ

"Authorization:" and "Cookie:" headers are explicitly not passed on in HTTP requests when following redirects to other origins, unless --location-trusted is used ๐Ÿ’œ

--header can be used several times in a command line. slay.

Examples, because we love a demo:

curl -H "X-First-Name: Joe" https://example.com
curl -H "User-Agent: yes-please/2000" https://example.com
curl -H "Host:" https://example.com
curl -H @headers.txt https://example.com

See also --user-agent, --referer and --proxy-header ๐Ÿฆ‹


  • -h, --help <subject> โ€” usage help, the wholesome one ๐ŸŽ€ provide help for the subject given as an optional argument.

No argument at all? curl displays the most important command line arguments ๐ŸŒˆ

The argument can either be a category or a command line option. When a category is provided, curl shows all command line options within the given category. Specify category all to list all available options ๐Ÿ‘‘ (yes, all of them, grab a snack)

If category is specified, curl displays all available help categories ๐Ÿ—‚๏ธ

If the provided subject is instead an existing command line option โ€” specified either in its short form with a single dash and a single letter, or in the long form with two dashes and a longer name โ€” curl displays a help text for that option in the terminal ๐Ÿ’ป

The help output is extensive for some options. like, extensive.

If the provided command line option is not known, curl says so ๐Ÿ’€

Examples:

curl --help all
curl --help --insecure
curl --help -f

See also --verbose โญ


  • --hostpubmd5 <md5> โ€” (SFTP SCP) pass a string containing 32 hexadecimal digits ๐Ÿ”ข the string should be the 128 bit MD5 checksum of the remote host's public key, and curl refuses the connection with the host unless the checksums match. no match, no vibes, no connection ๐Ÿ’…

If --hostpubmd5 is provided several times, the last set value is used.

Example:

curl --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/

See also --hostpubsha256 ๐ŸŒธ


  • --hostpubsha256 <sha256> โ€” (SFTP SCP) pass a string containing a Base64-encoded SHA256 hash of the remote host's public key ๐Ÿ” curl refuses the connection with the host unless the hashes match. same energy, glowier algorithm.

If --hostpubsha256 is provided several times, the last set value is used.

Example:

curl --hostpubsha256 NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ= sftp://example.com/

Added in 7.80.0. See also --hostpubmd5 ๐Ÿซถ


  • --hsts <filename> โ€” (HTTPS) enable HSTS for the transfer โœจ if the filename points to an existing HSTS cache file, that one is used. After a completed transfer, the cache is saved to the filename again if it has been modified ๐Ÿ’พ

If you run multiple curl invokes at the same time using the same HSTS cache file, they might interfere with each other in possibly undesired ways ๐Ÿ˜ฌ so likeโ€ฆ don't do that? or do, but know.

If curl is told to use "http://" for a transfer involving a hostname that exists in the HSTS cache, it upgrades the transfer to use HTTPS ๐Ÿ”’ each HSTS cache entry has an individual lifetime after which the upgrade is no longer performed.

Specify a "" filename (zero length) to avoid loading/saving and make curl handle HSTS in memory ๐Ÿง 

You may want to restrict your umask to prevent other users on the same system to access the created file ๐Ÿ‘€

If this option is used several times, curl loads contents from all the files but the last one is used for saving.

Since curl 8.20.0, curl keeps no more than the most recently added 10,000 unique HSTS hostnames ๐Ÿ”ข

--hsts can be used several times in a command line.

Example:

curl --hsts cache.txt https://example.com

Added in 7.74.0. See also --proto ๐Ÿ’œ


  • --http0.9 โ€” (HTTP) accept an HTTP version 0.9 response ๐Ÿฆ•

HTTP/0.9 is a response without headers, and therefore you can also connect with this to non-HTTP servers and still get a response โ€” since curl transparently downgrades, if allowed.

HTTP/0.9 is disabled by default (added in 7.66.0) ๐Ÿšซ

Providing --http0.9 multiple times has no extra effect. Disable it again with --no-http0.9.

Example:

curl --http0.9 https://example.com

See also --http1.1, --http2 and --http3 โญ


  • -0, --http1.0 โ€” (HTTP) use HTTP version 1.0 instead of using its internally preferred HTTP version ๐Ÿ•ฐ๏ธ vintage era behaviour, love that for you.

Providing --http1.0 multiple times has no extra effect.

Example:

curl --http1.0 https://example.com

This option is mutually exclusive with --http1.1, --http2, --http2-prior-knowledge and --http3. pick one, bestie, you can't have all of them ๐Ÿ’€ See also --http0.9 and --http1.1.


  • --http1.1 โ€” (HTTP) use HTTP version 1.1 ๐Ÿ’… this is the default with "http://" URLs. main character protocol, honestly.

Providing --http1.1 multiple times has no extra effect.

Example:

curl --http1.1 https://example.com

This option is mutually exclusive with --http1.0, --http2, --http2-prior-knowledge and --http3. See also --http1.0 and --http0.9 ๐ŸŒธ


  • --http2 โ€” (HTTP) use HTTP/2 ๐Ÿš€

For HTTPS, this means curl negotiates HTTP/2 in the TLS handshake. curl does this by default, so likeโ€ฆ it's already serving.

For HTTP, this means curl attempts to upgrade the request to HTTP/2 using the Upgrade: request header โฌ†๏ธ

When curl uses HTTP/2 over HTTPS, it does not itself insist on TLS 1.2 or higher even though that is required by the specification โš ๏ธ a user can add this version requirement with --tlsv1.2.

Providing --http2 multiple times has no extra effect.

Example:

curl --http2 https://example.com

For --http2 to work, it requires that the underlying libcurl is built to support HTTP/2 ๐Ÿ”ง This option is mutually exclusive with --http1.1, --http1.0, --http2-prior-knowledge and --http3. See also --http1.1, --http3, --no-alpn and --proxy-http2 ๐Ÿซถ


  • --http2-prior-knowledge โ€” (HTTP) issue a non-TLS HTTP request using HTTP/2 directly without HTTP/1.1 Upgrade ๐Ÿ™Œ it requires prior knowledge that the server supports HTTP/2 straight away. HTTPS requests still do HTTP/2 the standard way with negotiated protocol versions in the TLS handshake.

Since 8.10.0, if this option is set for an HTTPS request then the application layer protocol version (ALPN) offered to the server is only HTTP/2 ๐ŸŒŸ prior to that both HTTP/1.1 and HTTP/2 were offered.

Providing --http2-prior-knowledge multiple times has no extra effect. Disable it again with --no-http2-prior-knowledge.

Example:

curl --http2-prior-knowledge https://example.com

For --http2-prior-knowledge to work, it requires that the underlying libcurl is built to support HTTP/2 ๐Ÿ”ง This option is mutually exclusive with --http1.1, --http1.0, --http2 and --http3. See also --http2 and --http3 ๐Ÿ’œ


  • --http3 โ€” (HTTP) attempt HTTP/3 to the host in the URL, but fallback to earlier HTTP versions if the HTTP/3 connection establishment fails or is slow ๐Ÿฆ‹ HTTP/3 is only available for HTTPS and not for HTTP URLs, so don't try it.

This option allows a user to avoid using the Alt-Svc method of upgrading to HTTP/3 when you know or suspect that the target speaks HTTP/3 on the given host and port ๐Ÿ‘‘

When asked to use HTTP/3, curl issues a separate attempt to use older HTTP versions with a slight delay, so if the HTTP/3 transfer fails or is slow, curl still tries to proceed with an older HTTP version โณ the fallback performs the regular negotiation between HTTP/1 and HTTP/2.

...so like, use --http3-only if you want that same energy but with zero fallback, bestie.

curl literally cannot do HTTP/3 over any proxy โ€” that's just the rules.

Handing curl --http3 a bunch of times? No extra effect. One is enough, she heard you the first time ๐Ÿ’…

Example:

curl --http3 https://example.com

For --http3 to actually work, the underlying libcurl has to be built with HTTP/3 support. And heads up โ€” this option is mutually exclusive with --http1.1, --http1.0, --http2, --http2-prior-knowledge and --http3-only, so pick a lane. Added in 7.66.0. See also --http1.1 and --http2.


โœจ --http3-only โœจ

(HTTP) Okay so this one tells curl to use HTTP/3 to the host in the URL, with no fallback to earlier HTTP versions. HTTP/3 can only be used for HTTPS and not for HTTP URLs โ€” try it on a plain HTTP URL and the option triggers an error. Not her fault, that's just how it is ๐Ÿ˜ญ

The whole point of this one is letting you skip the Alt-Svc upgrade dance when you already know the target speaks HTTP/3 on that host and port. Main character energy: you already know.

This option makes curl fail if a QUIC connection cannot be established. It does not attempt any other HTTP versions on its own. Use --http3 for similar functionality with a fallback.

Providing --http3-only multiple times has no extra effect.

Example:

curl --http3-only https://example.com

For --http3-only to work, the underlying libcurl must be built to support HTTP/3. This option is mutually exclusive with --http1.1, --http1.0, --http2, --http2-prior-knowledge and --http3. Added in 7.88.0. See also --http1.1, --http2 and --http3.


๐Ÿ’œ --httpsig-algo <algorithm> ๐Ÿ’œ

(HTTP) WARNING: this option is experimental. Do not use in production. (Like, fr fr, she's telling you for your own good ๐Ÿ™ˆ)

Signs outgoing HTTP requests using RFC 9421 HTTP Message Signatures.

This option specifies which signing algorithm to use. Supported values are ed25519 and hmac-sha256. If you don't specify one, ed25519 is used. Any other value makes curl exit with an error โ€” no vibes, just error.

HTTP Message Signatures turn on when any of --httpsig-algo, --httpsig-key, --httpsig-keyid or --httpsig-headers is given. Once enabled, --httpsig-key and --httpsig-keyid are required. Without any of these options, no signing is performed at all.

By default, the signed components are "method", "authority", "path", and "query" (when a query string is present). Use --httpsig-headers to override the set of components included in the signature.

If --httpsig-algo is provided several times, the last set value is used.

Examples:

curl --httpsig-key key.hex --httpsig-keyid "my-key" https://example.com
curl --httpsig-algo hmac-sha256 --httpsig-key secret.hex --httpsig-keyid "shared" https://example.com

Added in 8.22.0. See also --httpsig-key, --httpsig-keyid and --httpsig-headers.


๐ŸŒธ --httpsig-headers <components> ๐ŸŒธ

(HTTP) WARNING: this option is experimental. Do not use in production.

Space-separated list of components to include in the RFC 9421 HTTP Message Signature. Derived components are given as bare names: "method", "authority", "path", and "query". HTTP header fields are given with a trailing colon, for example "content-type:" and "content-digest:". Yes, the colon matters. She's picky like that ๐Ÿ’…

If not specified, the default set is "method authority path" (plus "query" when a query string is present in the URL).

Signing request headers

Header components are taken from -H / --header options only. Headers curl adds by default (such as "User-Agent") are not signed unless you set them explicitly, for example:

curl --httpsig-algo ed25519 \
  --httpsig-key k.hex \
  --httpsig-keyid mykey \
  -H "User-Agent: MyApp/1.0" \
  --httpsig-headers \
  "method authority path user-agent:" \
  $URL

Each component may appear only once. Duplicate identifiers in --httpsig-headers cause curl to exit with an error.

If --httpsig-headers is provided several times, the last set value is used.

Example:

curl --httpsig-algo ed25519 --httpsig-key key.hex --httpsig-keyid "my-key" --httpsig-headers "method authority content-type:" https://example.com

Added in 8.22.0. See also --httpsig-algo, --httpsig-key and --httpsig-keyid.


๐ŸŽ€ --httpsig-key <key/file> ๐ŸŽ€

(HTTP) WARNING: this option is experimental. Do not use in production.

The key to use for RFC 9421 HTTP Message Signatures. Provide it as-is, or as @filename. If the argument starts with an @, the rest is treated as a file name for the key.

The key is formatted as a series of hexadecimal digits in a single line. For ed25519, this is the 32-byte private seed (64 hex characters). For hmac-sha256, this is the shared secret. PEM files are not supported โ€” sorry bestie, wrong format ๐Ÿ˜ญ

Generating Ed25519 keys

With OpenSSL 3:

openssl genpkey -algorithm ED25519 -out k.pem
openssl pkey -in k.pem -text -noout | \
  grep -A3 ^priv: | \
  tr -cd '[:xdigit:]' > k.hex

Use "@k.hex" with --httpsig-key.

If --httpsig-key is provided several times, the last set value is used.

Examples:

curl --httpsig-algo ed25519 --httpsig-key @key.hex --httpsig-keyid "my-key" https://example.com
curl --httpsig-key 123a56fb72197633bc --httpsig-keyid "my-key" https://example.com

Added in 8.22.0. See also --httpsig-algo and --httpsig-keyid.


โญ --httpsig-keyid <id> โญ

(HTTP) WARNING: this option is experimental. Do not use in production.

The key identifier to include in the "Signature-Input" header when using RFC 9421 HTTP Message Signatures. This value shows up as the "keyid" parameter and lets the server look up the correct verification key. It's giving โœจname tag at the functionโœจ

If --httpsig-keyid is provided several times, the last set value is used.

Example:

curl --httpsig-algo ed25519 --httpsig-key key.hex --httpsig-keyid "my-key" https://example.com

Added in 8.22.0. See also --httpsig-algo and --httpsig-key.


๐Ÿฆ‹ --ignore-content-length ๐Ÿฆ‹

(FTP HTTP) For HTTP, ignore the Content-Length header. This is especially handy for servers running Apache 1.x, which reports an incorrect Content-Length for files larger than 2 gigabytes. (Those numbers are so unserious ๐Ÿ˜ญ)

For FTP, this makes curl skip the SIZE command that it would otherwise run to figure out the size before downloading a file.

Providing --ignore-content-length multiple times has no extra effect. Disable it again with --no-ignore-content-length.

Example:

curl --ignore-content-length https://example.com

See also --ftp-skip-pasv-ip.


๐Ÿ”ฅ -k, --insecure ๐Ÿ”ฅ

(TLS SFTP SCP) By default, every secure connection curl makes is verified to be secure before the transfer takes place. This option makes curl skip that verification step and proceed without checking. She's just gonna... trust you. And that's the problem ๐Ÿ‘€

When this option is not used for protocols using TLS, curl verifies the server's TLS certificate before it continues: that the certificate contains the right name matching the hostname used in the URL, and that the certificate has been signed by a CA certificate present in the cert store. See this online resource for further details: https://curl.se/docs/sslcerts.html

For SFTP and SCP, this option makes curl skip the known_hosts verification. known_hosts is a file normally stored in the user's home directory in the .ssh subdirectory, which contains hostnames and their public keys.

WARNING: using this option makes the transfer insecure. Like, actually. Not a drill ๐Ÿ’€

When curl uses secure protocols it trusts responses and allows, for example, HSTS and Alt-Svc information to be stored and used subsequently. Using --insecure can make curl trust and use such information from malicious servers. So yeah โ€” the consequences aren't just this one transfer.

Providing --insecure multiple times has no extra effect. Disable it again with --no-insecure.

Example:

curl --insecure https://example.com

See also --proxy-insecure, --cacert and --capath.


๐ŸŒˆ --interface <name> ๐ŸŒˆ

Perform the operation using a specified interface. You can enter an interface name, IP address or hostname. If you want to be specific specific, you can use the following special syntax:

  • if!<name> โ€” Interface name. If the provided name does not match an existing interface, curl returns with error 45.
  • host!<name> โ€” IP address or hostname.
  • ifhost!<interface>!<host> โ€” Interface name and IP address or hostname. This syntax requires libcurl 8.9.0 or later. If the provided name does not match an existing interface, curl returns with error 45.

curl does not support using network interface names for this option on Windows. Sorry Windows girlies ๐Ÿซถ

That name resolve operation, if a hostname is provided, does not use DNS-over-HTTPS even if --doh-url is set. Sneaky detail, keep it in mind.

On Linux this option can be used to specify a VRF (Virtual Routing and Forwarding) device, but the binary then needs to either have the CAP_NET_RAW capability set or to be run as root. Root energy only ๐Ÿ‘‘

If --interface is provided several times, the last set value is used.

Examples:

curl --interface eth0 https://example.com
curl --interface "host!10.0.0.1" https://example.com
curl --interface "if!enp3s0" https://example.com

See also --dns-interface.


๐Ÿ“ --ip-tos <string> ๐Ÿ“

Set Type of Service (TOS) for IPv4 or Traffic Class for IPv6.

The values allowed for <string> can be a numeric value between 1 and 255 or one of the following:

CS0, CS1, CS2, CS3, CS4, CS5, CS6, CS7, AF11, AF12, AF13, AF21, AF22, AF23, AF31, AF32, AF33, AF41, AF42, AF43, EF, VOICE-ADMIT, ECT1, ECT0, CE, LE, LOWCOST, LOWDELAY, THROUGHPUT, RELIABILITY, MINCOST

If --ip-tos is provided several times, the last set value is used.

Example:

curl --ip-tos CS5 https://example.com

Added in 8.9.0. See also --tcp-nodelay and --vlan-priority.

--ipfs-gateway <URL></p>

(IPFS) bestie, this is where you say which gateway to use for ipfs:// and ipns:// URLs. If you don't specify one, curl goes looking: first it checks whether the IPFS_GATEWAY environment variable is set, and if not, whether there's a ~/.ipfs/gateway file chilling there holding the gateway URL โœจ

If you run a local IPFS node, that gateway is by default available under http://localhost:8080. A full example URL would look like:

curl --ipfs-gateway http://localhost:8080 \
   ipfs://bafybeigagd5nmnn2iys2f3

There are so many public IPFS gateways out there. See for example: https://ipfs.github.io/public-gateway-checker/

๐Ÿšจ okay this part matters: if you opt to go for a remote gateway you need to be aware that you completely trust the gateway. That might be fine for local gateways that you host yourself. But with remote gateways there could potentially be malicious actors returning you data that does not match the request you made, inspect or even interfere with the request. You may not notice this when using curl. A mitigation could be to go for a "trustless" gateway โ€” that means you locally verify the data. Consult the docs page on trusted vs trustless: https://docs.ipfs.tech/reference/http/gateway/#trusted-vs-trustless

If --ipfs-gateway is provided several times, the last set value is used. iykyk ๐Ÿ’…

Example:

curl --ipfs-gateway https://example.com ipfs://

Added in 8.4.0. See also --help and --manual.


-4, --ipv4</p>

Request only IPv4 addresses when resolving hostnames โ€” and not, for example, any IPv6. That's it, that's the whole vibe ๐Ÿฆ‹

Providing --ipv4 multiple times has no extra effect. Slay, but like, redundantly.

Example:

curl --ipv4 https://example.com

This option is mutually exclusive with --ipv6. See also --http1.1 and --http2.


-6, --ipv6</p>

The mirror image, bestie: request only IPv6 addresses when resolving hostnames, and not for example any IPv4 ๐Ÿ’œ

Heads up though โ€” your resolver may still respond to an IPv6-only resolve request by returning IPv6 addresses that contain "mapped" IPv4 addresses for compatibility purposes. macOS is known to do this. Not me calling out macOS but ๐Ÿ‘€

Providing --ipv6 multiple times has no extra effect.

Example:

curl --ipv6 https://example.com

This option is mutually exclusive with --ipv4. See also --http1.1 and --http2.


--json <data></p>

(HTTP) Send the specified JSON data in a POST request to the HTTP server. --json is basically a shortcut for passing on these three options, and the way it bundles them is lowkey iconic:

--data-binary [arg]
--header "Content-Type: application/json"
--header "Accept: application/json"

There is no verification that the passed in data is actual JSON or that the syntax is correct. curl is not your linter, she is simply delivering the vibes ๐Ÿ“ฆ

If you start the data with the letter @, the rest should be a filename to read the data from โ€” or a single dash (-) if you want curl to read the data from stdin. Posting data from a file named 'foobar' would thus be done with --json @foobar and to instead read the data from stdin, use --json @-.

If this option is used more than once on the same command line, the additional data pieces are concatenated to the previous before sending. String them together, bestie ๐Ÿงต

The headers this option sets can be overridden with --header as usual. Your house, your rules.

--json can be used several times in a command line.

Examples:

curl --json '{ "drink": "coffee" }' https://example.com
curl --json '{ "drink":' --json ' "coffee" }' https://example.com
curl --json @prepared https://example.com
curl --json @- https://example.com < json.txt

This option is mutually exclusive with --form, --head and --upload-file. Added in 7.82.0. See also --data-binary and --data-raw.


-j, --junk-session-cookies</p>

(HTTP) When curl is told to read cookies from a given file, this option makes it discard all session cookies. This has the same effect as if a new session is started โ€” and typical browsers discard session cookies when they are closed down, so you're just matching their energy ๐Ÿช

Session cookies are cookies without a set expiry time. They are meant to only last for "a session". That's the whole deal with them.

Providing --junk-session-cookies multiple times has no extra effect. Disable it again with --no-junk-session-cookies.

Example:

curl --junk-session-cookies -b cookies.txt https://example.com

See also --cookie and --cookie-jar.


--keepalive-cnt <integer></p>

Set the maximum number of keepalive probes TCP should send but get no response before dropping the connection. This option is usually used in conjunction with --keepalive-time. They're a duo, fr fr ๐Ÿซถ

This option is supported on Linux, *BSD/macOS, Windows >=10.0.16299, Solaris 11.4, and recent AIX, HP-UX and more. This option has no effect if --no-keepalive is used.

If unspecified, the option defaults to 9.

If --keepalive-cnt is provided several times, the last set value is used.

Example:

curl --keepalive-cnt 3 https://example.com

Added in 8.9.0. See also --keepalive-time and --no-keepalive.


--keepalive-time <seconds></p>

Set the time a connection needs to remain idle before sending keepalive probes โ€” and the time between individual keepalive probes. It is currently effective on operating systems offering the TCP_KEEPIDLE and TCP_KEEPINTVL socket options (meaning Linux, *BSD/macOS, Windows, Solaris, and recent AIX, HP-UX and more) ๐ŸŒˆ

Keepalive is used by the TCP stack to detect broken networks on idle connections. The number of missed keepalive probes before declaring the connection down is OS dependent and is commonly 8 (*BSD/macOS/AIX), 9 (Linux/AIX) or 5/10 (Windows), and this number can be changed by specifying the curl option keepalive-cnt. Note that this option has no effect if --no-keepalive is used.

If unspecified, the option defaults to 60 seconds.

If --keepalive-time is provided several times, the last set value is used.

Example:

curl --keepalive-time 20 https://example.com

See also --no-keepalive, --keepalive-cnt and --max-time.


--key <key></p>

(TLS SCP SFTP) Private key filename ๐Ÿ”‘ This lets you provide your private key in this separate file. For SSH, if not specified, curl tries the following candidates in order: ~/.ssh/id_rsa, ~/.ssh/id_dsa, ./id_rsa, ./id_dsa.

If curl is built against OpenSSL library, and the engine pkcs11 or pkcs11 provider is available, then a PKCS#11 URI (RFC 7512) can be used to specify a private key located in a PKCS#11 device. A string beginning with pkcs11: is interpreted as a PKCS#11 URI. If a PKCS#11 URI is provided, then the --engine option is set as pkcs11 if none was provided and the --key-type option is set as ENG or PROV if none was provided (depending on OpenSSL version). curl really said "I got you, I'll fill in the blanks" ๐Ÿ’…

If curl is built against Schannel then this option is ignored for TLS protocols (HTTPS, etc). That backend expects the private key to be already present in the keychain or PKCS#12 file containing the certificate. Different backend, different rules, no cap.

If --key is provided several times, the last set value is used.

Example:

curl --cert certificate --key here https://example.com

See also --key-type and --cert.


--key-type <type></p>

(TLS) Private key file type. Specify which type your --key provided private key is. DER, PEM, and ENG are supported. If not specified, PEM is assumed ๐ŸŽ€

If --key-type is provided several times, the last set value is used.

Example:

curl --key-type DER --key here https://example.com

See also --key.


--knownhosts <file></p>

(SCP SFTP) When doing SCP and SFTP transfers, curl automatically checks a database containing identification for all hosts it has ever been used with, to verify that the host it connects to is the same as previously. Host keys are stored in such a known hosts file. curl uses the ~/.ssh/known_hosts in the user's home directory by default. She remembers everyone she's ever met, basically ๐Ÿ“–

This option lets a user specify a specific file to check the host against.

The known hosts check can be disabled with --insecure, but that makes the transfer insecure and is strongly discouraged. Like, don't. Genuinely don't. ๐Ÿ™ˆ

If --knownhosts is provided several times, the last set value is used.

Example:

curl --knownhosts filename --key here https://example.com

Added in 8.17.0. See also --hostpubsha256, --hostpubmd5, --insecure and --key.


--krb <level></p>

(FTP) Ugh, okay โ€” this is a deprecated option (added in 8.17.0). It has no function anymore. It's giving retired icon, still on the guest list ๐Ÿ’€

For the historical record: it enabled Kerberos authentication and use. The level must be entered and should be one of "clear", "safe", "confidential", or "private". Should you use a level that is not one of these, "private" is used.

If --krb is provided several times, the last set value is used.

Example:

curl --krb clear ftp://example.com/

For --krb to work, it requires that the underlying libcurl is built to support Kerberos. See also --delegation and --ssl.


--libcurl <file></p>

Append this option to any ordinary curl command line, and you get libcurl-using C source code written to the file that does the equivalent of what your command-line operation does. Yes bestie, curl will literally write the C for you, main character behavior โœจ

The source code output should be considered example code and is not production ready. You must double-check that the code actually does what you want it do. Do not just ship it, I'm begging ๐Ÿซถ

This option is global and does not need to be specified for each use of --next.

If --libcurl is provided several times, the last set value is used.

Example:

curl --libcurl client.c https://example.com

See also --verbose.


--limit-rate <speed></p>

Specify the maximum transfer rate you want curl to use โ€” for both downloads and uploads ๐Ÿšฆ This feature is useful if you have a limited pipe and you would like your transfer not to use your entire bandwidth. To make it slower than it otherwise would be. Considerate queen behavior, honestly ๐Ÿ’–

okay so the number you give is measured in bytes/second, unless you tack a suffix on the end. Slap a k or K after it and it counts as kilobytes, m or M makes it megabytes, etc. The supported suffixes are k, M, G, T, P and they're all 1024-based. So like, 1k is literally 1024. Examples: 200K, 3m and 1G. ๐Ÿซถ

The rate-limiting logic works by averaging the transfer speed so it stays no more than your set threshold over a period of multiple seconds. It's giving chill vibes, not a hard clamp.

If you also use the --speed-limit option, that option takes precedence and might cripple the rate-limiting slightly, all to help keep the speed-limit logic working. iykyk. ๐Ÿ’…

Starting in curl 8.19.0, you can specify the rate using a fraction, like "2.5M" for two and a half megabytes per second. It only works with a period (.) delimiter, independent of what your locale might prefer โ€” so don't come at it with commas, bestie. ๐Ÿ™ˆ

If --limit-rate is provided several times, the last set value is used.

Examples:

curl --limit-rate 123.45K https://example.com
curl --limit-rate 1000 https://example.com
curl --limit-rate 10M https://example.com
curl --limit-rate 200K --max-time 60 https://example.com

See also --rate, --speed-limit and --speed-time.


  • -l, --list-only โ€” (FTP POP3 SFTP FILE) When you're listing an FTP directory, this forces a name-only view. Maybe particularly useful if you want to machine-parse the contents of an FTP directory, since the normal directory view does not use a standard look or format. When used like this, the option causes an NLST command to be sent to the server instead of LIST. ๐Ÿ—‚๏ธ
Note: some FTP servers list only files in their response to NLST โ€” they do not include subdirectories and symbolic links. ๐Ÿ˜ญ

When listing an SFTP directory, this switch forces a name-only view, one per line. This is especially useful if you want to machine-parse the contents of an SFTP directory, since the normal directory view provides more information than filenames.

When retrieving a specific email from POP3, this switch forces a LIST command to be performed instead of RETR. Particularly useful if you wanna see if a specific message-id exists on the server and what size it is. ๐Ÿ“ฌ

For FILE, this option has no effect yet, as directories are always listed in this mode.

Note: when combined with --request, this option can be used to send a UIDL command instead, so you can use the email's unique identifier rather than its message-id to make the request.

Providing --list-only multiple times has no extra effect. Disable it again with --no-list-only.

Example:

curl --list-only ftp://example.com/dir/

See also --quote and --request.

  • --local-port <range> โ€” set a preferred single number or range (FROM-TO) of local port numbers to use for the connection(s). โœจ Note that port numbers by nature are a scarce resource, so setting this range to something too narrow might cause unnecessary connection setup failures. Like, don't be greedy with ports, fr fr.

If --local-port is provided several times, the last set value is used.

Example:

curl --local-port 1000-3000 https://example.com

See also --globoff.

  • -L, --location โ€” (HTTP) If the server reports that the requested page has moved to a different location (indicated with a Location: header and a 3XX response code), this option makes curl redo the request to the new place. ๐Ÿฆ‹ If used together with --show-headers or --head, headers from all requested pages are shown.

When authentication is provided on the command line (for example --user or --oauth2-bearer), or when sending a cookie with -H Cookie:, curl only sends its credentials to the initial host. If a redirect takes curl to a different host, it does not get the credentials passed on. See --location-trusted on how to change this. When --netrc is used in combination with this option, credentials for the followed-to hosts may also be selected from that file.

Limit the amount of redirects to follow by using the --max-redirs option. ๐ŸŽฏ

When curl follows a redirect and the request is a POST, it sends the following request with a GET if the HTTP response was 301, 302, or 303. If the response code was any other 3xx code, curl resends the following request using the same unmodified method.

You can tell curl to not change POST requests to GET after a 30x response by using the dedicated options for that: --post301, --post302 and --post303.

The method set with --request overrides the method curl would otherwise select to use.

Restrict which protocols a redirect is accepted to follow with --proto-redir.

Providing --location multiple times has no extra effect. Disable it again with --no-location.

Example:

curl -L https://example.com

See also --resolve, --alt-svc, --follow, --proto-redir and --max-redirs.

  • --location-trusted โ€” (HTTP) Instructs curl to follow HTTP redirects like --location, but permits curl to send credentials and other secrets along to hosts other than the initial one. ๐Ÿ‘€
This may or may not introduce a security breach if the site redirects you to a site to which you send this sensitive data to. Another host means that one or more of hostname, protocol scheme or port number changed. Be careful, bestie, this is not a vibe to hand out casually. ๐Ÿ’€

This option also allows curl to pass long cookies set explicitly with --header.

Providing --location-trusted multiple times has no extra effect. Disable it again with --no-location-trusted.

Examples:

curl --location-trusted -u user:password https://example.com
curl --location-trusted -H "Cookie: session=abc" https://example.com

See also --user and --follow.

  • --login-options <options> โ€” (IMAP LDAP POP3 SMTP) Specify the login options to use during server authentication.

You can use login options to specify protocol-specific options that may be used during authentication. At present only IMAP, POP3 and SMTP support login options. For more information about login options please see RFC 2384, RFC 5092 and the IETF draft https://datatracker.ietf.org/doc/html/draft-earhart-url-smtp-00. ๐Ÿ“š

Since 8.2.0, IMAP supports the login option "AUTH=+LOGIN". With this option, curl uses the plain (not SASL) "LOGIN IMAP" command even if the server advertises SASL authentication. ๐Ÿ˜ฌ Care should be taken in using this option, as it sends your password over the network in plain text. This does not work if the IMAP server disables the plain "LOGIN" (e.g. to prevent password snooping).

If --login-options is provided several times, the last set value is used.

Example:

curl --login-options 'AUTH=*' imap://example.com

See also --user.

  • --mail-auth <address> โ€” (SMTP) Specify a single address. This is used to specify the authentication address (identity) of a submitted message that is being relayed to another server. ๐Ÿ“จ

If --mail-auth is provided several times, the last set value is used.

Example:

curl --mail-auth user@example.com -T mail smtp://example.com/

See also --mail-rcpt and --mail-from.

  • --mail-from <address> โ€” (SMTP) Specify a single address that the given mail should get sent from. โœ‰๏ธ

If --mail-from is provided several times, the last set value is used.

Example:

curl --mail-from user@example.com -T mail smtp://example.com/

See also --mail-rcpt and --mail-auth.

  • --mail-rcpt <address> โ€” (SMTP) Specify a single email address, username or mailing list name. Repeat this option several times to send to multiple recipients. ๐Ÿ‘ฏ

When performing an address verification (VRFY command), the recipient should be specified as the username or username and domain (as per Section 3.5 of RFC 5321).

When performing a mailing list expand (EXPN command), the recipient should be specified using the mailing list name, such as "Friends" or "London-Office".

--mail-rcpt can be used several times in a command line.

Example:

curl --mail-rcpt user@example.net smtp://example.com

See also --mail-rcpt-allowfails.

  • --mail-rcpt-allowfails โ€” (SMTP) When sending data to multiple recipients, by default curl aborts the SMTP conversation if at least one of the recipients causes the RCPT TO command to return an error. ๐Ÿ™…โ€โ™€๏ธ

The default behavior can be changed by passing the --mail-rcpt-allowfails command-line option, which makes curl ignore errors and proceed with the remaining valid recipients. Slay, resilience. ๐Ÿ’…

If all recipients trigger RCPT TO failures and this flag is specified, curl still aborts the SMTP conversation and returns the error received from the last RCPT TO command.

Providing --mail-rcpt-allowfails multiple times has no extra effect. Disable it again with --no-mail-rcpt-allowfails.

Example:

curl --mail-rcpt-allowfails --mail-rcpt dest@example.com smtp://example.com

Added in 7.69.0. See also --mail-rcpt.

  • -M, --manual โ€” Manual. Display the huge help text. ๐Ÿ“– Like, the whole entire thing. Iconic behavior honestly.

Example:

curl --manual

See also --verbose, --libcurl and --trace.

  • --max-filesize <bytes> โ€” (FTP HTTP MQTT) When set to a non-zero value, it specifies the maximum size (in bytes) of a file to download. If the file requested is larger than this value, the transfer does not start and curl returns with exit code 63. ๐Ÿšซ

Setting the maximum value to zero disables the limit.

A unit suffix letter can be used. Appending k or K counts the number as kilobytes, m or M makes it megabytes, etc. The supported suffixes (k, M, G, T, P) are 1024-based. Examples: 200K, 3m and 1G.

NOTE: before curl 8.4.0, when the file size is not known prior to download, for such files this option has no effect even if the file transfer ends up being larger than this given limit. ๐Ÿ˜ญ

Starting with curl 8.4.0, this option aborts the transfer if it reaches the threshold during transfer. โญ

Like, starting in curl 8.19.0 you can even pass the max size as a fraction โ€” "2.5M" is literally two and a half megabytes, slay ๐Ÿ“. Small catch tho: it only works with a period (".") as the delimiter, periodt โ€” your locale can prefer whatever it wants, curl does not care.

And since 8.20.0 this option also stops ongoing transfers that would hit this threshold because of automatic decompression from --compressed. So it's not just a pre-flight check anymore, it's a whole vibe check mid-download ๐Ÿ’….

If --max-filesize gets provided several times, the last set value is used (last one wins, as per usual).

Examples, bestie:

curl --max-filesize 100K https://example.com
curl --max-filesize 2.6M https://example.com

See also --limit-rate. ๐ŸŽ€

  • --max-redirs <num> โ€” (HTTP) This sets the max number of redirections curl will follow. When --location or --follow are in play, it's the thing stopping curl from chasing redirects into infinity ๐Ÿ˜ญ. Default limit is 50 redirects, and if you set it to -1 it's unlimited (chaos mode, live your truth). If --max-redirs is provided several times, the last set value is used. Example:
curl --max-redirs 3 --location https://example.com

See also --location and --follow.

  • -m, --max-time <seconds> โ€” Sets the maximum time in seconds that you allow each transfer to take. It's the "please don't let my batch job hang for hours because the network is being slow or the link literally went down" option ๐Ÿ™ˆ. Accepts decimal values. If you turn on retrying (--retry), then the max time counter resets every time the transfer is retried. You can use --retry-max-time to cap the retry time overall. โญ The decimal value needs a dot (.) as the decimal separator โ€” not the local version, even if your locale uses another separator. No cap. If --max-time is provided several times, the last set value is used. Examples:
curl --max-time 10 https://example.com
curl --max-time 2.92 https://example.com

See also --connect-timeout and --retry-max-time.

  • --metalink โ€” Okay so this option used to specify a Metalink resource. Metalink support is disabled in curl for security reasons (added in 7.78.0). It's giving deprecated icon ๐Ÿ’€. If --metalink is provided several times, the last set value is used. Example:
curl --metalink file https://example.com

See also --parallel.

  • --mptcp โ€” Turns on Multipath TCP (MPTCP) for connections. MPTCP is an extension to standard TCP that lets you run multiple TCP streams over different network paths between the same source and destination. Result? More bandwidth and better reliability, because it's using multiple paths at the same time, main character energy ๐Ÿ”ฅ. MPTCP is a whole win in networks where multiple paths exist between clients and servers โ€” think mobile networks where your device flips between WiFi and cellular data, or wired networks with multiple Internet Service Providers. Currently this is only supported on Linux, starting from kernel 5.6. And heads up: only TCP connections are modified, so this option does not affect HTTP/3 (QUIC) or UDP connections, ngl. The server curl connects to also has to support MPTCP. If it doesn't, the connection seamlessly falls back to TCP โ€” no drama ๐Ÿฆ‹. Providing --mptcp multiple times has no extra effect. Disable it again with --no-mptcp. Example:
curl --mptcp https://example.com

Added in 8.9.0. See also --tcp-fastopen.

  • --negotiate โ€” (HTTP) Enables Negotiate (SPNEGO) authentication โœจ. This one requires a library built with GSS-API or SSPI support. Use --version to see if your curl supports GSS-API/SSPI or SPNEGO. When you use this option, you must also provide a fake --user option to activate the authentication code properly. Sending '-u :' is enough, because the username and password from --user aren't actually used. Weird little ritual, but it's required ๐Ÿ’…. Providing --negotiate multiple times has no extra effect. Disable it again with --no-negotiate. Example:
curl --negotiate -u : https://example.com

See also --basic, --ntlm, --anyauth and --proxy-negotiate.

  • -n, --netrc โ€” Makes curl scan the .netrc file in the user's home directory for login name and password ๐Ÿ”. Typically this is used for FTP on Unix. If used with HTTP, curl enables user authentication. See netrc(5) and ftp(1) for details on the file format. Curl does not complain if that file doesn't have the right permissions (it should be neither world- nor group-readable) โ€” so like, check that yourself bestie, curl is not gonna nag you ๐Ÿซถ. The environment variable "HOME" is used to find the home directory. If the "NETRC" environment variable is set, that filename is used as the netrc file. (Added in 8.16.0) If --netrc-file is used, that overrides all other ways to figure out the file. The netrc file provides credentials for a hostname, independent of which protocol and port number are used. On Windows, two filenames in the home directory are checked: .netrc and _netrc, preferring the former. Older versions on Windows checked for _netrc only. A quick and simple example of how to set up a .netrc to let curl access the machine host.example.com with username "myself" and password "secret" could look similar to:
machine host.example.com
login myself
password secret

curl also supports the "default" keyword. This is the same as machine name except that default matches any name. There can be only one "default" token, and it must be after all machine tokens. When providing a username in the URL and a .netrc file, curl looks for the password for that specific user for the given host, if such an entry appears in the file before a "generic" machine entry without login specified. Providing --netrc multiple times has no extra effect. Disable it again with --no-netrc. Example:

curl --netrc https://example.com

This option is mutually exclusive with --netrc-file and --netrc-optional. See also --netrc-file, --config and --user.

  • --netrc-file <filename> โ€” Sets the netrc file to use. Similar to --netrc, except you also provide the path (absolute or relative) yourself ๐Ÿ’–. It abides by --netrc-optional if specified. If --netrc-file is provided several times, the last set value is used. Example:
curl --netrc-file netrc https://example.com

This option is mutually exclusive with --netrc. See also --netrc, --user and --config.

  • --netrc-optional โ€” Similar to --netrc, but this option makes the .netrc usage optional instead of mandatory like the --netrc option does. So if the file's not there, it's chill, no cap ๐ŸŒธ. Providing --netrc-optional multiple times has no extra effect. Disable it again with --no-netrc-optional. Example:
curl --netrc-optional https://example.com

This option is mutually exclusive with --netrc. See also --netrc-file.

  • -:, --next โ€” Uses a separate operation for the following URL and associated options ๐ŸŽ€. This lets you send several URL requests, each with their own specific options โ€” like different usernames, or custom requests for each one. Obsessed honestly. --next resets all local options and only the global ones keep their values across to the operation following the --next instruction. The global options include --verbose, --trace, --trace-ascii and --fail-early. For example, you can do both a GET and a POST in a single command line:
curl www1.example.com --next -d postthis www2.example.com

--next can be used several times in a command line. Examples:

curl https://example.com --next -d postthis www2.example.com
curl -I https://example.com --next https://example.net/

See also --parallel and --config.

  • --no-alpn โ€” (HTTPS) Disables the ALPN TLS extension ๐Ÿšซ. ALPN is enabled by default if libcurl was built with an SSL library that supports ALPN, and ALPN is what a libcurl that supports HTTP/2 uses to negotiate HTTP/2 support with the server during https sessions. Note that this is the negated option name documented. You can use --alpn to enable ALPN. Providing --no-alpn multiple times has no extra effect. Disable it again with --alpn. Example:
curl --no-alpn https://example.com

For --no-alpn to work, it requires that the underlying libcurl is built to support TLS. See also --no-npn and --http2.

  • -N, --no-buffer โ€” Disables the buffering of the output stream ๐Ÿ’œ. In normal work situations, curl uses a standard buffered output stream, which has the effect that it outputs the data in chunks โ€” not necessarily exactly when the data arrives. Using this option disables that buffering, so it's giving instant gratification instead. Note that this is the negated option name documented. You can use --buffer to enable buffering again. Providing --no-buffer multiple times has no extra effect. Disable it again with --buffer. Example:
curl --no-buffer https://example.com

See also --progress-bar.

  • --no-clobber โ€” When used together with the --output, --remote-header-name, --remote-name, or --remote-name-all options, curl avoids overwriting files that already exist ๐Ÿ™…โ€โ™€๏ธ. Instead, a dot and a number gets appended to the name of the file that would be created, up to filename.9999, after which it does not create any file at all. Brutal but fair. Starting in curl 8.23.0, if the target filename uses an extension, curl instead creates the new filename by inserting -[num] before the extension. So downloading to "image.jpg" with --no-clobber, curl first tries to save it as "image-1.jpg" then "image-2.jpg" etc. Cute โœจ. Note that this is the negated option name documented. You can thus use --clobber to enforce the clobbering, even if --remote-header-name is specified.
Careful bestie: the --continue-at option cannot be used together with --no-clobber. ๐Ÿ’€

Providing --no-clobber multiple times has no extra effect. Disable it again with --clobber. Example:

curl --no-clobber --output local/dir/file https://example.com

Added in 7.83.0. See also --output and --remote-name.

  • --no-keepalive โ€” turns off the keepalive messages on the TCP connection. lowkey important: curl turns them on by default, so this is you saying "nah, no heartbeat pings bestie" ๐Ÿ’ค

heads up, this is the negated option name that's documented โ€” so you can flip it back with --keepalive to force keepalive on again.

passing --no-keepalive a bunch of times does literally nothing extra. undo it with --keepalive.

Example:

curl --no-keepalive https://example.com

See also --keepalive-time and --keepalive-cnt.

  • --no-npn โ€” (HTTPS) okay so plot twist: curl never uses NPN, so this option has zero effect (added in 7.86.0) ๐Ÿ™ˆ

the actual description: disables the NPN TLS extension. NPN is enabled by default if libcurl was built with an SSL library that supports NPN. And NPN is what a libcurl with HTTP/2 support uses to negotiate HTTP/2 support with the server during https sessions.

passing --no-npn multiple times has no extra effect. turn it back off with --npn.

Example:

curl --no-npn https://example.com

for --no-npn to work, it requires that the underlying libcurl is built to support TLS. See also --no-alpn and --http2.

  • --no-progress-meter โ€” switches OFF the progress meter output without muting or otherwise touching warning and informational messages the way --silent does. so you still get the tea, just not the little spinning bar โœจ

note that this is the negated option name documented. you can thus use --progress-meter to turn the progress meter back on.

providing --no-progress-meter multiple times has no extra effect. disable it again with --progress-meter.

Example:

curl --no-progress-meter -o store https://example.com

Added in 7.67.0. See also --verbose and --silent.

  • --no-sessionid โ€” (TLS) disables curl's use of SSL session-ID caching. by default all transfers happen using the cache. and yeah, nothing should ever get hurt by attempting to reuse SSL session-IDs, but there seem to be broken SSL implementations out in the wild that may require you to disable this in order for you to succeed ๐Ÿ˜ญ so likeโ€ฆ it's them, not you.

note that this is the negated option name documented. you can thus use --sessionid to enforce session-ID caching.

providing --no-sessionid multiple times has no extra effect. disable it again with --sessionid.

Example:

curl --no-sessionid https://example.com

See also --insecure.

  • --noproxy <no-proxy-list> โ€” a comma-separated list of hosts that should not go through a proxy, if one is specified. the only wildcard is a single * character, which matches all hosts and effectively disables the proxy entirely ๐Ÿšซ

each name in the list is matched as either a domain that contains the hostname, or the hostname itself. for example, "local.com" would match "local.com", "local.com:80", and "www.local.com", but not "www.notlocal.com".

to use international hostnames in this list, add the punycode version of the hostname.

this option overrides the environment variables that disable the proxy ("no_proxy" and "NO_PROXY"). if there's an environment variable disabling a proxy, you can set the no proxy list to "" to override it.

IP addresses given to this option can use CIDR notation (added in 7.86.0): an appended slash and number specifies the number of network bits out of the address to use in the comparison. so "192.168.0.0/16" would match all addresses starting with "192.168" ๐ŸŽฏ

if --noproxy is provided several times, the last set value is the one that's used.

Example:

curl --noproxy "www.example" https://example.com

See also --proxy.

  • --ntlm โ€” (HTTP) use NTLM authentication. the NTLM auth method was designed by Microsoft and is used by IIS web servers. it's a proprietary protocol, reverse-engineered by clever people and implemented in curl based on their efforts ๐Ÿ‘‘

and ok, real talk: this kind of behavior should not be endorsed โ€” you should encourage everyone who uses NTLM to switch to a public and documented authentication method instead, such as Digest. periodt.

if you want NTLM for your proxy authentication, use --proxy-ntlm instead.

providing --ntlm multiple times has no extra effect. disable it again with --no-ntlm.

Example:

curl --ntlm -u user:password https://example.com

for --ntlm to work, it requires that the underlying libcurl is built to support TLS. See also --proxy-ntlm.

  • --ntlm-wb โ€” (HTTP) deprecated option (added in 8.8.0). it's giving "we don't do this anymore" ๐Ÿ’€

it enabled NTLM much in the style --ntlm does, but handed the authentication over to a separate executable that got executed when needed.

providing --ntlm-wb multiple times has no extra effect.

Example:

curl --ntlm-wb -u user:password https://example.com

See also --ntlm and --proxy-ntlm.

  • --oauth2-bearer <token> โ€” (IMAP LDAP POP3 SMTP HTTP) specifies the Bearer Token for OAUTH 2.0 server authentication. the Bearer Token is used together with the username, which you can specify as part of the --url or --user options ๐Ÿ”‘

the Bearer Token and username are formatted according to RFC 6750.

if --oauth2-bearer is provided several times, the last set value is used.

Example:

curl --oauth2-bearer "mF_9.B5f-4.1JqM" https://example.com

See also --basic, --ntlm and --digest.

  • --out-null โ€” discards ALL response output of a transfer, silently. this is the more efficient and portable version of
curl https://host.example -o /dev/null

the transfer still happens in full โ€” all data is received and checked โ€” but the bytes just aren't written anywhere ๐Ÿซฅ iconic minimalism.

--out-null is associated with a single URL. use it once per URL when you use several URLs in a command line.

Example:

curl "https://example.com" --out-null

Added in 8.16.0. See also --output, --remote-name, --remote-name-all and --remote-header-name.

  • -o, --output <file> โ€” writes output to the given file instead of stdout ๐Ÿ“

if you're using globbing in the URL to fetch multiple documents, you should quote the URL, and you can use # followed by a number in the filename. that variable gets replaced with the current glob text. like in:

curl "http://{one,two}.example.com" -o "file_#1.txt"

or use several variables like:

curl "http://{site,host}.host[1-5].example" -o "#1_#2"

you may use this option as many times as the number of URLs you have. for example, if you specify two URLs on the same command line, you can use it like this:

curl -o aa example.com -o bb example.net

and the order of the -o options and the URLs does not matter โ€” only that the first -o is for the first URL and so on. so the above command line can also be written as

curl example.com example.net -o aa -o bb

see also the --create-dirs option to create the local directories dynamically. specifying the output as - (a single dash) passes the output to stdout.

to suppress response bodies, you can redirect output to /dev/null:

curl example.com -o /dev/null

or for Windows:

curl example.com -o nul

or, even more efficient and portable, use

curl example.com --out-null

specify the filename as a single minus to force the output to stdout, to override curl's internal binary output in terminal prevention:

curl https://example.com/jpeg -o -

note that the binary output may be caused by the response being compressed, in which case you may want to use the --compressed option.

since curl 8.21.0, the separate globbing parts can be named and referenced by their names ๐ŸŽ€ the case sensitive alphanumeric name is set enclosed within angle brackets after the opening character. examples:

curl "https://fun.example/{<num>one,two}.jpg" -o "save-#<num>"
curl "ftp://ftp.example/file[<range>1-100].txt" \
  -o "save-#<range>.txt"

referencing a named glob that is not set causes an error โš ๏ธ

since curl 8.21.0, you can use parts of the upload filename when it uses globbing by setting a glob name and referencing it the same way you reference named URL globs. for example, if you upload three files to a single fixed HTTP URL and want to save the corresponding responses in separate files:

curl -T 'file{<num>1,2,3}' \
  https://upload.example/ -o 'response-#<num>'

--output is associated with a single URL. use it once per URL when you use several URLs in a command line.

Examples:

curl -o file https://example.com
curl "http://{one,two}.example.com" -o "file_#1.txt"
curl "http://{site,host}.host[1-5].example" -o "#1_#2"
curl -o file https://example.com -o file2 https://example.net

See also --out-null, --remote-name, --remote-name-all, --remote-header-name and --compressed.

  • --output-dir <dir> โ€” specifies the directory where files get stored, when --remote-name or --output are used ๐Ÿ“

the given output directory is used for all URLs and output options on the command line, up until the first --next.

if the specified target directory doesn't exist, the operation fails unless --create-dirs is also used.

the specified output directory is prepended to the destination filename that would otherwise be used, including any directory component. no attempt is made to neutralize "../" sequences or similar constructs in the resulting path ๐Ÿ‘€ so yeah, be normal about it.

if --output-dir is provided several times, the last set value is used.

Examples:

curl --output-dir "tmp" -O https://example.com
curl --output-dir "tmp" -o filename.html https://example.com

Added in 7.73.0. See also --remote-name and --remote-header-name.

  • -Z, --parallel โ€” makes curl do all transfers in parallel instead of the regular serial manner ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ parallel transfer means curl runs up to N concurrent transfers simultaneously, and if there are more than N transfers to handle, it starts new ones when earlier transfers finish. main character scheduling energy fr.

Okay so real quick on the parallel progress meter: it does not look like the serial one, bestie. With parallel transfers the meter output is different from when you're doing serial transfers, because it displays the transfer status for multiple transfers all on a single line. cute and efficient ๐Ÿ’…

The max amount of concurrent transfers is set with --parallel-max, and it defaults to 50.

This option is global and does not need to be specified for each use of --next. ๐Ÿซถ

Passing --parallel multiple times has no extra effect. Turn it off again with --no-parallel.

Example:

curl --parallel https://example.com -o file1 https://example.com -o file2

Added in 7.66.0. See also --next, --verbose, --parallel-max and --parallel-immediate.

  • --parallel-immediate โ€” when you're doing parallel transfers, this tells curl to prefer opening up more connections in parallel right away instead of waiting to see if new transfers can be tacked on as multiplexed streams over another connection. โšก

By default, without this option set, curl prefers to wait a little and multiplex new transfers over existing connections. It keeps the number of connections low โ€” at the expense of risking a slightly slower transfer startup. trade-offs, we love them ๐Ÿ™ˆ

This option is global and does not need to be specified for each use of --next.

Passing --parallel-immediate multiple times has no extra effect. Turn it off again with --no-parallel-immediate.

Example:

curl --parallel-immediate -Z https://example.com -o file1 https://example.com -o file2

Added in 7.68.0. See also --parallel and --parallel-max.

  • --parallel-max <num> โ€” when you've asked for parallel transfers with --parallel, this controls the maximum amount of transfers done simultaneously. ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ

The default is 50. 65535 is the largest supported value.

This option is global and does not need to be specified for each use of --next.

If --parallel-max is provided several times, the last set value is used.

Example:

curl --parallel-max 100 -Z https://example.com ftp://example.com/

Added in 7.66.0. See also --parallel and --parallel-max-host.

  • --parallel-max-host <num> โ€” when parallel transfers are on (that's --parallel), this caps the maximum amount of concurrent connections curl is allowed to make to the same target โ€” same protocol + hostname + port number. ๐ŸŽฏ

The limit is enforced by libcurl and things get queued "internally", which means transfers that are waiting for an available connection still look like started transfers in the progress meter. (so the meter is lowkey lying to you, but like, on purpose ๐Ÿ’€)

The default is 0 (unlimited). 65535 is the largest supported value.

This option is global and does not need to be specified for each use of --next.

If --parallel-max-host is provided several times, the last set value is used.

Example:

curl --parallel-max-host 5 -Z https://example.com ftp://example.com/

Added in 8.16.0. See also --parallel and --parallel-max.

  • --pass <phrase> โ€” (TLS SCP SFTP) the passphrase for the private key used for SSH or TLS. ๐Ÿ”‘๐Ÿคซ

If --pass is provided several times, the last set value is used.

Example:

curl --pass secret --key file https://example.com

See also --key and --user.

  • --path-as-is โ€” do not handle sequences of /../ or /./ in the given URL path. Normally curl squashes or merges them according to standards, but with this option set you're telling it nope, leave my path exactly as I typed it. ๐Ÿ˜คโœจ

Passing --path-as-is multiple times has no extra effect. Turn it off again with --no-path-as-is.

Example:

curl --path-as-is https://example.com/../../etc/passwd

See also --request-target.

  • --pinnedpubkey <hashes> โ€” (TLS) use the specified public key file (or hashes) to verify the peer. This can be a path to a file containing a single public key in PEM or DER format, or any number of base64 encoded sha256 hashes preceded by 'sha256//' and separated by ';'. ๐Ÿ”

When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. A public key is extracted from this certificate, and if it does not exactly match the public key you provided to this option, curl aborts the connection before sending or receiving any data. no cap, it just leaves ๐Ÿšช๐Ÿ’จ

This option is independent of --insecure. If you use both options together, the peer is still verified by public key.

PEM/DER support:

OpenSSL and GnuTLS, wolfSSL, mbedTLS, Schannel

sha256 support:

OpenSSL, GnuTLS and wolfSSL, mbedTLS, Schannel

Other SSL backends not supported.

If --pinnedpubkey is provided several times, the last set value is used.

Examples:

curl --pinnedpubkey keyfile https://example.com
curl --pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com

See also --hostpubsha256.

  • --post301 โ€” (HTTP) respect RFC 7231/6.4.2 and do not convert POST requests into GET requests when following a 301 redirect. The non-RFC behavior is literally everywhere in web browsers, so curl does the conversion by default to maintain consistency. A server may require a POST to stay a POST after such a redirection. ๐Ÿซก

This option is meaningful only when using --location.

Passing --post301 multiple times has no extra effect. Turn it off again with --no-post301.

Example:

curl --post301 --location -d "data" https://example.com

See also --post302, --post303 and --location.

  • --post302 โ€” (HTTP) respect RFC 7231/6.4.3 and do not convert POST requests into GET requests when following a 302 redirect. The non-RFC behavior is ubiquitous in web browsers, so curl converts by default to keep things consistent. A server may require a POST to remain a POST after such a redirection. ๐ŸŒธ

This option is meaningful only when using --location.

Passing --post302 multiple times has no extra effect. Turn it off again with --no-post302.

Example:

curl --post302 --location -d "data" https://example.com

See also --post301, --post303 and --location.

  • --post303 โ€” (HTTP) violate RFC 7231/6.4.4 and do not convert POST requests into GET requests when following a 303 redirect. yes bestie, this one is literally called out as violating the RFC, we're being rebels ๐Ÿ™ˆ A server may require a POST to remain a POST after a 303 redirection.

This option is meaningful only when using --location.

Passing --post303 multiple times has no extra effect. Turn it off again with --no-post303.

Example:

curl --post303 --location -d "data" https://example.com

See also --post302, --post301 and --location.

  • --preproxy <[protocol://]host[:port]> โ€” use the specified SOCKS proxy before connecting to an HTTP or HTTPS --proxy. So curl first connects to the SOCKS proxy, and then connects (through SOCKS) to the HTTP or HTTPS proxy. Hence pre proxy. ๐Ÿง…๐Ÿง…

The pre proxy string should be specified with a "protocol://" prefix to specify alternative proxy protocols. Use "socks4://", "socks4a://", "socks5://" or "socks5h://" to request the specific SOCKS version to be used. No protocol specified makes curl default to SOCKS4.

If the port number is not specified in the proxy string, it is assumed to be 1080.

User and password that might be provided in the proxy string are URL decoded by curl. This lets you pass in special characters such as @ by using %40, or pass in a colon with %3a. ๐Ÿ’…

If --preproxy is provided several times, the last set value is used.

Example:

curl --preproxy socks5://proxy.example -x http://http.example https://example.com

See also --proxy and --socks5.

  • -#, --progress-bar โ€” make curl display transfer progress as a simple progress bar instead of the standard, more informational, meter. ๐Ÿ“Š

This progress bar draws a single line of '#' characters across the screen and shows a percentage if the transfer size is known. For transfers without a known size, there's a space ship (-=o=-) that moves back and forth โ€” but only while data is being transferred โ€” with a set of flying hash sign symbols on top. ๐Ÿš€ iconic behavior honestly

This option is global and does not need to be specified for each use of --next.

Passing --progress-bar multiple times has no extra effect. Turn it off again with --no-progress-bar.

Example:

curl -# -O https://example.com

See also --styled-output.

  • --proto <protocols> โ€” limit what protocols are allowed for transfers. Protocols are evaluated left to right, are comma separated, and are each a protocol name or 'all', optionally prefixed by a modifier. The available modifiers are:
    • + โ€” permit this protocol in addition to protocols already permitted (this is the default if no modifier is used).
    • - โ€” deny this protocol, removing it from the list of protocols already permitted.
    • = โ€” permit only this protocol (ignoring the list already permitted), though subject to later modification by subsequent entries in the comma separated list.

For example: --proto -ftps uses the default protocols, but disables ftps

--proto -all,https,+http only enables http and https

--proto =http,https also only enables http and https

Unknown and disabled protocols produce a warning. This allows scripts to safely rely on being able to disable potentially dangerous protocols, without relying upon support for that protocol being built into curl to avoid an error. ๐Ÿ›ก๏ธ

This option can be used multiple times, in which case the effect is the same as concatenating the protocols into one instance of the option.

If --proto is provided several times, the last set value is used.

Example:

curl --proto =http,https,sftp https://example.com

See also --proto-redir and --proto-default.

  • --proto-default <protocol> โ€” use protocol for any provided URL missing a scheme. The case-insensitive name should be given without any "://" suffix. โœจ

An unknown or unsupported protocol causes error CURLE_UNSUPPORTED_PROTOCOL. ๐Ÿ˜ญ

This option does not change the default proxy protocol (http), just so weโ€™re clear. โœจ

If you donโ€™t set this option, curl guesses the protocol based on the hostname โ€” see --url for the deets.

The default protocol cannot be set to "ipfs" or "ipns". Those schemes have to be used explicitly in the URL, no cap.

If --proto-default is provided several times, the last set value is used.

Example:

curl --proto-default https ftp.example.com

See also --proto and --proto-redir.

  • --proto-redir <protocols> โ€” Limit what protocols are allowed on redirects. Protocols denied by --proto are not overridden by this option. See --proto for how protocols are represented.

Example, allow only HTTP and HTTPS on redirect:

curl --proto-redir -all,http,https --follow http://example.com

By default curl only allows HTTP, HTTPS, FTP and FTPS on redirects. Specifying all or +all enables all protocols on redirects, which is highkey not good for security. ๐Ÿšจ

If --proto-redir is provided several times, the last set value is used.

Example:

curl --proto-redir =http,https --follow https://example.com

See also --proto and --follow.

  • -x, --proxy <[protocol://]host[:port]> โ€” Use the specified proxy.

The proxy string can be specified with a "protocol://" prefix. If no protocol is specified or itโ€™s http://, itโ€™s treated as an HTTP proxy. Use "socks4://", "socks4a://", "socks5://" or "socks5h://" to request a specific SOCKS version to be used.

Unix domain sockets are supported for socks proxy. Set localhost for the host part. e.g. socks5h://localhost/path/to/socket.sock

HTTPS proxy support works with the "https://" protocol prefix for OpenSSL and GnuTLS. It also works for mbedTLS, Rustls, Schannel and wolfSSL (added in 7.87.0).

Unrecognized and unsupported proxy protocol schemes cause an error.

If the port number is not specified in the proxy string, it is assumed to be 1080.

This option overrides existing environment variables that set the proxy to use. If there is an environment variable setting a proxy, you can set proxy to "" to override it.

All operations that are performed over an HTTP proxy are transparently converted to HTTP. It means that certain protocol specific operations might not be available. This is not the case if you can tunnel through the proxy, as one with the --proxytunnel option.

User and password that might be provided in the proxy string are URL decoded by curl. This allows you to pass in special characters such as @ by using %40 or pass in a colon with %3a.

The proxy host can be specified the same way as the proxy environment variables, including the protocol prefix ("http://") and the embedded user + password.

When a proxy is used, the active FTP mode as set with --ftp-port, cannot be used.

Doing FTP over an HTTP proxy without --proxytunnel makes curl do HTTP with an FTP URL over the proxy. For such transfers, common FTP specific options do not work, including --ssl-reqd and --ftp-ssl-control.

If --proxy is provided several times, the last set value is used.

Example:

curl --proxy http://proxy.example https://example.com

See also --socks5 and --proxy-basic.

  • --proxy-anyauth โ€” Automatically pick a suitable authentication method when communicating with the given HTTP proxy. This might cause an extra request/response round-trip. ๐Ÿซถ

Example:

curl --proxy-anyauth --proxy-user user:passwd -x proxy https://example.com

See also --proxy, --proxy-basic and --proxy-digest.

  • --proxy-basic โ€” Use HTTP Basic authentication when communicating with the given proxy. Use --basic for enabling HTTP Basic with a remote host. Basic is the default authentication method curl uses with proxies. ๐Ÿ’…

Providing --proxy-basic multiple times has no extra effect. Disable it again with --no-proxy-basic.

Example:

curl --proxy-basic --proxy-user user:passwd -x proxy https://example.com

See also --proxy, --proxy-anyauth and --proxy-digest.

  • --proxy-ca-native โ€” (TLS) Use the operating systemโ€™s native CA store for certificate verification of the HTTPS proxy. ๐ŸŒˆ

This option is independent of other HTTPS proxy CA certificate locations set at run time or build time. Those locations are searched in addition to the native CA store.

Equivalent to --ca-native but used in HTTPS proxy context. Refer to --ca-native for TLS backend limitations.

Providing --proxy-ca-native multiple times has no extra effect. Disable it again with --no-proxy-ca-native.

Example:

curl --proxy-ca-native https://example.com

Added in 8.2.0. See also --ca-native, --cacert, --capath, --dump-ca-embed and --insecure.

  • --proxy-cacert <file> โ€” Use the specified certificate file to verify the HTTPS proxy. The file may contain multiple CA certificates. The certificate(s) must be in PEM format. ๐ŸŽ€

This allows you to use a different trust for the proxy compared to the remote server connected to via the proxy.

Equivalent to --cacert but used in HTTPS proxy context.

If --proxy-cacert is provided several times, the last set value is used.

Example:

curl --proxy-cacert CA-file.txt -x https://proxy.example https://example.com

See also --proxy-capath, --cacert, --capath, --dump-ca-embed and --proxy.

  • --proxy-capath <dir> โ€” Same as --capath but used in HTTPS proxy context. ๐ŸŒธ

Use the specified certificate directory to verify the proxy. Multiple paths can be provided by separating them with colon (:) (e.g. "path1:path2:path3"). The certificates must be in PEM format, and if curl is built against OpenSSL, the directory must have been processed using the c_rehash utility supplied with OpenSSL. Using --proxy-capath can allow OpenSSL-powered curl to make SSL-connections much more efficiently than using --proxy-cacert if the --proxy-cacert file contains many CA certificates.

If this option is set, the default capath value is ignored.

If --proxy-capath is provided several times, the last set value is used.

Example:

curl --proxy-capath /local/directory -x https://proxy.example https://example.com

See also --proxy-cacert, --proxy, --capath and --dump-ca-embed.

  • --proxy-cert <cert[:passwd]> โ€” Use the specified client certificate file when communicating with an HTTPS proxy. The certificate must be PEM format. If the optional password is not specified, it is queried for on the terminal. Use --proxy-key to provide the private key. ๐Ÿ”ฅ

This option is the equivalent to --cert but used in HTTPS proxy context.

If --proxy-cert is provided several times, the last set value is used.

Example:

curl --proxy-cert file -x https://proxy.example https://example.com

See also --proxy, --proxy-key and --proxy-cert-type.

  • --proxy-cert-type <type> โ€” Set type of the provided client certificate when using HTTPS proxy. PEM, DER, ENG, PROV and P12 are recognized types. ๐Ÿฆ‹

The default type depends on the TLS backend and is usually PEM. For Schannel it is P12. If --proxy-cert is a pkcs11: URI then ENG or PROV is the default type (depending on OpenSSL version).

Equivalent to --cert-type but used in HTTPS proxy context.

If --proxy-cert-type is provided several times, the last set value is used.

Example:

curl --proxy-cert-type PEM --proxy-cert file -x https://proxy.example https://example.com

See also --proxy-cert and --proxy-key.

  • --proxy-ciphers <list> โ€” (TLS) Same as --ciphers but used in HTTPS proxy context. ๐Ÿ’œ

Specify which cipher suites to use in the connection to your HTTPS proxy when it negotiates TLS 1.2 (1.1, 1.0). The list of ciphers suites must specify valid ciphers. Read up on cipher suite details on this URL:

https://curl.se/docs/ssl-ciphers.html

If --proxy-ciphers is provided several times, the last set value is used.

Example:

curl --proxy-ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256 -x https://proxy.example https://example.com

See also --proxy-tls13-ciphers, --ciphers and --proxy.

  • --proxy-crlfile <file> โ€” Provide filename for a PEM formatted file with a Certificate Revocation List that specifies peer certificates that are considered revoked when communicating with an HTTPS proxy. ๐ŸŽ€

Equivalent to --crlfile but only used in HTTPS proxy context.

If --proxy-crlfile is provided several times, the last set value is used.

Example:

curl --proxy-crlfile rejects.txt -x https://proxy.example https://example.com

See also --crlfile and --proxy.

  • --proxy-digest โ€” Use HTTP Digest authentication when communicating with the given proxy. Use --digest for enabling HTTP Digest with a remote host. โœจ

Providing --proxy-digest multiple times has no extra effect. Disable it again with --no-proxy-digest.

Example:

curl --proxy-digest --proxy-user user:passwd -x proxy https://example.com

See also --proxy, --proxy-anyauth and --proxy-basic.

  • --proxy-header <header/@file> โ€” (HTTP) Extra header to include in the request when sending HTTP to a proxy. You may specify any number of extra headers. This is the equivalent option to --header but is for proxy communication only like in CONNECT requests when you want a separate header sent to the proxy to what is sent to the actual remote host. ๐Ÿ‘‘

curl makes sure that each header you add/replace is sent with the proper end-of-line marker, you should thus not add that as a part of the header content: do not add newlines or carriage returns, they only mess things up for you.

Headers specified with this option are not included in requests that curl knows are not to be sent to a proxy.

This option can take an argument in @filename style, which then adds a header for each line in the input file. Using @- makes curl read the headers from stdin.

Ok so continuing with --proxy-header โ€” this one is a stacker: you can drop it multiple times in one command line to add, replace, or remove multiple headers. Obsessed with the flexibility.

Examples, because seeing it > explaining it:

curl --proxy-header "X-First-Name: Joe" -x http://proxy https://example.com
curl --proxy-header "User-Agent: surprise" -x http://proxy https://example.com
curl --proxy-header "Host:" -x http://proxy https://example.com

See also --proxy and --header.

  • --proxy-http2 โ€” (HTTP) negotiate HTTP/2 with an HTTPS proxy. Lowkey important: the proxy might still only offer HTTP/1, and in that case curl just sticks to using that version. No drama.

This has no effect for any other kinds of proxies โ€” HTTPS proxy only, bestie.

This option is mutually exclusive with --proxy-http3.

Providing --proxy-http2 multiple times has no extra effect. Disable it again with --no-proxy-http2.

Example:

curl --proxy-http2 -x proxy https://example.com

For --proxy-http2 to work, it requires that the underlying libcurl is built to support HTTP/2. This option is mutually exclusive with --proxy-http3. Added in 8.1.0. See also --proxy.

  • --proxy-http3 โ€” (HTTP) negotiate HTTP/3 with an HTTPS proxy. Fr fr, it fails to perform the transfer if the given proxy does not support HTTP/3. No fallback, no mercy.

This has no effect for any other kinds of proxies.

This option is mutually exclusive with --proxy-http2.

This feature is experimental and requires a build with HTTP/3 proxy support enabled. For autotools builds, use --enable-proxy-http3. For CMake builds, use -DUSE_PROXY_HTTP3=ON.

Providing --proxy-http3 multiple times has no extra effect. Disable it again with --no-proxy-http3.

Example:

curl --proxy-http3 -x proxy https://example.com

For --proxy-http3 to work, it requires that the underlying libcurl is built to support HTTP/3. This option is mutually exclusive with --proxy-http2. Added in 8.21.0. See also --proxy and --proxy-http2.

  • --proxy-insecure โ€” literally --insecure but for the HTTPS proxy context. Same energy, proxy edition ๐Ÿ’…

So here's the tea: every secure connection curl makes gets verified before the transfer takes place. This option makes curl skip the verification step with a proxy and proceed without checking. Yep, just vibes.

When this option is not used for a proxy using HTTPS, curl verifies the proxy's TLS certificate before it continues: that the certificate contains the right name which matches the hostname, and that the certificate has been signed by a CA certificate present in the cert store. See this online resource for further details: https://curl.se/docs/sslcerts.html

WARNING: using this option makes the transfer to the proxy insecure. Like, that's the whole point of it and also the whole problem ๐Ÿซ 

Providing --proxy-insecure multiple times has no extra effect. Disable it again with --no-proxy-insecure.

Example:

curl --proxy-insecure -x https://proxy.example https://example.com

See also --proxy and --insecure.

  • --proxy-key <key> โ€” specify the filename for your private key when you're doing client certificates with your HTTPS proxy. It's the equivalent of --key but used in HTTPS proxy context.

If --proxy-key is provided several times, the last set value is used.

Example:

curl --proxy-key here -x https://proxy.example https://example.com

See also --proxy-key-type and --proxy.

  • --proxy-key-type <type> โ€” tells curl what private key file type the key you gave to --proxy-key actually uses. DER, PEM, and ENG are supported. If you don't specify, PEM is assumed.

Equivalent to --key-type but used in HTTPS proxy context.

If --proxy-key-type is provided several times, the last set value is used.

Example:

curl --proxy-key-type DER --proxy-key here -x https://proxy.example https://example.com

See also --proxy-key and --proxy.

  • --proxy-negotiate โ€” use HTTP Negotiate (SPNEGO) authentication when communicating with the given proxy. Use --negotiate if you wanna enable HTTP Negotiate (SPNEGO) with a remote host instead โ€” different thing, don't mix them up โœจ

Providing --proxy-negotiate multiple times has no extra effect.

Example:

curl --proxy-negotiate --proxy-user user:passwd -x proxy https://example.com

See also --proxy-anyauth, --proxy-basic and --proxy-service-name.

  • --proxy-ntlm โ€” use HTTP NTLM authentication when talking to the given proxy. Use --ntlm for enabling NTLM with a remote host.

Providing --proxy-ntlm multiple times has no extra effect. Disable it again with --no-proxy-ntlm.

Example:

curl --proxy-ntlm --proxy-user user:passwd -x http://proxy https://example.com

See also --proxy-negotiate, --proxy-anyauth and --proxy-user.

  • --proxy-pass <phrase> โ€” the passphrase for the private key for your HTTPS proxy client certificate.

Equivalent to --pass but used in HTTPS proxy context.

If --proxy-pass is provided several times, the last set value is used.

Example:

curl --proxy-pass secret --proxy-key here -x https://proxy.example https://example.com

See also --proxy and --proxy-key.

  • --proxy-pinnedpubkey <hashes> โ€” (TLS) use the specified public key file (or hashes) to verify the proxy. This can be a path to a file which contains a single public key in PEM or DER format, or any number of base64 encoded sha256 hashes preceded by 'sha256//' and separated by ';'.

When negotiating a TLS or SSL connection, the server sends a certificate indicating its identity. A public key is extracted from this certificate, and if it does not exactly match the public key provided to this option, curl aborts the connection before sending or receiving any data. Iconic security behaviour honestly ๐Ÿ”ฅ

Before curl 8.10.0 this option did not work due to a bug. Yeah. It was just sitting there looking pretty ๐Ÿ’€

If --proxy-pinnedpubkey is provided several times, the last set value is used.

Examples:

curl --proxy-pinnedpubkey keyfile https://example.com
curl --proxy-pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com

See also --pinnedpubkey and --proxy.

  • --proxy-service-name <name> โ€” set the service name for SPNEGO when doing proxy authentication.

If --proxy-service-name is provided several times, the last set value is used.

Example:

curl --proxy-service-name "shrubbery" -x proxy https://example.com

See also --service-name, --proxy and --proxy-negotiate.

  • --proxy-ssl-allow-beast โ€” do not work around a security flaw in the TLS1.0 protocol known as BEAST when communicating to an HTTPS proxy. If this option is not used, the TLS layer may use workarounds known to cause interoperability problems with some older server implementations.

This option only changes how curl does TLS 1.0 with an HTTPS proxy and has no effect on later TLS versions.

WARNING: this option loosens the TLS security, and by using this flag you ask for exactly that. Like, you are literally requesting it ๐Ÿ™ˆ

Equivalent to --ssl-allow-beast but used in HTTPS proxy context.

Providing --proxy-ssl-allow-beast multiple times has no extra effect. Disable it again with --no-proxy-ssl-allow-beast.

Example:

curl --proxy-ssl-allow-beast -x https://proxy.example https://example.com

See also --ssl-allow-beast and --proxy.

  • --proxy-ssl-auto-client-cert โ€” same as --ssl-auto-client-cert but used in HTTPS proxy context.

This is only supported by Schannel.

Providing --proxy-ssl-auto-client-cert multiple times has no extra effect. Disable it again with --no-proxy-ssl-auto-client-cert.

Example:

curl --proxy-ssl-auto-client-cert -x https://proxy.example https://example.com

Added in 7.77.0. See also --ssl-auto-client-cert and --proxy.

  • --proxy-tls13-ciphers <list> โ€” (TLS) same as --tls13-ciphers but used in HTTPS proxy context.

This specifies which cipher suites to use in the connection to your HTTPS proxy when it negotiates TLS 1.3. The list of cipher suites must specify valid ciphers. Read up on TLS 1.3 cipher suite details on this URL:

https://curl.se/docs/ssl-ciphers.html

This option is used when curl is built to use OpenSSL 1.1.1 or later, Schannel, wolfSSL, or mbedTLS 3.6.0 or later.

Before curl 8.10.0 with mbedTLS or wolfSSL, TLS 1.3 cipher suites were set by using the --proxy-ciphers option. History lesson, bestie ๐Ÿ“š

If --proxy-tls13-ciphers is provided several times, the last set value is used.

Example:

curl --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy https://example.com

See also --proxy-ciphers, --tls13-ciphers and --proxy.

  • --proxy-tlsauthtype <type> โ€” deprecated option. This has no functionality since 8.22.0. It's giving ghost ๐Ÿ‘ป

Set TLS authentication type with HTTPS proxy. The only supported option is "SRP", for TLS-SRP (RFC 5054). This option works only if the underlying libcurl is built with TLS-SRP support.

Equivalent to --tlsauthtype but used in HTTPS proxy context.

If --proxy-tlsauthtype is provided several times, the last set value is used.

Example:

curl --proxy-tlsauthtype SRP -x https://proxy.example https://example.com

See also --proxy, --proxy-tlsuser and --proxy-tlspassword.

  • --proxy-tlspassword <string> โ€” deprecated option. This has no functionality since 8.22.0 either. RIP ๐Ÿชฆ

Set password to use with the TLS authentication method specified with --proxy-tlsauthtype when using HTTPS proxy. Requires that --proxy-tlsuser is set.

This option does not work with TLS 1.3.

Equivalent to --tlspassword but used in HTTPS proxy context.

If --proxy-tlspassword is provided several times, the last set value is used.

Example:

curl --proxy-tlspassword passwd -x https://proxy.example https://example.com

See also --proxy and --proxy-tlsuser.

  • --proxy-tlsuser <name> โ€” deprecated option. This has no functionality since 8.22.0. Not me warning you three times in a row ๐Ÿ˜ญ

Set username for use for HTTPS proxy with the TLS authentication method specified with --proxy-tlsauthtype. Requires that --proxy-tlspassword also is set.

This option does not work with TLS 1.3.

If --proxy-tlsuser is provided several times, the last set value is used.

Example:
curl --proxy-tlsuser smith -x https://proxy.example https://example.com

See also --proxy and --proxy-tlspassword.


--proxy-tlsv1 ๐ŸŽ€

Okay so when you're negotiating with an HTTPS proxy, this one says "bestie, use at least TLS version 1.x, mmkay?" โ€” and by 1.x we mean TLS version 1.0 or higher, no exceptions. ๐Ÿ’…

It's literally the proxy-context twin of --tlsv1, just aimed at your HTTPS proxy instead of the main connection.

Passing --proxy-tlsv1 more than once? Zero extra effect, it's not a "more is more" situation. ๐Ÿ™…โ€โ™€๏ธ

Example:
curl --proxy-tlsv1 -x https://proxy.example https://example.com

See also --proxy.


-U, --proxy-user <user:password> ๐Ÿ”

This is where you hand curl the username and password for proxy authentication. Slay.

Now, if you're on a Windows SSPI-enabled curl binary and you're doing either Negotiate or NTLM authentication, you can tell curl to grab the username and password straight from your environment by passing a single colon with this option, like this: -U :.

On systems where it works, curl hides the given option argument from process listings. But listen โ€” that is not enough to protect credentials from possibly getting seen by other users on the same system, because they're still visible for a moment before being cleared. ๐Ÿ˜ญ Such sensitive data should be retrieved from a file instead or similar, and never used in clear text in a command line. Fr fr.

If --proxy-user is provided several times, the last set value is used.

Example:
curl --proxy-user smith:secret -x proxy https://example.com

See also --proxy-pass.


--proxy1.0 <host[:port]> ๐Ÿ•ฐ๏ธ

Use the specified HTTP 1.0 proxy. If the port number is not specified, it is assumed at port 1080. Periodt.

The only difference between this and the HTTP proxy option --proxy is that attempts to use CONNECT through the proxy specify an HTTP 1.0 protocol instead of the default HTTP 1.1. That's it, that's the whole flex. โœจ

Providing --proxy1.0 multiple times has no extra effect.

Example:
curl --proxy1.0 http://proxy https://example.com

See also --proxy, --socks5 and --preproxy.


-p, --proxytunnel ๐Ÿš‡

When an HTTP proxy is used with --proxy, this option makes curl tunnel the traffic through the proxy. Iconic behavior, honestly.

The tunnel approach is made with the HTTP proxy CONNECT request, and it requires that the proxy allows direct connection to the remote port number curl wants to tunnel through to. If the proxy says no, that's a whole vibe check failed. ๐Ÿ’€

To suppress proxy CONNECT response headers when curl is set to output headers, use --suppress-connect-headers.

Providing --proxytunnel multiple times has no extra effect. Disable it again with --no-proxytunnel.

Example:
curl --proxytunnel -x http://proxy https://example.com

See also --proxy.


--pubkey <key> ๐Ÿ—๏ธ

(SFTP SCP) Public key filename. Lets you provide your public key in this separate file.

Real talk though: curl attempts to automatically extract the public key from the private key file, so passing this option is generally not required. Note that this public key extraction requires libcurl to be linked against a copy of libssh2 1.2.8 or higher that is itself linked against OpenSSL. Very specific, very demure. ๐ŸŽ€

If --pubkey is provided several times, the last set value is used.

Example:
curl --pubkey file.pub sftp://example.com/

See also --pass.


-Q, --quote <command> ๐Ÿ’Œ

(FTP SFTP) Send an arbitrary command to the remote FTP or SFTP server. So extra, so useful.

Quote commands are sent BEFORE the transfer takes place โ€” immediately after the initial PWD command in an FTP transfer, to be exact. To make commands take place after a successful transfer, prefix them with a dash -.

(FTP only) To make commands be sent after curl has changed the working directory, immediately before the file transfer command(s), prefix the command with a +.

You may specify any number of commands. No cap. ๐Ÿซถ

By default curl stops at first failure. To make curl continue even if the command fails, prefix the command with an asterisk (*). Otherwise, if the server returns failure for one of the commands, the entire operation is aborted. ๐Ÿ˜ญ

You must send syntactically correct FTP commands as RFC 959 defines to FTP servers, or one of the commands listed below to SFTP servers.

SFTP is a binary protocol. Unlike for FTP, curl interprets SFTP quote commands itself before sending them to the server. Filenames must be provided within double quotes to embed spaces, backslashes, quotes or double quotes. Within double quotes the following escape sequences are available for that purpose: \\, \", and \'.

Following is the list of all supported SFTP quote commands:

  • atime date file โ€” The atime command sets the last access time of the file named by the file operand. The date expression can be all sorts of date strings, see the curl_getdate(3) man page for date expression details. (Added in 7.73.0)
  • chgrp group file โ€” The chgrp command sets the group ID of the file named by the file operand to the group ID specified by the group operand. The group operand is a decimal integer group ID.
  • chmod mode file โ€” The chmod command modifies the file mode bits of the specified file. The mode operand is an octal integer mode number.
  • chown user file โ€” The chown command sets the owner of the file named by the file operand to the user ID specified by the user operand. The user operand is a decimal integer user ID.
  • ln source_file target_file โ€” The ln and symlink commands create a symbolic link at the target_file location pointing to the source_file location.
  • mkdir directory_name โ€” The mkdir command creates the directory named by the directory_name operand.
  • mtime date file โ€” The mtime command sets the last modification time of the file named by the file operand. The date expression can be all sorts of date strings, see the curl_getdate(3) man page for date expression details. (Added in 7.73.0)
  • pwd โ€” The pwd command returns the absolute path name of the current working directory.
  • rename source target โ€” The rename command renames the file or directory named by the source operand to the destination path named by the target operand.
  • rm file โ€” The rm command removes the file specified by the file operand.
  • rmdir directory โ€” The rmdir command removes the directory entry specified by the directory operand, provided it is empty.
  • symlink source_file target_file โ€” See ln.

--quote can be used several times in a command line.

Example:
curl --quote "DELE file" ftp://example.com/foo

See also --request.


--random-file <file> ๐Ÿ—‘๏ธ

Deprecated option. This option is ignored (added in 7.84.0). Prior to that it only had an effect on curl if built to use old versions of OpenSSL.

Specify the path name to file containing random data. The data may be used to seed the random engine for SSL connections. Very "back in my day" energy, ngl. ๐Ÿ•ฐ๏ธ

If --random-file is provided several times, the last set value is used.

Example:
curl --random-file rubbish https://example.com

See also --egd-file.


-r, --range <range> โœ‚๏ธ

(HTTP FTP SFTP FILE) Retrieve a byte range (i.e. a partial document) from an HTTP/1.1, FTP or SFTP server or a local FILE. Ranges can be specified in a number of ways:

  • 0-499 โ€” specifies the first 500 bytes
  • 500-999 โ€” specifies the second 500 bytes
  • -500 โ€” specifies the last 500 bytes
  • 9500- โ€” specifies the bytes from offset 9500 and forward
  • 0-0,-1 โ€” specifies the first and last byte only(*)(HTTP)
  • 100-199,500-599 โ€” specifies two separate 100-byte ranges(*) (HTTP)

(*) = NOTE that if specifying multiple ranges and the server supports it, then it replies with a multiple part response that curl returns as-is. It contains meta information in addition to the requested bytes. Parsing or otherwise transforming this response is the responsibility of the caller. So like, that's on you, bestie. ๐Ÿ™ˆ

Only digit characters (0-9) are valid in the 'start' and 'stop' fields of the 'start-stop' range syntax. If a non-digit character is given in the range, the server's response is unspecified, depending on the server's configuration. Unspecified! Do not do this.

Many HTTP/1.1 servers do not have this feature enabled, so that when you attempt to get a range, curl instead gets the whole document. Surprise! ๐ŸŽ

FTP and SFTP range downloads only support the simple 'start-stop' syntax (optionally with one of the numbers omitted). FTP use depends on the extended FTP command SIZE.

When using this option for HTTP uploads using POST or PUT, functionality is not guaranteed. The HTTP protocol has no standard interoperable resume upload and curl uses a set of headers for this purpose that once proved working for some servers and have been left for those who find that useful. It's giving legacy, but make it work. ๐Ÿ’…

This command line option is mutually exclusive with --continue-at: you can only use one of them for a single transfer.

If --range is provided several times, the last set value is used.

Example:
curl --range 22-44 https://example.com

See also --continue-at and --append.


--rate <max request rate> ๐ŸŽš๏ธ

Specify the maximum transfer frequency you allow curl to use โ€” in number of transfer starts per time unit (sometimes called request rate). Without this option, curl starts the next transfer as fast as possible. Literally main character energy, zero chill. ๐ŸŒˆ

If given several URLs and a transfer completes faster than the allowed rate, curl waits until the next transfer is started to maintain the requested rate. This option has no effect when --parallel is used. (Parallel said "I do what I want." ๐Ÿ‘‘)

The request rate is provided as "N/U" where N is an integer number and U is a time unit. Supported units are 's' (second), 'm' (minute), 'h' (hour) and 'd' (day, as in a 24 hour unit). The default time unit, if no "/U" is provided, is number of transfers per hour.

That 10-per-minute cap means curl literally waits 6 seconds after starting the previous transfer before it even thinks about the next one. Patient queen behavior. ๐Ÿ’…

The timing math runs on millisecond resolution, but plot twist: if you set the frequency above 1000 per second, curl just goes "lol k" and runs unrestricted. ๐Ÿƒโ€โ™€๏ธ๐Ÿ’จ

When you're retrying transfers (that's --retry), the separate retry delay logic kicks in instead โ€” this setting does not apply there.

Starting in version 8.10.0 you can drop time units right into the rate expression, so "5/15s" means no more than 5 transfers per 15 seconds, and "3/4h" means 3 transfers per 4 hours. No spaces allowed, bestie. ๐Ÿšซ

This option is global and does not need to be specified for each use of --next.

If --rate is provided several times, the last set value is used.

Examples:

curl --rate 2/s https://example.com ...
curl --rate 3/h https://example.com ...
curl --rate 14/m https://example.com ...

Added in 7.84.0. See also --limit-rate and --retry-delay.


  • --raw โ€” (HTTP) When used, it disables all internal HTTP decoding of content or transfer encodings, and instead makes them passed on unaltered, raw. ๐Ÿฃ

Providing --raw multiple times has no extra effect. Disable it again with --no-raw.

Example:

curl --raw https://example.com

See also --tr-encoding.

  • -e, --referer <URL> โ€” (HTTP) Set the referrer URL in the HTTP request. You can also set this with the --header flag, of course. ๐Ÿ’Œ When used with --location you can append ";auto" to the --referer URL to make curl automatically set the previous URL when it follows a Location: header. The ";auto" string can be used alone, even if you do not set an initial --referer.

If --referer is provided several times, the last set value is used.

Examples:

curl --referer "https://fake.example" https://example.com
curl --referer "https://fake.example;auto" -L https://example.com
curl --referer ";auto" -L https://example.com

See also --user-agent and --header.

  • -J, --remote-header-name โ€” (HTTP) Tell the --remote-name option to use the server-specified Content-Disposition filename instead of extracting a filename from the URL. If the server-provided filename contains a path, that is stripped off before the filename is used. ๐Ÿท๏ธ

The file is saved in the current directory, or in the directory specified with --output-dir.

If the server specifies a filename and a file with that name already exists in the destination directory, it is not overwritten and an error occurs โ€” unless you allow it by using the --clobber option. If the server does not specify a filename then this option has no effect.

There is no attempt to decode %-sequences (yet) in the provided filename, so this option may provide you with rather unexpected filenames. ๐Ÿ™ˆ

This feature uses the name from the "filename" field, it does not yet support the "filename*" field (filenames with explicit character sets).

Starting in 8.19.0, curl falls back and uses the filename extracted from the last redirect header if no "Content-Disposition:" header provides a filename.

WARNING: Exercise judicious use of this option, especially on Windows. A rogue server could send you the name of a DLL or other file that could be loaded automatically by Windows or some third party software. ๐Ÿ˜ญ Bestie, please be careful with this one.

Providing --remote-header-name multiple times has no extra effect. Disable it again with --no-remote-header-name.

Example:

curl -OJ https://example.com/file

See also --remote-name.

  • -O, --remote-name โ€” Write output to a local file named like the remote file we get. (Only the file part of the remote file is used, the path is cut off.) โœ‚๏ธ

The file is saved in the current working directory. If you want the file saved in a different directory, make sure you change the current working directory before invoking curl with this option, or use --output-dir.

The remote filename to use for saving is extracted from the given URL, nothing else, and if it already exists it is overwritten. If you want the server to be able to choose the filename, refer to --remote-header-name which can be used in addition to this option. If the server chooses a filename and that name already exists it is not overwritten.

There is no URL decoding done on the filename. If it has %20 or other URL encoded parts of the name, they end up as-is as filename. ๐Ÿ’€

You may use this option as many times as the number of URLs you have.

Before curl 8.10.0, curl returned an error if the URL ended with a slash, which means that there is no filename part in the URL. Starting in 8.10.0, curl sets the filename to the last directory part of the URL or if that also is missing to "curl_response" (without extension) for this situation. ๐Ÿซถ

--remote-name is associated with a single URL. Use it once per URL when you use several URLs in a command line.

Examples:

curl -O https://example.com/filename
curl -O https://example.com/filename -O https://example.com/file2

See also --remote-name-all, --output-dir and --remote-header-name.

  • --remote-name-all โ€” Change the default action for all given URLs to be dealt with as if --remote-name were used for each one. If you want to disable that for a specific URL after --remote-name-all has been used, you must use "-o -" or --no-remote-name. ๐Ÿ‘‘

Providing --remote-name-all multiple times has no extra effect. Disable it again with --no-remote-name-all.

Example:

curl --remote-name-all ftp://example.com/file1 ftp://example.com/file2

See also --remote-name.

  • -R, --remote-time โ€” Make curl attempt to figure out the timestamp of the remote file that is getting downloaded, and if that is available make the local file get that same timestamp. โฐ iconic little detail, honestly.

Providing --remote-time multiple times has no extra effect. Disable it again with --no-remote-time.

Example:

curl --remote-time -o foo https://example.com

See also --remote-name and --time-cond.

  • --remove-on-error โ€” Remove the output file if an error occurs. If curl returns an error when told to save output in a local file. This prevents curl from leaving a partial file in the case of an error during transfer. ๐Ÿงน clean girl aesthetic.

If the output is not a regular file, this option has no effect.

The --continue-at option cannot be used together with --remove-on-error.

Providing --remove-on-error multiple times has no extra effect. Disable it again with --no-remove-on-error.

Example:

curl --remove-on-error -o output https://example.com

Added in 7.83.0. See also --fail.

  • -X, --request <method> โ€” Change the method to use when starting the transfer. ๐Ÿ”€

curl passes on the verbatim string you give it in the request without any filter or other safe guards. That includes white space and control characters. fr fr, it does zero vetting.

  • HTTP โ€” Specifies a custom request method to use when communicating with the HTTP server. The specified request method is used instead of the method otherwise used (which defaults to GET). Read the HTTP 1.1 specification for details and explanations. Common additional HTTP requests include PUT and DELETE, while related technologies like WebDAV offers PROPFIND, COPY, MOVE and more.

Normally you do not need this option. All sorts of GET, HEAD, POST and PUT requests are rather invoked by using dedicated command line options.

This option only changes the actual word used in the HTTP request, it does not alter the way curl behaves. For example if you want to make a proper HEAD request, using -X HEAD does not suffice. You need to use the --head option. ๐Ÿ’…

If --location is used, the method string you set with --request is used for all requests, which may cause unintended side-effects when curl does not change request method according to the HTTP 30x response codes โ€” and similar. Consider using --follow instead in combination with --request.

  • FTP โ€” Specifies a custom FTP command to use instead of LIST when doing file lists with FTP.
  • POP3 โ€” Specifies a custom POP3 command to use instead of LIST or RETR.
  • IMAP โ€” Specifies a custom IMAP command to use instead of LIST.
  • SMTP โ€” Specifies a custom SMTP command to use instead of HELP or VRFY.

If --request is provided several times, the last set value is used.

Examples:

curl --request "DELETE" https://example.com
curl -X NLST ftp://example.com/

See also --request-target and --follow.

  • --request-target <path> โ€” (HTTP) Use an alternative target (path) instead of using the path as provided in the URL. Particularly useful when wanting to issue HTTP requests without leading slash or other data that does not follow the regular URL pattern, like "OPTIONS *". ๐ŸŽฏ

curl passes on the verbatim string you give it in the request without any filter or other safe guards. That includes white space and control characters.

If --request-target is provided several times, the last set value is used.

Example:

curl --request-target "*" -X OPTIONS https://example.com

See also --request.

  • --resolve <[+]host:port:addr[,addr]...> โ€” bestie, this is the glow-up for DNS ๐Ÿ’… it hands curl a custom address for one specific host + port combo, so your requests hit exactly the address you picked and the normally-resolved address never even gets a look. Think of it as an /etc/hosts alternative that lives right there on your command line. The port number has to be the one actually used for that specific protocol the host is used for โ€” which means, yeah, if you want addresses for the same host on different ports you're making several entries. No shortcuts, no cap.

And here's the iconic part: if you set * as the host, curl resolves any host on that specific port pair to the address you gave. Wildcard is resolved last, so any --resolve with a specific host and port gets used first. Order of operations, she understood ๐ŸŽ€

The address you provide here is used even if --ipv4 or --ipv6 is set to make curl use another IP version. Yes, it overrides. That's the vibe.

Prefix the host with a + and the entry times out after curl's default timeout (1 minute). Ngl this only makes sense for long-running parallel transfers with a lot of files โ€” in those cases, if this option is used, curl tries to resolve the host as it normally would once the timeout has expired.

Provide IPv6 addresses within [brackets].

Wanna redirect connects from a specific hostname or any hostname, independently of port number? That's a different queen โ€” consider --connect-to.

  • Support for resolving with wildcard was added in 7.64.0.
  • Support for the '+' prefix was added in 7.75.0.
  • Support for specifying the host component as an IPv6 address was added in 8.13.0.

--resolve can be used several times in a command line. Stack 'em, periodt.

Examples:

curl --resolve example.com:443:127.0.0.1 https://example.com
curl --resolve example.com:443:[2001:db8::252f:efd6] https://example.com

See also --connect-to and --alt-svc. ๐Ÿฆ‹

  • --retry <num> โ€” okay so when a transient error shows up mid-transfer, curl retries this number of times before giving up. Set the number to 0 and curl does no retries at all (that's the default, lowercase beginning). "Transient error" means either: a timeout, an FTP 4xx response code, or an HTTP 408, 429, 500, 502, 503, 504, 522 or 524 response code.

When curl is about to retry a transfer it first waits one second, and then for all forthcoming retries it doubles the waiting time until it reaches 10 minutes โ€” which then stays the fixed delay between the rest of the retries. Very patient. Very demure. Use --retry-delay and you disable this exponential backoff algorithm entirely. See also --retry-max-time to limit the total time allowed for retries.

curl complies with the Retry-After: response header if one was present, to know when to issue the next retry (added in 7.66.0). So the server can literally override the retry delay, main character energy. To handle server retry delays that may be longer than expected, use --retry-max-time to limit the total retry time.

If --retry is provided several times, the last set value is used.

curl --retry 7 https://example.com

See also --retry-max-time, --retry-connrefused and --retry-delay.

  • --retry-all-errors โ€” retry on any error. Bestie, this one only works together with --retry.

It's the "sledgehammer" of retrying ๐Ÿ”จ do not use it by default (like in your curlrc), there may be unintended consequences such as sending or receiving duplicate data. Do not use with redirected input or output. You might be better off handling your unique problems in a shell script. Please read the example below.

WARNING: for server compatibility, curl attempts to retry failed flaky transfers as close as possible to how they were started โ€” but this is not possible with redirected input or output. For example, before retrying it removes output data from a failed partial transfer that was written to an output file. However, this is not true of data redirected to a | pipe or > file, which are not reset. We strongly suggest you do not parse or record output via redirect in combination with this option, since you may receive duplicate data. ๐Ÿ˜ญ

By default curl does not return an error for transfers with an HTTP response code that indicates an HTTP error, if the transfer was successful. For example, if a server replies 404 Not Found and the reply is fully received, then that is not an error. When --retry is used, curl retries on some HTTP response codes that indicate transient HTTP errors, but that does not include most 4xx response codes such as 404. If you want to retry on all response codes that indicate HTTP errors (4xx and 5xx), combine with --fail.

Providing --retry-all-errors multiple times has no extra effect. Disable it again with --no-retry-all-errors.

curl --retry 5 --retry-all-errors https://example.com

Added in 7.71.0. See also --retry.

  • --retry-connrefused โ€” in addition to the other conditions, also consider ECONNREFUSED as a transient error for --retry. Used together with --retry, obviously. Normally a refused connection is not considered a transient error, so it wouldn't otherwise trigger a retry โ€” this option says "no, actually, we're counting that one too" ๐Ÿซถ

Providing --retry-connrefused multiple times has no extra effect. Disable it again with --no-retry-connrefused.

curl --retry-connrefused --retry 7 https://example.com

See also --retry and --retry-all-errors.

  • --retry-delay <seconds> โ€” makes curl sleep this amount of time before each retry when a transfer has failed with a transient error (it changes the default backoff time algorithm between retries). Only interesting if --retry is also used, iykyk. Set this delay to zero and curl goes back to the default backoff time.

By default, curl uses an exponentially increasing timeout between retries. We been knew.

Starting in curl 8.16.0, this option accepts a time as decimal number for parts of seconds. The decimal value needs to be provided using a dot (.) as decimal separator โ€” not the local version, even if it might be using another separator. She said what she said ๐Ÿ’…

curl complies with the Retry-After: response header if one was present to know when to issue the next retry (added in 7.66.0). That means the server can override the retry delay. To handle server retry delays that may be longer than expected, you can use --retry-max-time to limit the total retry time.

If --retry-delay is provided several times, the last set value is used.

curl --retry-delay 5 --retry 7 https://example.com

See also --retry and --retry-max-time.

  • --retry-max-time <seconds> โ€” the retry timer is reset before the first transfer attempt. Retries are done as usual (see --retry) as long as the timer has not reached this given limit. Notice that if the timer has not reached the limit, the request is made and while performing, it may take longer than this given time period. To limit a single request's maximum time, use --max-time. Set this option to zero to not timeout retries.

The retry timer starts immediately before the first transfer attempt and includes time spent sleeping between retries (such as delays defined by --retry-delay). Before each new retry is started, curl checks whether the elapsed time has reached the specified limit โ€” if it has, no further retries are performed. Bye ๐Ÿ‘‹

A transfer that has already started is allowed to run to completion even if this makes the total wall clock time exceed the limit. Use --max-time to also cap the duration of each individual transfer attempt. Two different jobs, two different flags, don't mix them up bestie.

Starting in curl 8.16.0, this option accepts a time as decimal number for parts of seconds. The decimal value needs to be provided using a dot (.) as decimal separator โ€” not the local version even if it might be using another separator.

If --retry-max-time is provided several times, the last set value is used.

curl --retry-max-time 30 --retry 10 https://example.com

See also --retry and --retry-delay.

  • --sasl-authzid <identity> โ€” (LDAP IMAP POP3 SMTP) use this authorization identity (authzid) during SASL PLAIN authentication, in addition to the authentication identity (authcid) as specified by --user. Two identities, one slay โœจ

If the option is not specified, the server derives the authzid from the authcid. But if specified, and depending on the server implementation, it may be used to access another user's inbox that the user has been granted access to โ€” or a shared mailbox, for example.

If --sasl-authzid is provided several times, the last set value is used.

curl --sasl-authzid zid imap://example.com/

Added in 7.66.0. See also --login-options.

  • --sasl-ir โ€” (LDAP IMAP POP3 SMTP) enable initial response in SASL authentication. Such an "initial response" is a message sent by the client to the server after the client selects an authentication mechanism. Little hello-first moment ๐ŸŽ€

Providing --sasl-ir multiple times has no extra effect. Disable it again with --no-sasl-ir.

curl --sasl-ir imap://example.com/

See also --sasl-authzid.

  • --service-name <name> โ€” set the service name for SPNEGO. That's it, that's the whole option.

If --service-name is provided several times, the last set value is used.

curl --service-name sockd/server https://example.com

See also --negotiate and --proxy-service-name.

  • -S, --show-error โ€” when used with --silent, it makes curl show an error message if it fails. So you get the quiet, no-clutter vibe but still get told when something goes off ๐Ÿ‘€

This option is global and does not need to be specified for each use of --next. One and done.

Providing --show-error multiple times has no extra effect. Disable it again with --no-show-error.

curl --show-error --silent https://example.com

See also --no-progress-meter.

  • -i, --show-headers โ€” bestie, this one shows you the response headers in your output. It's (HTTP FTP) flavored. HTTP response headers can include things like server name, cookies, date of the document, HTTP version and more. With non-HTTP protocols, the "headers" are other server communication.

This option makes the response headers get saved in the same stream/output as the data. --dump-header exists to save headers in a separate stream. iykyk the difference ๐Ÿ’…

When HTTP headers are output to a tty, curl may use escape codes to make the header field names appear in bold and URLs in Location: headers be especially marked as such. Disable the use of terminal escape codes with --no-styled-output. (This means using the --styled-output option with a --no- prefix to disable it.)

Wanna see the request headers instead? Consider the --verbose option ๐Ÿ‘€

Prior to 7.75.0 curl did not print the headers if --fail was used in combination with this option and there was an error reported by the server.

This option was called --include before 8.10.0. The previous name remains functional, so no panic ๐Ÿซถ

Providing --show-headers multiple times has no extra effect. Disable it again with --no-show-headers.

Example:

curl -i https://example.com

See also --verbose and --dump-header.

  • --sigalgs <list> โ€” (TLS) Set specific signature algorithms to use during SSL session establishment according to RFC 5246, 7.4.1.4.1. Very demure, very protocol-spec โœจ

An algorithm can use either a signature algorithm and a hash algorithm pair separated by a + (e.g. ECDSA+SHA224), or its TLS 1.3 signature scheme name (e.g. ed25519).

Multiple algorithms can be provided by separating them with : (e.g. DSA+SHA256:rsa_pss_pss_sha256). The parameter is available as -sigalgs in the OpenSSL s_client and s_server utilities.

--sigalgs allows a OpenSSL powered curl to make SSL-connections with exactly the signature algorithms requested by the client, avoiding nontransparent client/server negotiations.

If this option is set, the default signature algorithm list built into OpenSSL are ignored.

If --sigalgs is provided several times, the last set value is used.

Example:

curl --sigalgs ecdsa_secp256r1_sha256 https://example.com

Added in 8.14.0. See also --ciphers.

  • -s, --silent โ€” Silent or quiet mode, aka "shhh bestie, curl is having a moment." Do not show progress meter, note messages, warning messages or error messages. Makes curl mute ๐Ÿค It still outputs the data you ask for, potentially even to the terminal/stdout unless you redirect it.

Use --show-error in addition to this option to disable progress meter but still show error messages.

Providing --silent multiple times has no extra effect. Disable it again with --no-silent.

Example:

curl -s https://example.com

See also --verbose, --stderr and --no-progress-meter.

  • --skip-existing โ€” If there is a local file present when a download is requested, the operation is skipped. Simple as that โœจ Note that curl cannot know if the local file was previously downloaded fine, or if it is incomplete etc, it knows if there is a filename present in the file system or not and it skips the transfer if it is. No vibe check on the file contents, just vibes ๐Ÿซถ

Providing --skip-existing multiple times has no extra effect. Disable it again with --no-skip-existing.

Example:

curl --skip-existing --output local/dir/file https://example.com

Added in 8.10.0. See also --output, --remote-name and --no-clobber.

  • --socks4 <host[:port]> โ€” Use the specified SOCKS4 proxy. If the port number is not specified, it is assumed at port 1080. Using this socket type makes curl resolve the hostname and pass the address on to the proxy.

To specify the proxy on a Unix domain socket, use localhost for host and append the absolute path to the domain socket. For example: socks4://localhost/path/to/socket.sock (the scheme may be omitted).

This option overrides any previous use of --proxy, as they are mutually exclusive ๐Ÿ”ฅ

This option is superfluous since you can specify a socks4 proxy with --proxy using a socks4:// protocol prefix.

--preproxy can be used to specify a SOCKS proxy at the same time proxy is used with an HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy. Layered, like a cute little proxy parfait ๐Ÿ“

If --socks4 is provided several times, the last set value is used.

Example:

curl --socks4 hostname:4096 https://example.com

This option is mutually exclusive with --proxy, --socks4a, --socks5 and --socks5-hostname. See also --socks4a, --socks5 and --socks5-hostname.

  • --socks4a <host[:port]> โ€” Use the specified SOCKS4a proxy. If the port number is not specified, it is assumed at port 1080. This asks the proxy to resolve the hostname ๐Ÿ‘‘

To specify the proxy on a Unix domain socket, use localhost for host and append the absolute path to the domain socket. For example: socks4a://localhost/path/to/socket.sock (the scheme may be omitted).

This option overrides any previous use of --proxy, as they are mutually exclusive.

This option is superfluous since you can specify a socks4a proxy with --proxy using a socks4a:// protocol prefix.

--preproxy can be used to specify a SOCKS proxy at the same time --proxy is used with an HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.

If --socks4a is provided several times, the last set value is used.

Example:

curl --socks4a hostname:4096 https://example.com

This option is mutually exclusive with --proxy, --socks4, --socks5 and --socks5-hostname. See also --socks4, --socks5 and --socks5-hostname.

  • --socks5 <host[:port]> โ€” Use the specified SOCKS5 proxy โ€” but resolve the hostname locally ๐Ÿ’… If the port number is not specified, it is assumed at port 1080.

To specify the proxy on a Unix domain socket, use localhost for host and append the absolute path to the domain socket. For example: socks5://localhost/path/to/socket.sock (the scheme may be omitted).

This option overrides any previous use of --proxy, as they are mutually exclusive.

This option is superfluous since you can specify a socks5 proxy with --proxy using a socks5:// protocol prefix.

--preproxy can be used to specify a SOCKS proxy at the same time --proxy is used with an HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.

Heads up bestie: this option does not work with FTPS or LDAP. It's giving "not invited to the party" ๐Ÿ˜ญ

If --socks5 is provided several times, the last set value is used.

Examples:

curl --socks5 proxy.example:7000 https://example.com
curl --socks5 localhost/path/unix-domain https://example.com

This option is mutually exclusive with --proxy, --socks4, --socks4a and --socks5-hostname. See also --socks5-hostname and --socks4a.

  • --socks5-basic โ€” Use username/password authentication when connecting to a SOCKS5 proxy. The username/password authentication is enabled by default. Use --socks5-gssapi to force GSS-API authentication to SOCKS5 proxies.

Providing --socks5-basic multiple times has no extra effect. (No "disable" twin for this one, she's just like that ๐ŸŽ€)

Example:

curl --socks5-basic --socks5 hostname:4096 https://example.com

See also --socks5.

  • --socks5-gssapi โ€” (GSS/kerberos) Use GSS-API authentication when connecting to a SOCKS5 proxy. The GSS-API authentication is enabled by default (if curl is compiled with GSS-API support). Use --socks5-basic to force username/password authentication to SOCKS5 proxies.

Providing --socks5-gssapi multiple times has no extra effect. Disable it again with --no-socks5-gssapi.

Example:

curl --socks5-gssapi --socks5 hostname:4096 https://example.com

See also --socks5.

  • --socks5-gssapi-nec โ€” (GSS/kerberos) As part of the GSS-API negotiation a protection mode is negotiated. RFC 1961 says in section 4.3/4.4 it should be protected, but the NEC reference implementation does not ๐Ÿ˜ฌ The option --socks5-gssapi-nec allows the unprotected exchange of the protection mode negotiation. (Yes, this is a compatibility hack. She's doing her best.)

Providing --socks5-gssapi-nec multiple times has no extra effect. Disable it again with --no-socks5-gssapi-nec.

Example:

curl --socks5-gssapi-nec --socks5 hostname:4096 https://example.com

See also --socks5.

  • --socks5-gssapi-service <name> โ€” Set the service name for a socks server. Default is rcmd/server-fqdn โœจ

If --socks5-gssapi-service is provided several times, the last set value is used.

Example:

curl --socks5-gssapi-service sockd --socks5 hostname:4096 https://example.com

See also --socks5.

  • --socks5-hostname <host[:port]> โ€” Use the specified SOCKS5 proxy (and let the proxy resolve the hostname โ€” handing off the detective work ๐Ÿ•ต๏ธโ€โ™€๏ธ). If the port number is not specified, it is assumed at port 1080.

To specify the proxy on a Unix domain socket, use localhost for host and append the absolute path to the domain socket. For example: socks5h://localhost/path/to/socket.sock (the scheme may be omitted).

This option overrides any previous use of --proxy, as they are mutually exclusive.

This option is superfluous since you can specify a socks5 hostname proxy with --proxy using a socks5h:// protocol prefix.

--preproxy can be used to specify a SOCKS proxy at the same time --proxy is used with an HTTP/HTTPS proxy. In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.

If --socks5-hostname is provided several times, the last set value is used.

Example:

curl --socks5-hostname proxy.example:7000 https://example.com

Still on that option's fine print, bestie โ€” same flag, last little detail:

This option is mutually exclusive with --proxy, --socks4, --socks4a and --socks5. See also --socks5 and --socks4a. ๐Ÿ’…


-Y, --speed-limit <speed> ๐Ÿข

If a transfer is slower than this set speed (in bytes per second) for a given number of seconds, it gets aborted. The time period is set with --speed-time and is 30 seconds by default. So likeโ€ฆ if your download is Being Slow for long enough, curl just says "nope, we're done here" ๐Ÿ˜ญ

If --speed-limit is provided several times, the last set value is used.

Example:

curl --speed-limit 300 --speed-time 10 https://example.com

See also --speed-time, --limit-rate and --max-time.


-y, --speed-time <seconds> โฑ๏ธ

If a transfer runs slower than speed-limit bytes per second during a speed-time period, the transfer is aborted. If speed-time is used, the default speed-limit is 1 unless set with --speed-limit. (yes, one whole byte per second โ€” very patient of curl honestly ๐Ÿซถ)

This option controls transfers (in both directions) but does not affect slow connects etc. If this is a concern for you, try the --connect-timeout option.

If --speed-time is provided several times, the last set value is used.

Example:

curl --speed-limit 300 --speed-time 10 https://example.com

See also --speed-limit and --limit-rate.


--ssl (FTP IMAP POP3 SMTP LDAP) ๐Ÿ”

Warning: this is considered an insecure option. Consider using --ssl-reqd instead to be sure curl upgrades to a secure connection. Like, genuinely, the upgrade is not guaranteed here bestie ๐Ÿ’€

Try to use SSL/TLS for the connection โ€” often referred to as STARTTLS or STLS because of the involved commands. Reverts to a non-secure connection if the server does not support SSL/TLS. See also --ftp-ssl-control and --ssl-reqd for different levels of encryption required.

This option is handled in LDAP (added in 7.81.0). It is fully supported by the OpenLDAP backend and ignored by the generic ldap backend.

Please note that a server may close the connection if the negotiation fails.

If set, this option overrides --ftp-ssl-control.

This option was formerly known as --ftp-ssl. That option name can still be used but might be removed in a future version.

Providing --ssl multiple times has no extra effect. Disable it again with --no-ssl.

Example:

curl --ssl pop3://example.com/

See also --ssl-reqd, --insecure and --ciphers.


--ssl-allow-beast ๐Ÿฆ

(TLS) Do not work around a security flaw in the TLS1.0 protocol known as BEAST. If this option is not used, the TLS layer may use workarounds known to cause interoperability problems with some older server implementations.

This option only changes how curl does TLS 1.0 and has no effect on later TLS versions.

WARNING: this option loosens the TLS security, and by using this flag you ask for exactly that. You're literally requesting less security, no cap ๐Ÿ˜ฌ

Providing --ssl-allow-beast multiple times has no extra effect. Disable it again with --no-ssl-allow-beast.

Example:

curl --ssl-allow-beast https://example.com

See also --proxy-ssl-allow-beast and --insecure.


--ssl-auto-client-cert ๐Ÿชช

(TLS) (Schannel) Automatically locate and use a client certificate for authentication, when requested by the server. Since the server can request any certificate that supports client authentication in the OS certificate store it could be a privacy violation and unexpected. Like, it might pick one you did not expect โ€” lowkey a yikes ๐Ÿ™ˆ

Providing --ssl-auto-client-cert multiple times has no extra effect. Disable it again with --no-ssl-auto-client-cert.

Example:

curl --ssl-auto-client-cert https://example.com

Added in 7.77.0. See also --proxy-ssl-auto-client-cert.


--ssl-no-revoke ๐Ÿšซ

(TLS) (Schannel) Disable certificate revocation checks.

WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that. Same energy as --ssl-allow-beast โ€” you're opting into the chill version of security, deliberately ๐Ÿ’…

Providing --ssl-no-revoke multiple times has no extra effect. Disable it again with --no-ssl-no-revoke.

Example:

curl --ssl-no-revoke https://example.com

See also --crlfile.


--ssl-reqd โœ…๐Ÿ”

(FTP IMAP POP3 SMTP LDAP) Require SSL/TLS for the connection โ€” often referred to as STARTTLS or STLS because of the involved commands. Terminates the connection if the transfer cannot be upgraded to use SSL/TLS. It's giving "secure or nothing" and honestly? iconic.

This option is handled in LDAP (added in 7.81.0). It is fully supported by the OpenLDAP backend and rejected by the generic ldap backend if explicit TLS is required.

This option is unnecessary if you use a URL scheme that in itself implies immediate and implicit use of TLS, like for FTPS, IMAPS, POP3S, SMTPS and LDAPS. Such a transfer always fails if the TLS handshake does not work.

This option was formerly known as --ftp-ssl-reqd.

Providing --ssl-reqd multiple times has no extra effect. Disable it again with --no-ssl-reqd.

Example:

curl --ssl-reqd ftp://example.com

See also --ssl and --insecure.


--ssl-revoke-best-effort ๐ŸŒธ

(TLS) (Schannel) Ignore certificate revocation checks when they failed due to missing/offline distribution points for the revocation check lists. It's the "the list wasn't reachable so we're letting it slide" option ๐Ÿซถ

Providing --ssl-revoke-best-effort multiple times has no extra effect. Disable it again with --no-ssl-revoke-best-effort.

Example:

curl --ssl-revoke-best-effort https://example.com

Added in 7.70.0. See also --crlfile and --insecure.


--ssl-sessions <filename> ๐ŸŽŸ๏ธโœจ

(TLS) WARNING: this option is experimental. Do not use in production. Seriously, it's literally in the "do not use in production" bin ๐Ÿงช

Use the given file to load SSL session tickets into curl's cache before starting any transfers. At the end of a successful curl run, the cached SSL sessions tickets are saved to the file, replacing any previous content.

The file does not have to exist, but curl reports an error if it is unable to create it. Unused loaded tickets are saved again, unless they get replaced or purged from the cache for space reasons.

Using a session file allows --tls-earlydata to send the first request in "0-RTT" mode, should an SSL session with the feature be found. Note that a server may not support early data. Also note that early data does not provide forward secrecy, e.g. is not as secure. So likeโ€ฆ faster but slightly less safe, your call bestie ๐Ÿ˜ฌ

The SSL session tickets are stored as base64 encoded text, each ticket on its own line. The hostnames are cryptographically salted and hashed. While this prevents someone from easily seeing the hosts you contacted, they could still check if a specific hostname matches one of the values. (privacy-adjacent, but not privacy-perfect, iykyk)

This feature requires that the underlying libcurl was built with the experimental SSL session import/export feature (SSLS-EXPORT) enabled.

The sessions in the file identify origin and used TLS configurations. Configuration parameters identified by a file path are only matched to the path, not the file's content. Updates to CA, CRL or key file contents do not invalidate previously saved sessions.

Most TLS sessions handed out by servers have a short lifetime, which limits the risk. Also, curl does not persist TLS session in this file that are tied to authentication, e.g. a client certificate. If that all is not acceptable, ssl session files should be cleared when older than the CA/CRL file used or not used at all.

If --ssl-sessions is provided several times, the last set value is used.

Example:

curl --ssl-sessions sessions.txt https://example.com

Added in 8.12.0. See also --tls-earlydata.


-2, --sslv2 ๐Ÿ•ฐ๏ธ

(SSL) This option previously asked curl to use SSLv2, but is now ignored (added in 7.77.0). SSLv2 is widely considered insecure (see RFC 6176). It's retired, girl, let her rest ๐Ÿ’€

Providing --sslv2 multiple times has no extra effect.

Example:

curl --sslv2 https://example.com

For --sslv2 to work, it requires that the underlying libcurl is built to support TLS. This option is mutually exclusive with --sslv3, --tlsv1, --tlsv1.1 and --tlsv1.2. See also --http1.1 and --http2.


-3, --sslv3 ๐Ÿ•ฐ๏ธ๐Ÿ•ฐ๏ธ

(SSL) This option previously asked curl to use SSLv3, but is now ignored (added in 7.77.0). SSLv3 is widely considered insecure (see RFC 7568). Same deal as its older sibling โ€” a museum piece ๐Ÿ›๏ธ

Providing --sslv3 multiple times has no extra effect.

Example:

curl --sslv3 https://example.com

For --sslv3 to work, it requires that the underlying libcurl is built to support TLS. This option is mutually exclusive with --sslv2, --tlsv1, --tlsv1.1 and --tlsv1.2. See also --http1.1 and --http2.


--stderr <file> ๐Ÿ“

Redirect all writes to stderr to the specified file instead. If the filename is a plain -, it is instead written to stdout.

This option is global and does not need to be specified for each use of --next.

If --stderr is provided several times, the last set value is used.

Example:

curl --stderr output.txt https://example.com

See also --verbose and --silent.


--styled-output ๐Ÿ’–

Enable automatic use of bold font styles when writing HTTP headers to the terminal. Use --no-styled-output to switch them off. Yes, curl can be cute about your headers, we love a little aesthetic โœจ

Styled output requires a terminal that supports bold fonts. This feature is not present on curl for Windows due to lack of this capability. (Windows besties, you're not getting the bold headers, sorry ๐Ÿ˜ญ)

This option is global and does not need to be specified for each use of --next.

Providing --styled-output multiple times has no extra effect. Disable it again with --no-styled-output.

Example:

curl --styled-output -I https://example.com

See also --head and --verbose.


--suppress-connect-headers ๐Ÿคซ

When --proxytunnel is used and a CONNECT request is made, do not output proxy CONNECT response headers. This option is meant to be used with --dump-header or --show-headers which are used to show protocol headers in the output. It has no effect on debug options such as --verbose or --trace, or any statistics.

Providing --suppress-connect-headers multiple times has no extra effect. Disable it again with --no-suppress-connect-headers.

Example:

curl --suppress-connect-headers --show-headers -x proxy https://example.com

more options coming, don't go anywhere bestie ๐Ÿฆ‹

See also --dump-header, --show-headers and --proxytunnel.


  • --tcp-fastopen โ€” turns on TCP Fast Open (RFC 7413) ๐ŸŒˆ. It's this cute little TCP extension that lets data get sent earlier over the connection (like, before the final handshake ACK) as long as the client and server have been connected before. Basically speedrunning the vibes.

Passing --tcp-fastopen multiple times has no extra effect (it's not a "more is more" situation, bestie). Turn it back off with --no-tcp-fastopen.

Example:

curl --tcp-fastopen https://example.com

See also --false-start.

  • --tcp-nodelay โ€” Turn on the TCP_NODELAY option โœจ.

This one disables the Nagle algorithm on TCP connections. What's Nagle's whole deal? Its purpose is to minimize the number of small packets on the network (and "small packets" here means TCP segments less than the Maximum Segment Size for the network).

Maximizing the amount of data sent per TCP segment is good because it amortizes the overhead of the send ๐Ÿ™Œ. But in some cases small segments may need to be sent without delay. That's less efficient than sending larger amounts of data at a time, and ngl if you overdo it, it can contribute to congestion on the network.

curl sets this option by default and you need to explicitly switch it off if you do not want it on. Main character default energy, honestly ๐Ÿ‘‘.

Providing --tcp-nodelay multiple times has no extra effect. Disable it again with --no-tcp-nodelay.

Example:

curl --tcp-nodelay https://example.com

See also --no-buffer.

  • -t, --telnet-option <opt=val> โ€” (TELNET) Pass options to the telnet protocol ๐Ÿฆ‹. Supported options are:
    • TTYPE=<term> โ€” Sets the terminal type.
    • XDISPLOC=<X display> โ€” Sets the X display location.
    • NEW_ENV=<var,val> โ€” Sets an environment variable.

--telnet-option can be used several times in a command line. Stack 'em ๐Ÿ’….

Example:

curl -t TTYPE=vt100 telnet://example.com/

See also --config.

  • --tftp-blksize <value> โ€” (TFTP) Set the TFTP BLKSIZE option (must be 512 or larger) ๐ŸŽ€. This is the block size that curl tries to use when transferring data to or from a TFTP server. By default 512 bytes are used.

If --tftp-blksize is provided several times, the last set value is used.

Example:

curl --tftp-blksize 1024 tftp://example.com/file

See also --tftp-no-options.

  • --tftp-no-options โ€” (TFTP) Do not send TFTP options requests ๐ŸŒธ. This improves interop with some legacy servers that do not acknowledge or properly implement TFTP options. Heads up: when this option is used, --tftp-blksize is ignored ๐Ÿ‘€.

Providing --tftp-no-options multiple times has no extra effect. Disable it again with --no-tftp-no-options.

Example:

curl --tftp-no-options tftp://192.168.0.1/

See also --tftp-blksize.

  • -z, --time-cond <time> โ€” (HTTP FTP) Request a file that has been modified later than the given time and date, or one that has been modified before that time โญ.

The date expression can be all sorts of date strings, and if it does not match any internal ones, it is treated as a filename and curl tries to get the modification date (mtime) from that file instead. See the curl_getdate(3) man page for date expression details.

Start the date expression with a dash (-) to make it request for a document that is older than the given date/time; the default is a document that is newer than the specified date/time. Sneaky little minus sign, iconic behavior.

If provided a non-existing file, curl outputs a warning about that fact and proceeds to do the transfer without a time condition. It's fine, it's fine, it's fine ๐Ÿ˜ญ.

If --time-cond is provided several times, the last set value is used.

Examples:

curl -z "Wed 01 Sep 2021 12:18:00" https://example.com
curl -z "-Wed 01 Sep 2021 12:18:00" https://example.com
curl -z file https://example.com

See also --etag-compare and --remote-time.

  • --tls-earlydata โ€” (TLS) Enable the use of TLSv1.3 early data, also known as '0RTT' where possible ๐Ÿ’œ. This has security implications for the requests sent that way. Yes, we're doing the spicy one.

This option can be used when curl is built to use GnuTLS, OpenSSL, quictls and wolfSSL as a TLS provider (but not AWS-LC, BoringSSL, or Rustls).

If a server supports this TLSv1.3 feature, and to what extent, is announced as part of the TLS "session" sent back to curl. Until curl has seen such a session in a previous request, early data cannot be used.

When a new connection is initiated with a known TLSv1.3 session, and that session announced early data support, the first request on this connection is sent before the TLS handshake is complete. While the early data is also encrypted, it is not protected against replays. An attacker can send your early data to the server again and the server would accept it. So yeah. That's a thing.

If your request contacts a public server and only retrieves a file, there may be no harm in that. If the first request orders a refrigerator for you, it is probably not a good idea to use early data for it ๐ŸงŠ. curl cannot deduce what the security implications of your requests actually are and make this decision for you โ€” you're the main character, you make the call.

The amount of early data sent can be inspected by using the --write-out variable tls_earlydata.

WARNING: this option has security implications. See above for more details.

Providing --tls-earlydata multiple times has no extra effect. Disable it again with --no-tls-earlydata.

Example:

curl --tls-earlydata https://example.com

Added in 8.11.0. See also --tlsv1.3, --tls-max and --ssl-sessions.

  • --tls-max <VERSION> โ€” (TLS) Set the maximum allowed TLS version ๐Ÿ”ฅ. The minimum acceptable version is set by tlsv1.0, tlsv1.1, tlsv1.2 or tlsv1.3.

If the connection is done without TLS, this option has no effect. This includes QUIC-using (HTTP/3) transfers.

  • default โ€” Use up to the recommended TLS version.
  • 1.0 โ€” Use up to TLSv1.0.
  • 1.1 โ€” Use up to TLSv1.1.
  • 1.2 โ€” Use up to TLSv1.2.
  • 1.3 โ€” Use up to TLSv1.3.

If --tls-max is provided several times, the last set value is used.

Examples:

curl --tls-max 1.2 https://example.com
curl --tls-max 1.3 --tlsv1.2 https://example.com

For --tls-max to work, it requires that the underlying libcurl is built to support TLS. See also --tlsv1.0, --tlsv1.1, --tlsv1.2 and --tlsv1.3.

  • --tls13-ciphers <list> โ€” (TLS) Set which cipher suites to use in the connection if it negotiates TLS 1.3 ๐ŸŽ€. The list of ciphers suites must specify valid ciphers. Read up on TLS 1.3 cipher suite details on this URL:
https://curl.se/docs/ssl-ciphers.html

This option is used when curl is built to use OpenSSL 1.1.1 or later, wolfSSL, or mbedTLS 3.6.0 or later.

Before curl 8.10.0 with mbedTLS or wolfSSL, TLS 1.3 cipher suites were set by using the --ciphers option. Glow-up era ๐Ÿ’….

If --tls13-ciphers is provided several times, the last set value is used.

Example:

curl --tls13-ciphers TLS_AES_128_GCM_SHA256 https://example.com

See also --ciphers, --proxy-tls13-ciphers and --curves.

  • --tlsauthtype <type> โ€” (TLS) Deprecated option. This has no functionality since 8.22.0 ๐Ÿ’€.

Set TLS authentication type. Currently, the only supported option is "SRP", for TLS-SRP (RFC 5054). If --tlsuser and --tlspassword are specified but --tlsauthtype is not, then this option defaults to "SRP". This option works only if the underlying libcurl is built with TLS-SRP support, which requires OpenSSL or GnuTLS with TLS-SRP support.

If --tlsauthtype is provided several times, the last set value is used.

Example:

curl --tlsauthtype SRP https://example.com

See also --tlsuser.

  • --tlspassword <string> โ€” (TLS) Deprecated option. This has no functionality since 8.22.0 ๐Ÿ’€.

Set password to use with the TLS authentication method specified with --tlsauthtype. Requires that --tlsuser is set.

This option does not work with TLS 1.3.

If --tlspassword is provided several times, the last set value is used.

Example:

curl --tlspassword pwd --tlsuser user https://example.com

See also --tlsuser.

  • --tlsuser <name> โ€” (TLS) Deprecated option. This has no functionality since 8.22.0 ๐Ÿ’€.

Set username for use with the TLS authentication method specified with --tlsauthtype. Requires that --tlspassword also is set.

This option does not work with TLS 1.3.

If --tlsuser is provided several times, the last set value is used.

Example:

curl --tlspassword pwd --tlsuser user https://example.com

See also --tlspassword.

  • -1, --tlsv1 โ€” (TLS) Use at least TLS version 1.x when negotiating with a remote TLS server ๐Ÿฆ‹. That means TLS version 1.0 or higher.

Providing --tlsv1 multiple times has no extra effect.

Example:

curl --tlsv1 https://example.com

For --tlsv1 to work, it requires that the underlying libcurl is built to support TLS. This option is mutually exclusive with --tlsv1.1, --tlsv1.2 and --tlsv1.3 โ€” pick a lane, bestie. See also --http1.1 and --http2.

  • --tlsv1.0 โ€” (TLS) Force curl to use TLS version 1.0 or later when connecting to a remote TLS server โœจ.

In old versions of curl this option was documented to allow _only_ TLS 1.0. That behavior was inconsistent depending on the TLS library. Use --tls-max if you want to set a maximum TLS version.

Providing --tlsv1.0 multiple times has no extra effect.

Example:

curl --tlsv1.0 https://example.com

See also --tlsv1.3.

  • --tlsv1.1 โ€” (TLS) Force curl to use TLS version 1.1 or later when connecting to a remote TLS server ๐ŸŒธ.

In old versions of curl this option was documented to allow _only_ TLS 1.1. That behavior was inconsistent depending on the TLS library. Use --tls-max if you want to set a maximum TLS version.

Providing --tlsv1.1 multiple times has no extra effect.

๐Ÿ’… --tlsv1.1

Example:

curl --tlsv1.1 https://example.com

See also --tlsv1.3 and --tls-max. ๐Ÿซถ


โœจ --tlsv1.2

(TLS) Bestie, this forces curl to use TLS version 1.2 or later when it's connecting to a remote TLS server.

Okay so tea โ˜• โ€” in old versions of curl this option was documented as allowing __only__ TLS 1.2. That behavior was inconsistent depending on the TLS library. So if you wanna set a maximum TLS version, use --tls-max instead, kk?

Providing --tlsv1.2 multiple times has no extra effect (like, it's not gonna try harder, bestie ๐Ÿ’€).

Example:

curl --tlsv1.2 https://example.com

See also --tlsv1.3 and --tls-max. ๐Ÿฆ‹


๐Ÿ”ฅ --tlsv1.3

(TLS) Same vibe, newer protocol: forces curl to use TLS version 1.3 or later when connecting to a remote TLS server. Slay.

If the connection is done without TLS, this option has no effect at all. That includes QUIC-using (HTTP/3) transfers, iykyk.

Heads up bestie ๐Ÿ™ˆ โ€” TLS 1.3 is not supported by all TLS backends.

Providing --tlsv1.3 multiple times has no extra effect.

Example:

curl --tlsv1.3 https://example.com

See also --tlsv1.2 and --tls-max. ๐Ÿ’œ


๐ŸŽ€ --tr-encoding

(HTTP) Requests a compressed Transfer-Encoding response using one of the algorithms curl supports, and uncompresses the data while it's receiving it. Fancy.

Okay so the lore ๐Ÿ“–: this method was once intended to be the way to do automatic data compression for HTTP, but for all practical purposes using Content-Encoding as done with --compressed has superseded transfer encoding. So the --tr-encoding option is therefore often not one you want, ngl. It's giving deprecated-in-spirit.

Providing --tr-encoding multiple times has no extra effect. Disable it again with --no-tr-encoding.

Example:

curl --tr-encoding https://example.com

See also --compressed. ๐ŸŒธ


๐Ÿฆ‹ --trace <file>

Saves a full trace dump of all incoming and outgoing data โ€” including descriptive information โ€” in the given output file. Use - as filename to have the output sent to stdout. Use % as filename to have the output sent to stderr. Iconic little trio.

โš ๏ธ Bestie, real talk: verbose output of curl activities and network traffic might contain sensitive data, including usernames, credentials or secret data content. Be aware and be careful when sharing trace logs with others. Do not be posting those in the group chat ๐Ÿ˜ญ

This option is global and does not need to be specified for each use of --next.

If --trace is provided several times, the last set value is used.

Example:

curl --trace log.txt https://example.com

This option is mutually exclusive with --verbose and --trace-ascii. See also --trace-ascii, --trace-config, --trace-ids and --trace-time. ๐Ÿ’–


๐Ÿงš --trace-ascii <file>

Saves a full trace dump of all incoming and outgoing data, including descriptive information, in the given output file. Use - as filename to have the output sent to stdout. Use % as filename to send the output to stderr.

This is similar to --trace, but it leaves out the hex part and only shows the ASCII part of the dump. It makes smaller output that might be easier to read for untrained humans ๐Ÿซถ (no shade, we were all untrained humans once).

โš ๏ธ Same warning, same energy: verbose output of curl activities and network traffic might contain sensitive data, including usernames, credentials or secret data content. Be aware and be careful when sharing trace logs with others.

This option is global and does not need to be specified for each use of --next.

If --trace-ascii is provided several times, the last set value is used.

Example:

curl --trace-ascii log.txt https://example.com

This option is mutually exclusive with --trace and --verbose. See also --verbose and --trace. โญ


๐ŸŒˆ --trace-config <string>

Sets configuration for trace output. It's a comma-separated list of components where detailed output can be made available from. Names are case-insensitive. Specify 'all' to enable all trace components. Go off, king.

In addition to trace component names, specify "ids" and "time" to avoid extra --trace-ids or --trace-time parameters. Efficient ๐Ÿ’…

See the curl_global_trace(3) man page for more details.

This option is global and does not need to be specified for each use of --next.

--trace-config can be used several times in a command line.

Example:

curl --trace-config ids,http/2 https://example.com

Added in 8.3.0. See also --verbose and --trace. ๐Ÿ“


๐Ÿ‘‘ --trace-ids

Prepends the transfer and connection identifiers to each trace or verbose line that curl displays.

The identifiers are unique numbers assigned to each connection and transfer to allow a user to better understand which transfer and connection each verbose output line refers to. It's literally giving main character energy to every single line so you know who's who ๐ŸŽ€

This option is global and does not need to be specified for each use of --next.

Providing --trace-ids multiple times has no extra effect. Disable it again with --no-trace-ids.

Example:

curl --trace-ids --trace-ascii output https://example.com

Added in 8.2.0. See also --trace and --verbose. ๐Ÿ’ซ


โฐ --trace-time

Prepends a time stamp to each trace or verbose line that curl displays. So you can be like "when did this happen" and curl is like "here bestie, I gotchu" ๐Ÿซถ

This option is global and does not need to be specified for each use of --next.

Providing --trace-time multiple times has no extra effect. Disable it again with --no-trace-time.

Example:

curl --trace-time --trace-ascii output https://example.com

See also --trace and --verbose. ๐Ÿฆ‹


๐Ÿ”Œ --unix-socket <path>

(HTTP) Connects to the server through this Unix domain socket, instead of using the network. Local vibes only โœจ

To connect to a proxy over Unix domain socket, see --proxy.

If --unix-socket is provided several times, the last set value is used.

Example:

curl --unix-socket socket-path https://example.com

See also --abstract-unix-socket. ๐Ÿ’œ


๐Ÿ“ค -T, --upload-file <file>

Uploads the specified local file to the remote URL. The moment we've all been waiting for ๐Ÿ’…

If there is no file part in the specified URL, curl appends the local file name to the end of the URL before the operation starts. You must use a trailing slash ("/") on the last directory to prove to curl that there is no filename โ€” otherwise curl thinks that your last directory name is the remote filename to use. It's giving suspicious behavior, but okay.

When putting the local filename at the end of the URL, curl ignores what is on the left side of any slash ("/") or backslash ("\\") used in the filename and only appends what is on the right side of the rightmost such character. Sneaky but that's the rule ๐ŸŽ€

Use the filename - (a single dash) to use stdin instead of a given file. Alternately, the filename . (a single period) may be specified instead of - to use stdin in non-blocking mode to allow reading server output while stdin is being uploaded. Obsessed with that actually.

If this option is used with an HTTP(S) URL, the PUT method is used.

You can specify one --upload-file for each URL on the command line. Each --upload-file + URL pair specifies what to upload and to where. curl also supports globbing of the --upload-file argument, meaning that you can upload multiple files to a single URL by using the same URL globbing style supported in the URL. Example:

curl --upload-file 'file{1,2,3}' ftp://ftp.example/

Since curl 8.21.0, you can use parts of the upload filename when it uses globbing by setting a glob name and referencing that in the same way you reference named URL globs. For example, if you upload three files to a single fixed HTTP URL and want to save the corresponding responses in separate files:

curl -T 'file{<num>1,2,3}' \
  https://upload.example/ -o 'response-#<num>'

When uploading to an SMTP server (aka "sending email" ๐Ÿ“ง): the uploaded data is assumed to be RFC 5322 formatted. It has to feature the necessary set of headers and mail body formatted correctly by the user, as curl does not transcode nor encode it further in any way. You're on your own for that part bestie ๐Ÿ˜ญ

--upload-file is associated with a single URL. Use it once per URL when you use several URLs in a command line.

Examples:

curl -T file https://example.com
curl -T "img[1-1000].png" ftp://ftp.example.com/
curl --upload-file "{file1,file2}" https://example.com
curl -T file -T file2 https://example.com https://example.com

See also --get, --head, --request and --data. ๐Ÿ”ฅ


๐Ÿšฉ --upload-flags <flags>

(IMAP) Specifies additional behavior to apply to uploaded files. Flags are specified as either a single flag value or a comma-separated list of flag values. These values are case-sensitive and may be negated by prepending them with a - character. Currently the following flag values are accepted: answered, deleted, draft, flagged, and seen. The currently accepted flag values are used to set flags on IMAP uploads. So organized โœจ

If --upload-flags is provided several times, the last set value is used.

Example:

curl --upload-flags Flagged,!Seen --upload-file local/dir/file https://example.com

Added in 8.13.0. See also --upload-file. ๐Ÿ’–


๐ŸŒ --url <url/file>

Specifies a URL to fetch or send data to. The whole point, honestly ๐Ÿ‘‘

If the given URL is missing a scheme (such as "http://" or "ftp://" etc) curl guesses which scheme to use based on the hostname. If the outermost subdomain name matches DICT, FTP, IMAP, LDAP, POP3 or SMTP case insensitively, then that protocol is used, otherwise it assumes HTTP. Scheme guessing can be avoided by providing a full URL including the scheme, or disabled by setting a default protocol โ€” see --proto-default for details.

To control where the contents of a retrieved URL is written instead of the default stdout, use the --output or the --remote-name options. When retrieving multiple URLs in a single invoke, each provided URL needs its own dedicated destination option unless --remote-name-all is used. No sharing, bestie ๐Ÿ’…

On Windows, "file://" accesses can be converted to network accesses by the operating system. Wild, but true ๐Ÿฆ‹

Starting in curl 8.13.0, curl can be told to download URLs provided in a text file, one URL per line ๐Ÿ’–. You do it with --url @filename โ€” so instead of a URL you hand it a filename with the @ symbol in front. And yes, you can make it read the list from stdin by passing something like @-. Iconic.

When downloading URLs given in a file, it implies using --remote-name for each provided URL. The URLs are full, there is no globbing applied or done on these. Features such as --skip-existing work fine in combination with this. Slay.

Lines in the URL file that start with # are treated as comments and are skipped. Respect the comment section, bestie ๐Ÿซถ.

--url can be used several times in a command line.

Examples:

curl --url https://example.com
curl --url @file

See also --next, --config, --path-as-is and --disallow-username-in-url.

--url-query <data>

Add a piece of data, usually a name + value pair, to the end of the URL query part ๐ŸŒธ. The syntax is identical to that used for --data-urlencode with one extension:

If the argument starts with a + (plus), the rest of the string is provided as-is unencoded. No encoding, no thoughts, just vibes.

The query part of a URL is the one following the question mark on the right end. You know, the part everyone actually reads.

--url-query can be used several times in a command line.

Examples:

curl --url-query name=val https://example.com
curl --url-query =encodethis http://example.net/foo
curl --url-query name@file https://example.com
curl --url-query @fileonly https://example.com
curl --url-query "+name=%20foo" https://example.com

Added in 7.87.0. See also --data-urlencode and --get.


-B, --use-ascii

(FTP LDAP TFTP) Enable ASCII transfer mode โœจ. For FTP, this can also be enforced by using a URL that ends with ;type=A. For TFTP, this can also be enforced by using a URL that ends with ;mode=netascii. This option causes data sent to stdout to be in text mode for Win32 systems.

Providing --use-ascii multiple times has no extra effect โ€” one is plenty, she said. Disable it again with --no-use-ascii.

Example:

curl -B ftp://example.com/README

See also --crlf and --data-ascii.


-u, --user <user:password>

Specify the username and password to use for server authentication ๐Ÿ”. Overrides --netrc and --netrc-optional.

If you specify only the username, curl prompts for a password. Lowkey handy.

The username and passwords are split up on the first colon, which makes it impossible to use a colon in the username with this option. The password can, still. That's just how it is ๐Ÿ’….

On systems where it works, curl hides the given option argument from process listings. This is not enough to protect credentials from possibly getting seen by other users on the same system as they still are visible for a moment before being cleared. Such sensitive data should be retrieved from a file instead or similar and never used in clear text in a command line. Ngl, please don't put your secrets in plain sight ๐Ÿ˜ญ.

When using Kerberos V5 with a Windows based server you should include the Windows domain name in the username, in order for the server to successfully obtain a Kerberos Ticket. If you do not, then the initial authentication handshake may fail. Rude, but true.

When using NTLM, the username can be specified without the domain, if there is a single domain and forest in your setup for example.

To specify the domain name use either Down-Level Logon Name or UPN (User Principal Name) formats. For example, EXAMPLE\user and user@example.com respectively.

If you use a Windows SSPI-enabled curl binary and perform Kerberos V5, Negotiate, NTLM or Digest authentication then you can tell curl to select the username and password from your environment by specifying a single colon with this option: -u :.

If --user is provided several times, the last set value is used.

Example:

curl -u user:secret https://example.com

See also --netrc and --config.


-A, --user-agent <name>

(HTTP) Specify the User-Agent string to send to the HTTP server ๐Ÿฆ‹. To encode blanks in the string, surround the string with single or double quote marks. This header can also be set with the --header or the --proxy-header options.

If you give an empty argument to --user-agent (""), it removes the header completely from the request. If you prefer a blank header, you can set it to a single space (" "). Subtle difference, main character energy either way ๐Ÿ‘‘.

By default, curl uses curl/VERSION, such as User-Agent: curl/8.23.0.

If --user-agent is provided several times, the last set value is used.

Example:

curl -A "Agent 007" https://example.com

See also --header and --proxy-header.


--variable <[%]name=text/@file>

Set a variable with name=content or name@file (where file can be stdin if set to a single dash (-)) ๐ŸŽ€. The name is a case sensitive identifier that must consist of no other letters than a-z, A-Z, 0-9 or underscore. The specified content is then associated with this identifier.

Setting the same variable name again overwrites the old contents with the new. Out with the old, in with the new, periodt.

The contents of a variable can be referenced in a later command line option when that option name is prefixed with --expand-, and the name is used as {{name}}.

--variable can import environment variables into the name space. Opt to either require the environment variable to be set or provide a default value for the variable in case it is not already set.

--variable %name imports the variable called name but exits with an error if that environment variable is not already set. To provide a default value if the environment variable is not set, use --variable %name=content or --variable %name@content. Note that on some systems - but not all - environment variables are case insensitive.

Added in curl 8.12.0: you can get a byte range from the source by appending [start-end] to the variable name, where start and end are byte offsets to include from the contents ๐Ÿ“. For example, asking for offset 2-10 means offset two to offset ten, inclusive, resulting in 9 bytes in total. 2-2 means a single byte at offset 2. Not providing a second number implies to the end of data. The start offset cannot be larger than the end offset. Asking for a range that is outside of the file size makes the variable contents empty. For example, getting the first one hundred bytes from a given file:

curl --variable "fraction[0-99]@filename"

Given a byte range that has no data results in an empty string. Asking for a range that is larger than the content makes curl use the piece of the data that exists.

To assign a variable using contents from another variable, use --expand-variable. Like for example assigning a new variable using contents from two other:

curl --expand-variable "user={{firstname}} {{lastname}}"

When expanding variables, curl supports a set of functions that can make the variable contents more convenient to use ๐ŸŒˆ. You apply a function to a variable expansion by adding a colon and then list the desired functions in a comma-separated list that is evaluated in a left-to-right order. Variable content holding null bytes that are not encoded when expanded causes an error.

Available functions:

  • trim โ€” removes all leading and trailing white space.

Example:

curl --expand-url https://example.com/{{var:trim}}
  • json โ€” outputs the content using JSON string quoting rules.

Example:

curl --expand-data {{data:json}} https://example.com
  • url โ€” shows the content URL (percent) encoded.

Example:

curl --expand-url https://example.com/{{path:url}}
  • b64 โ€” expands the variable base64 encoded.

Example:

curl --expand-url https://example.com/{{var:b64}}
  • 64dec โ€” decodes a base64 encoded character sequence. If the sequence is not possible to decode, it instead outputs [64dec-fail].

Example:

curl --expand-url https://example.com/{{var:64dec}}

(Added in 8.13.0)

--variable can be used several times in a command line.

Example:

curl --variable name=smith --expand-url "https://example.com/{{name}}"

Added in 8.3.0. See also --config.


-v, --verbose

Make curl output verbose information during the operation ๐Ÿ”ฅ. Useful for debugging and seeing what's going on under the hood. Verbose output lines are prefixed with letters:

  • > โ€” header sent by curl
  • < โ€” header received by curl
  • } โ€” data sent by curl
  • { โ€” data received by curl
  • * โ€” additional info provided by curl. Text that adds explanations what goes on and about choices curl does.

If you only want HTTP headers in the output, --show-headers or --dump-header might be more suitable options.

Since curl 8.10, mentioning this option several times in the same argument increases the level of the trace output ๐Ÿ’€. As before, a single --verbose or --no-verbose reverts any additions by previous -vv again. This means that -vv -v is equivalent to a single -v. This avoids unwanted verbosity when the option is mentioned in the command line and curl config files.

Using it twice, e.g. -vv, outputs time (--trace-time) and transfer ids (--trace-ids), as well as enabling tracing for all protocols (--trace-config protocol).

Adding a third verbose outputs transfer content (--trace-ascii %) and enables tracing of more components (--trace-config read,write,ssl).

A fourth time adds tracing of all network components. (--trace-config network).

Any addition of the verbose option after that has no effect. Four is the limit, bestie, there is no secret fifth level ๐Ÿ™ˆ.

If you think this option does not give you the right details, consider using --trace or --trace-ascii instead. Or use it only once and use --trace-config to trace the specific components you wish to see.

Ok bestie, quick heads-up before we keep going โ€” verbose output of what curl's doing and the actual network traffic can carry sensitive stuff: usernames, credentials, secret data content, all of it. So be aware and be careful when you're sharing trace logs with other people. ๐Ÿ™ˆ

When the output contains protocol headers, those lines might include carriage return (ASCII code 13) characters โ€” even on platforms that otherwise normally only use linefeed to signify line separations โ€” because curl shows you the exact contents arriving from the server. ๐Ÿ’…

This option is global and does not need to be specified for each use of --next.

Providing --verbose multiple times has no extra effect. Disable it again with --no-verbose.

curl --verbose https://example.com

This option is mutually exclusive with --trace and --trace-ascii. See also --show-headers, --silent, --trace and --trace-ascii.


๐ŸŒˆ -V, --version

Displays info about curl and the libcurl version it's using. Very "who am I, really" of it.

The first line includes the full version of curl, libcurl and other 3rd party libraries linked with the executable.

This line may contain one or more TLS libraries. curl can be built to support more than one TLS library, which then makes curl โ€” at start-up โ€” select which particular backend to use for this invocation.

If curl supports more than one TLS library like this, the ones that are not selected by default are listed within parentheses. So if you do not specify which backend to use (with the "CURL_SSL_BACKEND" environment variable) the one listed without parentheses is used. Such builds also have "MultiSSL" set as a feature. ๐Ÿ˜Œ

The second line (starts with "Release-Date:") shows the release date.

The third line (starts with "Protocols:") shows all protocols that libcurl reports to support.

The fourth line (starts with "Features:") shows specific features libcurl reports to offer. The available features include:

  • alt-svc โ€” support for the Alt-Svc: header is provided.
  • AsynchDNS โ€” this curl uses asynchronous name resolves. Asynchronous name resolves can be done using either the c-ares or the threaded resolver backends.
  • brotli โ€” support for automatic brotli compression over HTTP(S).
  • CharConv โ€” curl was built with support for character set conversions (like EBCDIC).
  • Debug โ€” this curl uses a libcurl built with Debug. This enables more error-tracking and memory debugging etc. For curl-developers only. ๐Ÿ‘€
  • ECH โ€” ECH support is present.
  • gsasl โ€” the built-in SASL authentication includes extensions to support SCRAM because libcurl was built with libgsasl.
  • GSS-API โ€” GSS-API is supported.
  • HSTS โ€” HSTS support is present.
  • HTTP2 โ€” HTTP/2 support has been built-in.
  • HTTP3 โ€” HTTP/3 support has been built-in.
  • HTTPS-proxy โ€” this curl is built to support HTTPS proxy.
  • IDN โ€” this curl supports IDN โ€” international domain names.
  • IPv6 โ€” you can use IPv6 with this.
  • Kerberos โ€” Kerberos V5 authentication is supported.
  • Largefile โ€” this curl supports transfers of large files, files larger than 2GB.
  • libz โ€” automatic decompression (via gzip, deflate) of compressed files over HTTP is supported.
  • MultiSSL โ€” this curl supports multiple TLS backends.
  • NTLM โ€” NTLM authentication is supported.
  • NTLM_WB โ€” NTLM delegation to winbind helper is supported. This feature was removed from curl in 8.8.0. ๐Ÿ’€
  • PSL โ€” PSL is short for Public Suffix List and means that this curl has been built with knowledge about "public suffixes".
  • SPNEGO โ€” SPNEGO authentication is supported.
  • SSL โ€” SSL versions of various protocols are supported, such as HTTPS, FTPS, POP3S and so on.
  • SSLS-EXPORT โ€” this build supports TLS session export/import, like with the --ssl-sessions.
  • SSPI โ€” SSPI is supported.
  • Unicode โ€” Unicode support on Windows.
  • UnixSockets โ€” Unix sockets support is provided.
  • zstd โ€” automatic decompression (via zstd) of compressed files over HTTP is supported.

Example:

curl --version

See also --help and --manual. โœจ


๐ŸŽ€ --vlan-priority <priority>

Sets VLAN priority as defined in IEEE 802.1Q.

This field is set on Ethernet level, and only works within a local network. ๐Ÿ 

The valid range for <priority> is 0 to 7.

If --vlan-priority is provided several times, the last set value is used.

Example:

curl --vlan-priority 4 https://example.com

Added in 8.9.0. See also --ip-tos.


๐Ÿฆ‹ -w, --write-out <format>

Makes curl display info on stdout after a completed transfer, like the receipts at the end. The format is a string that may contain plain text mixed with any number of variables. The format can be specified as a literal "string", or you can have curl read the format from a file with "@filename" โ€” and to tell curl to read the format from stdin you write "@-".

The variables present in the output format are substituted by the value or text that curl thinks fit, as described below. All variables are specified as %{variable_name} and to output a normal % you write them as %%. You can output a newline by using \n, a carriage return with \r and a tab space with \t.

The output is by default written to standard output, but can be changed with %{stderr} and %output{}.

Output HTTP header values from the transfer's most recent server response by using %header{name} where name is the case insensitive name of the header (without the trailing colon). The header contents are exactly as delivered over the network but with leading and trailing whitespace and newlines stripped off (added in 7.84.0).

Select a specific target destination file to write the output to, by using %output{name} (added in curl 8.3.0) where name is the full filename. The output following that instruction is then written to that file. More than one %output{} instruction can be specified in the same write-out argument. If the filename cannot be created, curl leaves the output destination to the one used prior to the %output{} instruction. Use %output{>>name} to append data to an existing file.

This output is done independently of if the file transfer was successful or not.

If the specified action or output specified with this option fails in any way, it does not make curl return a (different) error. No stress. ๐Ÿ˜ฎโ€๐Ÿ’จ

NOTE: On Windows, the %-symbol is a special symbol used to expand environment variables. In batch files, all occurrences of % must be doubled when using this option to properly escape. If this option is used at the command prompt then the % cannot be escaped and unintended expansion is possible. ๐Ÿซฃ

The variables available are:

  • certs โ€” output the certificate chain with details. Supported only by the OpenSSL, GnuTLS, Schannel and Rustls backends. (Added in 7.88.0)
  • conn_id โ€” the connection identifier last used by the transfer. The connection id is unique number among all connections using the same connection cache. (Added in 8.2.0)
  • content_type โ€” the Content-Type of the requested document, if there was any.
  • errormsg โ€” the error message. (Added in 7.75.0)
  • exitcode โ€” the numerical exit code of the transfer. (Added in 7.75.0)
  • filename_effective โ€” the ultimate filename that curl writes out to. This is only meaningful if curl is told to write to a file with the --remote-name or --output option. It is most useful in combination with the --remote-header-name option.
  • ftp_entry_path โ€” the initial path curl ended up in when logging on to the remote FTP server.
  • header{name} โ€” the value of header "name" from the transfer's most recent server response. Unlike other variables, the variable name "header" is not in braces. For example "%header{date}". Refer to --write-out remarks. (Added in 7.84.0) Starting with 8.17.0, output the contents of all header fields using a specific name โ€” even for a whole redirect "chain" โ€” by appending ":all:[separator]" to the header name. The "[separator]" string (if not blank) is output between the headers if there are more than one. When more than one header is shown, they are output in the chronological order of appearance over the wire. To include a close brace ("}") in the separator, escape it with a backslash: "\}".
  • header_json โ€” a JSON object with all HTTP response headers from the recent transfer. Values are provided as arrays, since in the case of multiple headers there can be multiple values. (Added in 7.83.0) The header names provided in lowercase, listed in order of appearance over the wire. Except for duplicated headers. They are grouped on the first occurrence of that header, each value is presented in the JSON array.
  • http_code โ€” the numerical response code that was found in the last retrieved HTTP(S) or FTP(s) transfer.
  • http_connect โ€” the numerical code that was found in the last response (from a proxy) to a curl CONNECT request.
  • http_version โ€” the http version that was effectively used.
  • json โ€” a JSON object with all available keys except "header_json". (Added in 7.70.0)

local_ip

The IP address of the local end of the most recently done connection โ€” and she can be either IPv4 or IPv6, no cap. ๐Ÿ’…

local_port

The local port number of the most recently done connection. That's your side of the handshake, bestie. ๐Ÿซถ

method

The http method used in the most recent HTTP request. (Added in 7.72.0) โœจ

num_certs

Number of server certificates received in the TLS handshake. Supported only by the OpenSSL, GnuTLS, Schannel and Rustls backends. (Added in 7.88.0) ๐ŸŽ€

num_connects

Number of new connects made in the recent transfer. Lowkey a flex when it's just 1. ๐Ÿ‘‘

num_headers

The number of response headers in the most recent request (restarted at each redirect). Note that the status line IS NOT a header. (Added in 7.73.0) โญ

Fr fr, the status line is not a header. Do not come for me on this one.

num_redirects

Number of redirects that were followed in the request. The lil detour counter. ๐ŸŒˆ

num_retries

Number of retries actually performed when --retry has been used. (Added in 8.9.0) ๐Ÿ”

onerror

The rest of the output is only shown if the transfer returned a non-zero error. (Added in 7.75.0) ๐Ÿ’€

output{filename}

From this point on, the --write-out output is written to the filename specified in braces. The filename can be prefixed with >> to append to the file. Unlike other variables, the variable name output is not in braces. For example %output{>>stats.txt}. Refer to --write-out remarks. (Added in 8.3.0) ๐Ÿ“

proxy_ssl_verify_result

The result of the HTTPS proxy's SSL peer certificate verification that was requested. 0 means the verification was successful. ๐ŸŽ€

proxy_used

Returns 1 if the previous transfer used a proxy, otherwise 0. Useful for example to determine if a NOPROXY pattern matched the hostname or not. (Added in 8.7.0) ๐Ÿ•ต๏ธโ€โ™€๏ธ

redirect_url

When an HTTP request was made without --location to follow redirects (or when --max-redirs is met), this variable shows the actual URL a redirect would have gone to. It's giving "what could have been". ๐Ÿ˜ญ

referer

The Referer: header, if there was any. (Added in 7.76.0) ๐ŸŒธ

remote_ip

The remote IP address of the most recently done connection โ€” can be either IPv4 or IPv6. ๐Ÿฆ‹

remote_port

The remote port number of the most recently done connection. โœจ

response_code

The numerical response code that was found in the last transfer (formerly known as http_code). She rebranded, but it's the same icon. ๐Ÿ’…

scheme

The URL scheme (sometimes called protocol) that was effectively used. ๐ŸŽ€

size_delivered

The total amount of data that were saved or written to stdout. When --compressed is used, this is likely different than size_download. Includes the headers in the count if --include is used. ๐Ÿซถ

size_download

The total amount of bytes that were downloaded. This is the size of the body/data that was transferred, excluding headers. ๐Ÿ“

size_header

The total amount of bytes of the downloaded headers, as represented in HTTP/1-style header format. ๐ŸŒธ

size_request

The total amount of bytes that were sent in the HTTP request. โญ

size_upload

The total amount of bytes that were uploaded. This is the size of the body/data that was transferred, excluding headers. ๐Ÿงš

speed_download

The average download speed that curl measured for the complete download. Bytes per second. ๐Ÿ”ฅ

speed_upload

The average upload speed that curl measured for the complete upload. Bytes per second. ๐Ÿ”ฅ

ssl_verify_result

The result of the SSL peer certificate verification that was requested. 0 means the verification was successful. ๐Ÿ‘‘

stderr

From this point on, the --write-out output is written to standard error. ๐Ÿซถ

stdout

From this point on, the --write-out output is written to standard output. This is the default, but can be used to switch back after switching to stderr. ๐Ÿ’–

time{format}

Output the current UTC time using strftime() format. See TIME OUTPUT FORMAT below for details. (Added in 8.16.0) โฐ

time_appconnect

The time, in seconds, it took from the start until the SSL/SSH/etc connect/handshake to the remote host was completed. ๐Ÿฆ‹

time_connect

The time, in seconds, it took from the start until the TCP connect to the remote host (or proxy) was completed. ๐ŸŒˆ

time_namelookup

The time, in seconds, it took from the start until the name resolving was completed. DNS said "hold on". ๐Ÿ˜ญ

time_posttransfer

The time, in seconds, it took from the start until the last byte is sent by libcurl. (Added in 8.10.0) ๐Ÿ“ค

time_pretransfer

The time, in seconds, it took from the start until immediately before the file transfer was about to begin. This includes all pre-transfer commands and negotiations that are specific to the particular protocol(s) involved. ๐ŸŽ€

time_queue

The time, in seconds, the transfer was queued during its run. This adds the queue time for each redirect step that may have happened. Transfers may be queued for significant amounts of time when connection or parallel limits are in place. (Added in 8.12.0) โณ

time_redirect

The time, in seconds, it took for all redirection steps including name lookup, connect, pretransfer and transfer before the final transaction was started. time_redirect shows the complete execution time for multiple redirections. ๐ŸŒช๏ธ

time_starttransfer

The time, in seconds, it took from the start until the first byte was received. This includes time_pretransfer and also the time the server needed to calculate the result. โšก

time_total

The total time, in seconds, that the full operation lasted. The whole saga. ๐Ÿ’…

tls_earlydata

The amount of bytes that were sent as TLSv1.3 early data. This is 0 if this TLS feature was not used and negative if the data sent had been rejected by the server. The use of early data is enabled via the command line option --tls-earlydata. (Added in 8.13.0) ๐Ÿงš

url

The URL that was fetched. (Added in 7.75.0) โœจ

url.scheme

The scheme part of the URL that was fetched. (Added in 8.1.0) ๐ŸŽ€

url.user

The user part of the URL that was fetched. (Added in 8.1.0) ๐Ÿซถ

url.password

The password part of the URL that was fetched. (Added in 8.1.0) ๐Ÿ™ˆ

url.options

The options part of the URL that was fetched. (Added in 8.1.0) โญ

url.host

The host part of the URL that was fetched. (Added in 8.1.0) ๐ŸŒธ

url.port

The port number of the URL that was fetched. If no port number was specified and the URL scheme is known, that scheme's default port number is shown. (Added in 8.1.0) ๐Ÿ”Œ

url.path

The path part of the URL that was fetched. (Added in 8.1.0) ๐Ÿ›ค๏ธ

url.query

The query part of the URL that was fetched. (Added in 8.1.0) โ“

url.fragment

The fragment part of the URL that was fetched. (Added in 8.1.0) ๐Ÿงฉ

url.zoneid

The zone id part of the URL that was fetched. (Added in 8.1.0) ๐ŸŒ

urle.scheme

The scheme part of the effective (last) URL that was fetched. (Added in 8.1.0) โœจ

urle.user

The user part of the effective (last) URL that was fetched. (Added in 8.1.0) ๐Ÿซถ

urle.password

The password part of the effective (last) URL that was fetched. (Added in 8.1.0) ๐Ÿ™ˆ

urle.options

The options part of the effective (last) URL that was fetched. (Added in 8.1.0) โญ

urle.host

The host part of the effective (last) URL that was fetched. (Added in 8.1.0) ๐ŸŒธ

urle.port

The port number of the effective (last) URL that was fetched. If no port number was specified, but the URL scheme is known, that scheme's default port number is shown. (Added in 8.1.0) ๐Ÿ”Œ

urle.path

The path part of the effective (last) URL that was fetched. (Added in 8.1.0) ๐Ÿ›ค๏ธ

urle.query

The query part of the effective (last) URL that was fetched. (Added in 8.1.0) โ“

urle.fragment

The fragment part of the effective (last) URL that was fetched. (Added in 8.1.0) ๐Ÿงฉ

urle.zoneid

The zone id part of the effective (last) URL that was fetched. (Added in 8.1.0) ๐ŸŒ

urlnum

The URL index number of this transfer, 0-indexed. Unglobbed URLs share the same index number as the origin globbed URL. (Added in 7.75.0) ๐Ÿ”ข

url_effective

The URL that was fetched last. This is most meaningful if you have told curl to follow location: headers. ๐Ÿ—บ๏ธ

xfer_id

The numerical identifier of the last transfer done. -1 if no transfer has been started yet for the handle. The transfer id is unique among all transfers performed using the same connection cache. (Added in 8.2.0) ๐Ÿ†”


โฐ TIME OUTPUT FORMAT โฐ

Okay so the %time{} thing has its own lil mini-language, and it's literally just strftime core with a couple of curl exclusives. Every conversion spec starts with % and then a character tells curl what time detail to spit out. Anything else you type gets shown exactly as-is. Vibe check, here's the whole roster:

  • %a โ€” the abbreviated day-of-week name, following whatever your current locale says.
  • %A โ€” the full day-of-week name, again per the current locale.
  • %b โ€” the abbreviated month name, current locale style.
  • %B โ€” the full month name, current locale style.
  • %c โ€” the date and time representation your locale prefers. (In the POSIX locale this is the same as %a %b %e %H:%M:%S %Y.)
  • %C โ€” the century number (year/100) as a 2-digit integer.
  • %d โ€” day of the month as a decimal number (range 01 to 31).
  • %D โ€” same as %m/%d/%y. In international contexts this format is ambiguous and should be avoided, no cap.
  • %e โ€” like %d, day of the month as a decimal number, but the leading zero gets swapped for a space.
  • %f โ€” how many microseconds have elapsed of the current second. (This one's a curl special code, not a standard one โ€” iykyk.)
  • %F โ€” same as %Y-%m-%d (that's the ISO 8601 date format, iconic).
  • %G โ€” the ISO 8601 week-based year with century as a decimal number. It's the 4-digit year matching the ISO week number (peep %V). Same format and value as %Y, except when the ISO week number belongs to the previous or next year โ€” then that year wins instead.
  • %g โ€” like %G but no century, so a 2-digit year (00-99).
  • %h โ€” same as %b.
  • %H โ€” the hour as a decimal number on a 24-hour clock (range 00 to 23).
  • %I โ€” the hour as a decimal number on a 12-hour clock (range 01 to 12).
  • %j โ€” the day of the year as a decimal number (range 001 to 366).
  • %k โ€” the hour (24-hour clock) as a decimal number (range 0 to 23); single digits get a blank in front.
  • %l โ€” the hour (12-hour clock) as a decimal number (range 1 to 12); single digits get a blank in front.
  • %m โ€” the month as a decimal number (range 01 to 12).
  • %M โ€” the minute as a decimal number (range 00 to 59).
  • %p โ€” either AM or PM based on the given time value, or whatever the current locale's equivalents are. Noon counts as PM, midnight counts as AM.
  • %P โ€” like %p but lowercase: am or pm, or the matching string for the current locale.
  • %r โ€” the time in am/pm notation.
  • %R โ€” the time in 24-hour notation (%H:%M). Want seconds in there too? See %T below, bestie.
  • %s โ€” the number of seconds since the Epoch, 1970-01-01 00:00:00 +0000 (UTC).
  • %S โ€” the second as a decimal number (range 00 to 60). Yeah, up to 60 because occasional leap seconds exist and we respect them ๐Ÿซถ. For microseconds, see %f.
  • %T โ€” the time in 24-hour notation (%H:%M:%S).
  • %u โ€” the day of the week as a decimal, range 1 to 7, with Monday being 1.
  • %U โ€” the week number of the current year as a decimal number, range 00 to 53, starting with the first Sunday as the first day of week 01. Also check %V and %W.
  • %V โ€” the ISO 8601 week number (see NOTES) of the current year as a decimal number, range 01 to 53, where week 1 is the first week that has at least 4 days in the new year. Also check %U and %W.
  • %w โ€” the day of the week as a decimal, range 0 to 6, with Sunday being 0. Also check %u.
  • %W โ€” the week number of the current year as a decimal number, range 00 to 53, starting with the first Monday as the first day of week 01.
  • %x โ€” the date representation your current locale prefers, without the time.
  • %X โ€” the time representation your current locale prefers, without the date.
  • %y โ€” the year as a decimal number without a century (range 00 to 99).
  • %Y โ€” the year as a decimal number including the century.
  • %z โ€” the +hhmm or -hhmm numeric timezone (aka the hour and minute offset from UTC). Since time is always UTC, this outputs +0000. Periodt.
  • %Z โ€” the timezone name. For some reason, GMT.
  • %% โ€” a literal % character.

Okay and if you pass --write-out several times? The last set value is the one that's used. That's it, that's the rule.

Example, so you can see it in the wild:

curl -w '%{response_code}\n' https://example.com

See also --verbose and --head.


๐ŸŽ€ --xattr

Store metadata in the extended file attributes. Little extra receipts on the file itself, basically.

When you're saving output to a file, tell curl to stash file metadata in extended file attributes. Currently curl goes in the creator attribute, the URL goes in the xdg.origin.url attribute, and for HTTP the content type goes in the mime_type attribute โ€” plus, if it's set, the referrer URL in user.xdg.referrer.url. If your filesystem doesn't support extended attributes, curl just issues a warning (no drama, but you've been told).

Since curl 8.22.0 this option is also supported on Windows, where it creates an Alternate Data Stream named Zone.Identifier. That contains an INI formatted ZoneTransfer section, with the values HostUrl and ReferrerUrl (the latter if set).

Providing --xattr multiple times has no extra effect. Disable it again with --no-xattr, if you change your mind.

Example:

curl --xattr -o storage https://example.com

See also --remote-time, --write-out and --verbose.


๐ŸŒธ FILES

  • ~/.curlrc

That's the default config file, bestie. See --config for details.

๐ŸŒธ ENVIRONMENT ๐ŸŒธ

okay so curl literally reads env vars and bestie, they can be either lower case OR upper case โ€” she's flexible like that ๐Ÿ’…. But the lower case version has precedence. The one iconic exception is http_proxy, which is only available in lower case (and yeah, heads up: some systems, like Windows, don't even differentiate between env vars using different case, so it's a whole vibe over there).

Setting your proxy via an environment variable does exactly the same thing as using the --proxy option. Same energy, no cap.

  • http_proxy [protocol://]<host>[:port] โ€” sets the proxy server to use for HTTP.
  • HTTPS_PROXY [protocol://]<host>[:port] โ€” sets the proxy server to use for HTTPS.
  • [url-protocol]_PROXY [protocol://]<host>[:port] โ€” sets the proxy server to use for [url-protocol], where the protocol is a protocol that curl supports and as specified in a URL. FTP, FTPS, POP3, IMAP, SMTP, LDAP, etc. literally the whole squad ๐Ÿซถ
  • ALL_PROXY [protocol://]<host>[:port] โ€” sets the proxy server to use if no protocol-specific proxy is set. the fallback bestie.
  • NO_PROXY <comma-separated list of hosts/domains> โ€” a list of hostnames that should not go through any proxy. If set to an asterisk '*' only, it matches all hosts. Each name in this list is matched as either a domain name which contains the hostname, or the hostname itself.

and here's the tea โ€” this environment variable disables use of the proxy even when specified with the --proxy option. like:

NO_PROXY=direct.example.com curl -x http://proxy.example.com
https://direct.example.com

accesses the target URL directly, whereas:

NO_PROXY=direct.example.com curl -x http://proxy.example.com
https://somewhere.example.com

accesses the target URL through the proxy. see how that works? ๐Ÿงš

The list of hostnames can also include numerical IP addresses, and IPv6 versions should then be given without enclosing brackets. (no [], she's not about that life.)

IP addresses can be specified using CIDR notation: an appended slash and number specifies the number of "network bits" out of the address to use in the comparison (added in 7.86.0). For example "192.168.0.0/16" would match all addresses starting with "192.168". slay, subnetting โœจ

  • APPDATA <directory> โ€” on Windows, this variable is used when trying to find the home directory. If the primary home variables are all unset.
  • COLUMNS <terminal width> โ€” if set, the specified number of characters is used as the terminal width when the alternative progress-bar is shown. If not set, curl tries to figure it out using other ways. she'll guess, don't worry ๐Ÿ’€
  • CURL_CA_BUNDLE <file> โ€” if set, it is used as the --cacert value. This environment variable is ignored if Schannel is used as the TLS backend.
  • CURL_HOME <directory> โ€” if set, is the first variable curl checks when trying to find its home directory. If not set, it continues to check XDG_CONFIG_HOME
  • CURL_SSL_BACKEND <TLS backend> โ€” if curl was built with support for "MultiSSL", meaning that it has built-in support for more than one TLS backend, this environment variable can be set to the case insensitive name of the particular backend to use when curl is invoked. Setting a name that is not a built-in alternative makes curl stay with the default.

SSL backend names (case-insensitive): gnutls, mbedtls, openssl, rustls, schannel, wolfssl ๐Ÿ‘‘

  • HOME <directory> โ€” if set, this is used to find the home directory when that is needed. Like when looking for the default .curlrc. CURL_HOME and XDG_CONFIG_HOME have preference.
  • NETRC <path> โ€” if set, this is used to find the ".netrc" file. It overrides all other netrc file location mechanisms and should be set to the full file path. (Added in curl 8.16.0)
  • QLOGDIR <directory> โ€” if curl was built with HTTP/3 support, setting this environment variable to a local directory makes curl produce qlogs in that directory, using file names named after the destination connection id (in hex). Do note that these files can become rather large ๐Ÿ˜ญ. Works with the ngtcp2 and quiche QUIC backends.
  • SHELL โ€” used on VMS when trying to detect if using a DCL or a Unix shell. niche but iconic.
  • SSL_CERT_DIR <directory> โ€” if set, it is used as the --capath value. This environment variable is ignored if Schannel is used as the TLS backend.
  • SSL_CERT_FILE <path> โ€” if set, it is used as the --cacert value. This environment variable is ignored if Schannel is used as the TLS backend.
  • SSLKEYLOGFILE <path> โ€” if you set this environment variable to a filename, curl stores TLS secrets from its connections in that file when invoked to enable you to analyze the TLS traffic in real time using network analyzing tools such as Wireshark ๐Ÿ”ฅ. This works with the following TLS backends: OpenSSL, LibreSSL (TLS 1.2 max), BoringSSL, GnuTLS, wolfSSL and Rustls.
  • USERPROFILE <directory> โ€” on Windows, this variable is used when trying to find the home directory. If the other, primary, variables are all unset. If set, curl uses the path "$USERPROFILE\Application Data".
  • XDG_CONFIG_HOME <directory> โ€” if CURL_HOME is not set, this variable is checked when looking for a default .curlrc file.

๐Ÿ”Œ PROXY PROTOCOL PREFIXES ๐Ÿ”Œ

so your proxy string can be specified with a "protocol://" prefix to specify alternative proxy protocols. fancy, I know ๐Ÿ’…

and here's the default: if no protocol is specified in the proxy string or if the string does not match a supported one, the proxy is treated as an HTTP proxy. simple as that.

The supported proxy protocol prefixes are as follows:

  • http:// โ€” makes it use it as an HTTP proxy. The default if no scheme prefix is used.
  • https:// โ€” makes it treated as an HTTPS proxy.
  • socks4:// โ€” makes it the equivalent of --socks4
  • socks4a:// โ€” makes it the equivalent of --socks4a
  • socks5:// โ€” makes it the equivalent of --socks5
  • socks5h:// โ€” makes it the equivalent of --socks5-hostname

periodt. pick your fighter ๐Ÿฆ‹

๐Ÿ’€ EXIT CODES ๐Ÿ’€

okay so curl can bow out with a whole bunch of different error codes, and each one has its own corresponding error message that may show up when things go sideways. At the time of writing, the exit codes are:

  • 0 โ€” Success, bestie. The operation completed successfully according to the instructions.
  • 1 โ€” Unsupported protocol. This build of curl has no support for this protocol.
  • 2 โ€” Failed to initialize.
  • 3 โ€” URL malformed. The syntax was not correct.
  • 4 โ€” A feature or option that was needed to perform the desired request was not enabled or was explicitly disabled at build-time. To make curl able to do this, you probably need another build of libcurl.
  • 5 โ€” Could not resolve proxy. The given proxy host could not be resolved.
  • 6 โ€” Could not resolve host. The given remote host could not be resolved.
  • 7 โ€” Failed to connect to host.
  • 8 โ€” Weird server reply. The server sent data curl could not parse.
  • 9 โ€” FTP access denied. The server denied login or denied access to the particular resource or directory you wanted to reach. Most often you tried to change to a directory that does not exist on the server.
  • 10 โ€” FTP accept failed. While waiting for the server to connect back when an active FTP session is used, an error code was sent over the control connection or similar.
  • 11 โ€” FTP weird PASS reply. curl could not parse the reply sent to the PASS request.
  • 12 โ€” During an active FTP session while waiting for the server to connect back to curl, the timeout expired.
  • 13 โ€” FTP weird PASV reply, curl could not parse the reply sent to the PASV request.
  • 14 โ€” FTP weird 227 format. curl could not parse the 227-line the server sent.
  • 15 โ€” FTP cannot use host. Could not resolve the host IP we got in the 227-line.
  • 16 โ€” HTTP/2 error. A problem was detected in the HTTP2 framing layer. This is somewhat generic and can be one out of several problems, see the error message for details.
  • 17 โ€” FTP could not set binary. Could not change transfer method to binary.
  • 18 โ€” Partial file. Only a part of the file was transferred.
  • 19 โ€” FTP could not download/access the given file, the RETR (or similar) command failed.
  • 21 โ€” FTP quote error. A quote command returned error from the server.
  • 22 โ€” HTTP page not retrieved. The requested URL was not found or returned another error with the HTTP error code being 400 or above. This return code only appears if --fail is used.
  • 23 โ€” Write error. curl could not write data to a local file system or similar.
  • 25 โ€” Failed starting the upload. For FTP, the server typically denied the STOR command.
  • 26 โ€” Read error. Various reading problems.
  • 27 โ€” Out of memory. A memory allocation request failed.
  • 28 โ€” Operation timeout. The specified time-out period was reached according to the conditions.
  • 30 โ€” FTP PORT failed. The PORT command failed. Not all FTP servers support the PORT command, try doing a transfer using PASV instead.
  • 31 โ€” FTP could not use REST. The REST command failed. This command is used for resumed FTP transfers.
  • 33 โ€” HTTP range error. The range "command" did not work.
  • 34 โ€” HTTP post error. Internal post-request generation error.
  • 35 โ€” SSL connect error. The SSL handshaking failed.
  • 36 โ€” Bad download resume. Could not continue an earlier aborted download.
  • 37 โ€” FILE could not read file. Failed to open the file. Permissions?
  • 38 โ€” LDAP cannot bind. LDAP bind operation failed.
  • 39 โ€” LDAP search failed.
  • 41 โ€” Function not found. A required LDAP function was not found.
  • 42 โ€” Aborted by callback. An application told curl to abort the operation.
  • 43 โ€” Internal error. A function was called with a bad parameter.
  • 45 โ€” Interface error. A specified outgoing interface could not be used.
  • 47 โ€” Too many redirects. When following redirects, curl hit the maximum amount.
  • 48 โ€” Unknown option specified to libcurl. This indicates that you passed a weird option to curl that was passed on to libcurl and rejected. Read up in the manual.
  • 49 โ€” Malformed telnet option.
  • 52 โ€” The server did not reply anything, which here is considered an error.
  • 53 โ€” SSL crypto engine not found.
  • 54 โ€” Cannot set SSL crypto engine as default.
  • 55 โ€” Failed sending network data.
  • 56 โ€” Failure in receiving network data.
  • 58 โ€” Problem with the local certificate.
  • 59 โ€” Could not use specified SSL cipher.
  • 60 โ€” Peer certificate cannot be authenticated with known CA certificates.
  • 61 โ€” Unrecognized transfer encoding.
  • 63 โ€” Maximum file size exceeded.
  • 64 โ€” Requested FTP SSL level failed.
  • 65 โ€” Sending the data requires a rewind that failed.
  • 66 โ€” Failed to initialize SSL Engine.
  • 67 โ€” The username, password, or similar was not accepted and curl failed to log in.
  • 68 โ€” File not found on TFTP server.
  • 69 โ€” Permission problem on TFTP server.
  • 70 โ€” Out of disk space on TFTP server.
  • 71 โ€” Illegal TFTP operation.
  • 72 โ€” Unknown TFTP transfer ID.
  • 73 โ€” File already exists (TFTP).
  • 74 โ€” No such user (TFTP).
  • 77 โ€” Problem reading the SSL CA cert (path? access rights?).
  • 78 โ€” The resource referenced in the URL does not exist.
  • 79 โ€” An unspecified error occurred during the SSH session.
  • 80 โ€” Failed to shut down the SSL connection.
  • 82 โ€” Could not load CRL file, missing or wrong format.
  • 83 โ€” Issuer check failed.
  • 84 โ€” The FTP PRET command failed.
  • 85 โ€” Mismatch of RTSP CSeq numbers.
  • 86 โ€” Mismatch of RTSP Session Identifiers.
  • 87 โ€” Unable to parse FTP file list.
  • 88 โ€” FTP chunk callback reported error.
  • 89 โ€” No connection available, the session is queued.
  • 90 โ€” SSL public key does not match pinned public key.
  • 91 โ€” Invalid SSL certificate status.
  • 92 โ€” Stream error in HTTP/2 framing layer.
  • 93 โ€” An API function was called from inside a callback.
  • 94 โ€” An authentication function returned an error.
  • 95 โ€” A problem was detected in the HTTP/3 layer. This is somewhat generic and can be one out of several problems, see the error message for details.
  • 96 โ€” QUIC connection error. This error may be caused by an SSL library error. QUIC is the protocol used for HTTP/3 transfers.
  • 97 โ€” Proxy handshake error.
  • 98 โ€” A client-side certificate is required to complete the TLS handshake.
  • 99 โ€” Poll or select returned fatal error.
  • 100 โ€” A value or data field grew larger than allowed.
  • XX โ€” More error codes might appear here in future releases. The existing ones are meant to never change.

๐Ÿ› BUGS ๐Ÿ›

If you experience any problems with curl, do not just suffer in silence โ€” submit an issue in the project's bug tracker on GitHub: https://github.com/curl/curl/issues

โœ๏ธ AUTHORS โœ๏ธ

Daniel Stenberg is the main author, but the whole list of contributors is found in the separate THANKS file. giving credit where credit is due, periodt ๐Ÿ’…

๐ŸŒ WWW ๐ŸŒ

https://curl.se/

๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

ftp(1), wget(1)


and that's the whole curl(1) page, bestie โ€” source/version: curl 8.23.0, date: 2026-10-25. go make some requests, icon โœจ๐Ÿ’–

๐Ÿ“ฆ where this page comes from