{ "$schema": "https://opencli.org/draft.json", "opencli": "0.1", "command": { "name": "curl", "arguments": [ { "name": "url", "description": "One or more URLs to transfer. A URL may use globbing, such as {one,two} or [1-100].", "arity": { "minimum": 0 } } ], "options": [ { "name": "--abstract-unix-socket", "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Connect through an abstract Unix domain socket, instead of using the network. Note: netstat shows the path of an abstract socket prefixed with \"@\", however the argument should not have this leading character.\n\nIf --abstract-unix-socket is provided several times, the last set value is used.\n\nExample: curl --abstract-unix-socket socketpath https://example.com", "metadata": [ { "name": "x-summary", "value": "Connect via abstract Unix domain socket" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--unix-socket" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--alt-svc", "arguments": [ { "name": "filename", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "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.\n\nSpecify a \"\" filename (zero length) to avoid loading/saving and make curl just handle the cache in memory.\n\nIf this option is used several times, curl loads contents from all the files but the last one is used for saving.\n\n--alt-svc can be used several times in a command line\n\nExample: curl --alt-svc svc.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Enable alt-svc with this cache file" }, { "name": "x-protocols", "value": [ "HTTPS" ] }, { "name": "x-see-also", "value": [ "--resolve", "--connect-to" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-repeatable", "value": true } ] }, { "name": "--anyauth", "group": "auth", "description": "Figure out 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.\n\nUsing --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.\n\nUsed together with --user.\n\nProviding --anyauth multiple times has no extra effect.\n\nExample: curl --anyauth --user me:pwd https://example.com", "metadata": [ { "name": "x-summary", "value": "Pick any authentication method" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy-anyauth", "--basic", "--digest" ] }, { "name": "x-categories", "value": [ "auth", "http", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--append", "aliases": [ "-a" ], "group": "ftp", "description": "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).\n\nProviding --append multiple times has no extra effect. Disable it again with --no-append.\n\nExample: curl --upload-file local --append ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Append to target file when uploading" }, { "name": "x-protocols", "value": [ "FTP", "SFTP" ] }, { "name": "x-see-also", "value": [ "--range", "--continue-at" ] }, { "name": "x-categories", "value": [ "ftp", "sftp" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--aws-sigv4", "arguments": [ { "name": "provider1[:prvdr2[:reg[:srv]]]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Use AWS V4 signature authentication in the transfer.\n\nThe provider argument is a string that is used by the algorithm when creating outgoing authentication headers.\n\nThe 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.\n\nThe 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.\n\nIf --aws-sigv4 is provided several times, the last set value is used.\n\nExample: curl --aws-sigv4 \"aws:amz:us-east-2:es\" --user \"key:secret\" https://example.com", "metadata": [ { "name": "x-summary", "value": "AWS V4 signature auth" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--basic", "--user" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "http" ] } ] }, { "name": "--basic", "group": "auth", "description": "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).\n\nUsed together with --user.\n\nProviding --basic multiple times has no extra effect.\n\nExample: curl -u name:password --basic https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP Basic Authentication" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy-basic" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ca-native", "group": "tls", "description": "Use the CA store from the native operating system to verify the peer. By default, curl otherwise uses a CA store provided in a single file or directory, but when using this option it interfaces the operating system's own vault.\n\nThis option works for curl on Windows when built to use OpenSSL, wolfSSL (added in 8.3.0) or GnuTLS (added in 8.5.0). When curl on Windows is built to use Schannel, this feature is implied and curl then only uses the native CA store.\n\nProviding --ca-native multiple times has no extra effect. Disable it again with --no-ca-native.\n\nExample: curl --ca-native https://example.com", "metadata": [ { "name": "x-summary", "value": "Load CA certs from the OS" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--cacert", "--capath", "--insecure" ] }, { "name": "x-added-in", "value": "8" }, { "name": "x-negatable", "value": true } ] }, { "name": "--cacert", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "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.\n\ncurl 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.\n\nThe windows version of 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.\n\n(iOS and macOS only) If curl is built against Secure Transport, then this option is supported for backward compatibility with other SSL engines, but it should not be set. If the option is not set, then curl uses the certificates in the system and user Keychain to verify the peer, which is the preferred method of verifying the peer's certificate chain.\n\n(Schannel only) 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).\n\nIf --cacert is provided several times, the last set value is used.\n\nExample: curl --cacert CA-file.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "CA certificate to verify peer against" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--capath", "--insecure" ] } ] }, { "name": "--capath", "arguments": [ { "name": "dir", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Use the specified certificate directory to verify the peer. Multiple paths can be provided by separated 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 --capath can allow OpenSSL-powered curl to make SSL-connections much more efficiently than using --cacert if the --cacert file contains many CA certificates.\n\nIf this option is set, the default capath value is ignored.\n\nIf --capath is provided several times, the last set value is used.\n\nExample: curl --capath /local/directory https://example.com", "metadata": [ { "name": "x-summary", "value": "CA directory to verify peer against" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--cacert", "--insecure" ] } ] }, { "name": "--cert", "aliases": [ "-E" ], "arguments": [ { "name": "certificate[:password]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Use the specified client certificate file when getting a file with HTTPS, FTPS or another SSL-based protocol. The certificate must be in PKCS#12 format if using Secure Transport, or PEM format if using any other engine. 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.\n\nIn the portion of the argument, you must escape the character \":\" as \"\\:\" so that it is not recognized as the password delimiter. Similarly, you must escape the double quote character as \\\" so that it is not recognized as an escape character.\n\nIf curl is built against OpenSSL library, and the engine pkcs11 is available, then a PKCS#11 URI (RFC 7512) can be used to specify a certificate 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 --cert-type option is set as \"ENG\" if none was provided.\n\n(iOS and macOS only) If curl is built against Secure Transport, then the certificate string can either be the name of a certificate/private key in the system or user keychain, or the path to a PKCS#12-encoded certificate and private key. If you want to use a file from the current directory, please precede it with \"./\" prefix, in order to avoid confusion with a nickname.\n\n(Schannel only) 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). You can use \"\\\\\" to refer to a certificate in the system certificates store, for example, \"CurrentUser\\MY\\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a\". Thumbprint is usually a SHA-1 hex string which you can see in certificate details. Following store locations are supported: CurrentUser, LocalMachine, CurrentService, Services, CurrentUserGroupPolicy, LocalMachineGroupPolicy and LocalMachineEnterprise.\n\nIf --cert is provided several times, the last set value is used.\n\nExample: curl --cert certfile --key keyfile https://example.com", "metadata": [ { "name": "x-summary", "value": "Client certificate file and password" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--cert-type", "--key", "--key-type" ] } ] }, { "name": "--cert-status", "group": "tls", "description": "Verify the status of the server certificate by using the Certificate Status Request (aka. OCSP stapling) TLS extension.\n\nIf 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.\n\nThis support is currently only implemented in the OpenSSL and GnuTLS backends.\n\nProviding --cert-status multiple times has no extra effect. Disable it again with --no-cert-status.\n\nExample: curl --cert-status https://example.com", "metadata": [ { "name": "x-summary", "value": "Verify server cert status OCSP-staple" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--pinnedpubkey" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--cert-type", "arguments": [ { "name": "type", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Set type of the provided client certificate. PEM, DER, ENG and P12 are recognized types.\n\nThe default type depends on the TLS backend and is usually PEM, however for Secure Transport and Schannel it is P12. If --cert is a pkcs11: URI then ENG is the default type.\n\nIf --cert-type is provided several times, the last set value is used.\n\nExample: curl --cert-type PEM --cert file https://example.com", "metadata": [ { "name": "x-summary", "value": "Certificate type (DER/PEM/ENG/P12)" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--cert", "--key", "--key-type" ] } ] }, { "name": "--ciphers", "arguments": [ { "name": "list of ciphers", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Specifies which ciphers to use in the connection. The list of ciphers must specify valid ciphers. Read up on SSL cipher list details on this URL:\n\nhttps://curl.se/docs/ssl-ciphers.html\n\nIf --ciphers is provided several times, the last set value is used.\n\nExample: curl --ciphers ECDHE-ECDSA-AES256-CCM8 https://example.com", "metadata": [ { "name": "x-summary", "value": "SSL ciphers to use" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsv1", "--tls13-ciphers", "--proxy-ciphers" ] } ] }, { "name": "--compressed", "group": "http", "description": "Request a compressed response using one of the algorithms curl supports, and automatically decompress the content.\n\nResponse 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.\n\nIf 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.\n\nProviding --compressed multiple times has no extra effect. Disable it again with --no-compressed.\n\nExample: curl --compressed https://example.com", "metadata": [ { "name": "x-summary", "value": "Request compressed response" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--compressed-ssh" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--compressed-ssh", "group": "scp", "description": "Enables built-in SSH compression. This is a request, not an order; the server may or may not do it.\n\nProviding --compressed-ssh multiple times has no extra effect. Disable it again with --no-compressed-ssh.\n\nExample: curl --compressed-ssh sftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Enable SSH compression" }, { "name": "x-protocols", "value": [ "SCP", "SFTP" ] }, { "name": "x-see-also", "value": [ "--compressed" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "scp", "ssh" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--config", "aliases": [ "-K" ], "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "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.\n\nOptions 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.\n\nIf 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.\n\nIf the first non-blank column of a config line is a '#' character, that line is treated as a comment.\n\nOnly 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).\n\nSpecify the filename to --config as minus \"-\" to make curl read the file from stdin.\n\nNote that to be able to specify a URL in the config file, you need to specify it using the --url option, and not by simply writing the URL on its own line. So, it could look similar to this:\n\nurl = \"https://curl.se/docs/\"\n\n# --- Example file --- # this is a comment url = \"example.com\" output = \"curlhere.html\" user-agent = \"superagent/1.0\"\n\n# and fetch another URL too url = \"example.com/docs/manpage.html\" -O referer = \"http://nowhereatall.example.com/\" # --- End of example file ---\n\nWhen 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:\n\n1) \"$CURL_HOME/.curlrc\"\n\n2) \"$XDG_CONFIG_HOME/curlrc\" (Added in 7.73.0)\n\n3) \"$HOME/.curlrc\"\n\n4) Windows: \"%USERPROFILE%\\.curlrc\"\n\n5) Windows: \"%APPDATA%\\.curlrc\"\n\n6) Windows: \"%USERPROFILE%\\Application Data\\.curlrc\"\n\n7) Non-Windows: use getpwuid to find the home directory\n\n8) 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.\n\nOn Windows two filenames are checked per location: .curlrc and _curlrc, preferring the former. Older versions on Windows checked for _curlrc only.\n\n--config can be used several times in a command line\n\nExample: curl --config file.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Read config from a file" }, { "name": "x-see-also", "value": [ "--disable" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--connect-timeout", "arguments": [ { "name": "seconds", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\nThis 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.\n\nThe connection phase is considered complete when the DNS lookup and requested TCP, TLS or QUIC handshakes are done.\n\nIf --connect-timeout is provided several times, the last set value is used.\n\nExamples: curl --connect-timeout 20 https://example.com curl --connect-timeout 3.14 https://example.com", "metadata": [ { "name": "x-summary", "value": "Maximum time allowed to connect" }, { "name": "x-see-also", "value": [ "--max-time" ] } ] }, { "name": "--connect-to", "arguments": [ { "name": "HOST1:PORT1:HOST2:PORT2", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\n\"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.\n\nA hostname specified to this option is compared as a string, so it needs to match the name used in request URL. It can be either numerical such as \"127.0.0.1\" or the full host name such as \"example.org\".\n\n--connect-to can be used several times in a command line\n\nExample: curl --connect-to example.com:443:example.net:8443 https://example.com", "metadata": [ { "name": "x-summary", "value": "Connect to host" }, { "name": "x-see-also", "value": [ "--resolve", "--header" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--continue-at", "aliases": [ "-C" ], "arguments": [ { "name": "offset", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Resume a previous transfer from the given byte offset. The given offset is the exact number of bytes that are skipped, counting from the beginning of the source file before it is transferred to the destination. If used with uploads, the FTP server command SIZE is not used by curl.\n\nUse \"-C -\" to instruct curl to automatically find out where/how to resume the transfer. It then uses the given output/input files to figure that out.\n\nIf --continue-at is provided several times, the last set value is used.\n\nExamples: curl -C - https://example.com curl -C 400 https://example.com", "metadata": [ { "name": "x-summary", "value": "Resumed transfer offset" }, { "name": "x-see-also", "value": [ "--range" ] } ] }, { "name": "--cookie", "aliases": [ "-b" ], "arguments": [ { "name": "data|filename", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Pass the data to the HTTP server in the Cookie header. It is supposedly the data previously received from the server in a \"Set-Cookie:\" line. The data should be in the format \"NAME1=VALUE1; NAME2=VALUE2\" or as a single filename.\n\nWhen given a set of specific cookies and not a filename, it makes curl use the cookie header with this content explicitly in all outgoing request(s). If multiple requests are done due to authentication, followed redirects or similar, they all get this cookie header passed on.\n\nIf no \"=\" symbol is used in the argument, it is instead treated as a filename to read previously stored cookie from. This option also activates the cookie engine which makes curl record incoming cookies, which may be handy if you are using this in combination with the --location option or do multiple URL transfers on the same invoke.\n\nIf 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.\n\nThe file format of the file to read cookies from should be plain HTTP headers (Set-Cookie style) or the Netscape/Mozilla cookie file format.\n\nThe file specified with --cookie is only used as input. No cookies are written to that file. To store cookies, use the --cookie-jar option.\n\nIf you use the Set-Cookie file format and do not specify a domain then the cookie is not sent since the domain never matches. To address this, set a domain in Set-Cookie line (doing that includes subdomains) or preferably: use the Netscape format.\n\nUsers 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.\n\nIf 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.\n\n--cookie can be used several times in a command line\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Send cookies from string/load from file" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--cookie-jar", "--junk-session-cookies" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--cookie-jar", "aliases": [ "-c" ], "arguments": [ { "name": "filename", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Specify to which file you want curl to write all cookies after a completed operation. Curl writes all cookies from its in-memory cookie storage to the given file at the end of operations. Even if no cookies are known, a file is created so that 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.\n\nThe 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.\n\nThis command line option activates the cookie engine that makes curl record and use cookies. The --cookie option also activates it.\n\nIf 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.\n\nIf --cookie-jar is provided several times, the last set value is used.\n\nExamples: curl -c store-here.txt https://example.com curl -c store-here.txt -b read-these https://example.com", "metadata": [ { "name": "x-summary", "value": "Save cookies to after operation" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--cookie" ] } ] }, { "name": "--create-dirs", "group": "curl", "description": "When used in conjunction with the --output option, curl creates the necessary local directory hierarchy as needed. This option 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.\n\nCreated directories are made with mode 0750 on unix style file systems.\n\nTo create remote directories when using FTP or SFTP, try --ftp-create-dirs.\n\nProviding --create-dirs multiple times has no extra effect. Disable it again with --no-create-dirs.\n\nExample: curl --create-dirs --output local/dir/file https://example.com", "metadata": [ { "name": "x-summary", "value": "Create necessary local directory hierarchy" }, { "name": "x-see-also", "value": [ "--ftp-create-dirs", "--output-dir" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--create-file-mode", "arguments": [ { "name": "mode", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "file", "description": "When curl is used to create files remotely using one of the supported protocols, this option allows the user to set which 'mode' to set on the file at creation time, instead of the default 0644.\n\nThis option takes an octal number as argument.\n\nIf --create-file-mode is provided several times, the last set value is used.\n\nExample: curl --create-file-mode 0777 -T localfile sftp://example.com/new", "metadata": [ { "name": "x-summary", "value": "File mode for created files" }, { "name": "x-protocols", "value": [ "SFTP", "SCP", "FILE" ] }, { "name": "x-see-also", "value": [ "--ftp-create-dirs" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "file", "scp", "sftp", "upload" ] } ] }, { "name": "--crlf", "group": "ftp", "description": "Convert line feeds to carriage return plus line feeds in upload. Useful for MVS (OS/390).\n\n(SMTP added in 7.40.0)\n\nProviding --crlf multiple times has no extra effect. Disable it again with --no-crlf.\n\nExample: curl --crlf -T file ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Convert LF to CRLF in upload" }, { "name": "x-protocols", "value": [ "FTP", "SMTP" ] }, { "name": "x-see-also", "value": [ "--use-ascii" ] }, { "name": "x-categories", "value": [ "ftp", "smtp" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--crlfile", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Provide a file using PEM format with a Certificate Revocation List that may specify peer certificates that are to be considered revoked.\n\nIf --crlfile is provided several times, the last set value is used.\n\nExample: curl --crlfile rejects.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Certificate Revocation list" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--cacert", "--capath" ] } ] }, { "name": "--curves", "arguments": [ { "name": "list", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "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.\n\n--curves allows a OpenSSL powered curl to make SSL-connections with exactly the (EC) curve requested by the client, avoiding nontransparent client/server negotiations.\n\nIf this option is set, the default curves list built into OpenSSL are ignored.\n\nIf --curves is provided several times, the last set value is used.\n\nExample: curl --curves X25519 https://example.com", "metadata": [ { "name": "x-summary", "value": "(EC) TLS key exchange algorithms to request" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--ciphers" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--data", "aliases": [ "-d" ], "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Sends the specified data in a POST request to the HTTP server, 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. Compare to --form.\n\n--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.\n\nIf any of these options is used more than once on the same command line, the data pieces specified are merged with a separating &-symbol. Thus, using '-d name=daniel -d skill=lousy' would generate a post chunk that looks like 'name=daniel&skill=lousy'.\n\nIf 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.\n\nThe 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 the user to provide the data in the correct form.\n\n--data can be used several times in a command line\n\nExamples: curl -d \"name=curl\" https://example.com curl -d \"name=curl\" -d \"tool=cmdline\" https://example.com curl -d @filename https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP POST data" }, { "name": "x-protocols", "value": [ "HTTP", "MQTT" ] }, { "name": "x-see-also", "value": [ "--data-binary", "--data-urlencode", "--data-raw", "--form", "--head", "--upload-file" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "post", "upload" ] } ] }, { "name": "--data-ascii", "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "This option is just an alias for --data.\n\n--data-ascii can be used several times in a command line\n\nExample: curl --data-ascii @file https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP POST ASCII data" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--data-binary", "--data-raw", "--data-urlencode" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "post", "upload" ] } ] }, { "name": "--data-binary", "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Post data exactly as specified with no extra processing whatsoever.\n\nIf you start the data with the letter @, the rest should be a filename. Data is posted in a similar manner as --data does, except that newlines and carriage returns are preserved and conversions are never done.\n\nLike --data the default content-type sent to the server is application/x-www-form-urlencoded. If you want the data to be treated as arbitrary binary data by the server then set the content-type to octet-stream: -H \"Content-Type: application/octet-stream\".\n\nIf this option is used several times, the ones following the first append data as described in --data.\n\n--data-binary can be used several times in a command line\n\nExample: curl --data-binary @filename https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP POST binary data" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--data-ascii" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "post", "upload" ] } ] }, { "name": "--data-raw", "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Post data similarly to --data but without the special interpretation of the @ character.\n\n--data-raw can be used several times in a command line\n\nExamples: curl --data-raw \"hello\" https://example.com curl --data-raw \"@at@at@\" https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP POST data, '@' allowed" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--data" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "post", "upload" ] } ] }, { "name": "--data-urlencode", "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Post data, similar to the other --data options with the exception that this performs URL-encoding.\n\nTo be CGI-compliant, the part should begin with a name followed by a separator and a content specification. The part can be passed to curl using one of the following syntaxes:\n\ncontent\n\nURL-encode the content and pass that on. Just be careful so that the content does not contain any \"=\" or \"@\" symbols, as that makes the syntax match one of the other cases below!\n\n=content\n\nURL-encode the content and pass that on. The preceding \"=\" symbol is not included in the data.\n\nname=content\n\nURL-encode the content part and pass that on. Note that the name part is expected to be URL-encoded already.\n\n@filename\n\nload data from the given file (including any newlines), URL-encode that data and pass it on in the POST.\n\nname@filename\n\nload data from the given file (including any newlines), URL-encode that data and pass 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.\n\n--data-urlencode can be used several times in a command line\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "HTTP POST data URL encoded" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--data", "--data-raw" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "post", "upload" ] } ] }, { "name": "--delegation", "arguments": [ { "name": "LEVEL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Set LEVEL what curl is allowed to delegate when it comes to user credentials.\n\nnone\n\nDo not allow any delegation.\n\npolicy\n\nDelegates if and only if the OK-AS-DELEGATE flag is set in the Kerberos service ticket, which is a matter of realm policy.\n\nalways\n\nUnconditionally allow the server to delegate.\n\nIf --delegation is provided several times, the last set value is used.\n\nExample: curl --delegation \"none\" https://example.com", "metadata": [ { "name": "x-summary", "value": "GSS-API delegation permission" }, { "name": "x-protocols", "value": [ "GSS/kerberos" ] }, { "name": "x-see-also", "value": [ "--insecure", "--ssl" ] } ] }, { "name": "--digest", "group": "auth", "description": "Enables HTTP Digest authentication. This authentication scheme avoids sending the password over the wire in clear text. Use this in combination with the normal --user option to set username and password.\n\nProviding --digest multiple times has no extra effect. Disable it again with --no-digest.\n\nExample: curl -u name:password --digest https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP Digest Authentication" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--user", "--proxy-digest", "--anyauth", "--basic", "--ntlm", "--negotiate" ] }, { "name": "x-categories", "value": [ "auth", "http", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--disable", "aliases": [ "-q" ], "group": "curl", "description": "If used as the first parameter on the command line, the curlrc config file is not read or used. See the --config for details on the default config file search path.\n\nPrior to 7.50.0 curl supported the short option name q but not the long option name disable.\n\nProviding --disable multiple times has no extra effect. Disable it again with --no-disable.\n\nExample: curl -q https://example.com", "metadata": [ { "name": "x-summary", "value": "Disable .curlrc" }, { "name": "x-see-also", "value": [ "--config" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--disable-eprt", "group": "ftp", "description": "Disable 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 enables more functionality in a better way than the traditional PORT command.\n\n--eprt can be used to explicitly enable EPRT again and --no-eprt is an alias for --disable-eprt.\n\nIf the server is accessed using IPv6, this option has no effect as EPRT is necessary then.\n\nDisabling 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.\n\nProviding --disable-eprt multiple times has no extra effect. Disable it again with --no-disable-eprt.\n\nExample: curl --disable-eprt ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Inhibit using EPRT or LPRT" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--disable-epsv", "--ftp-port" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--disable-epsv", "group": "ftp", "description": "Disable 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.\n\n--epsv can be used to explicitly enable EPSV again and --no-epsv is an alias for --disable-epsv.\n\nIf the server is an IPv6 host, this option has no effect as EPSV is necessary then.\n\nDisabling EPSV only changes the passive behavior. If you want to switch to active mode you need to use --ftp-port.\n\nProviding --disable-epsv multiple times has no extra effect. Disable it again with --no-disable-epsv.\n\nExample: curl --disable-epsv ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Inhibit using EPSV" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--disable-eprt", "--ftp-port" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--disallow-username-in-url", "group": "curl", "description": "Exit with error if passed a URL containing a username. Probably most useful when the URL is being provided at runtime or similar.\n\nProviding --disallow-username-in-url multiple times has no extra effect. Disable it again with --no-disallow-username-in-url.\n\nExample: curl --disallow-username-in-url https://example.com", "metadata": [ { "name": "x-summary", "value": "Disallow username in URL" }, { "name": "x-see-also", "value": [ "--proto" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--dns-interface", "arguments": [ { "name": "interface", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "dns", "description": "Send 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).\n\nIf --dns-interface is provided several times, the last set value is used.\n\nExample: curl --dns-interface eth0 https://example.com", "metadata": [ { "name": "x-summary", "value": "Interface to use for DNS requests" }, { "name": "x-protocols", "value": [ "DNS" ] }, { "name": "x-see-also", "value": [ "--dns-ipv4-addr", "--dns-ipv6-addr", "--dns-interface" ] } ] }, { "name": "--dns-ipv4-addr", "arguments": [ { "name": "address", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "dns", "description": "Bind 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.\n\nIf --dns-ipv4-addr is provided several times, the last set value is used.\n\nExample: curl --dns-ipv4-addr 10.1.2.3 https://example.com", "metadata": [ { "name": "x-summary", "value": "IPv4 address to use for DNS requests" }, { "name": "x-protocols", "value": [ "DNS" ] }, { "name": "x-see-also", "value": [ "--dns-interface", "--dns-ipv6-addr", "--dns-ipv4-addr" ] } ] }, { "name": "--dns-ipv6-addr", "arguments": [ { "name": "address", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "dns", "description": "Bind 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.\n\nIf --dns-ipv6-addr is provided several times, the last set value is used.\n\nExample: curl --dns-ipv6-addr 2a04:4e42::561 https://example.com", "metadata": [ { "name": "x-summary", "value": "IPv6 address to use for DNS requests" }, { "name": "x-protocols", "value": [ "DNS" ] }, { "name": "x-see-also", "value": [ "--dns-interface", "--dns-ipv4-addr", "--dns-ipv6-addr" ] } ] }, { "name": "--dns-servers", "arguments": [ { "name": "addresses", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "dns", "description": "Set 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.\n\nIf --dns-servers is provided several times, the last set value is used.\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "DNS server addrs to use" }, { "name": "x-protocols", "value": [ "DNS" ] }, { "name": "x-see-also", "value": [ "--dns-interface", "--dns-ipv4-addr", "--dns-servers" ] } ] }, { "name": "--doh-cert-status", "group": "dns", "description": "Same as --cert-status but used for DoH (DNS-over-HTTPS).\n\nVerifies the status of the DoH servers' certificate by using the Certificate Status Request (aka. OCSP stapling) TLS extension.\n\nIf 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.\n\nThis support is currently only implemented in the OpenSSL and GnuTLS backends.\n\nProviding --doh-cert-status multiple times has no extra effect. Disable it again with --no-doh-cert-status.\n\nExample: curl --doh-cert-status --doh-url https://doh.example https://example.com", "metadata": [ { "name": "x-summary", "value": "Verify DoH server cert status OCSP-staple" }, { "name": "x-see-also", "value": [ "--doh-insecure" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "dns", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--doh-insecure", "group": "dns", "description": "Same as --insecure but used for DoH (DNS-over-HTTPS).\n\nProviding --doh-insecure multiple times has no extra effect. Disable it again with --no-doh-insecure.\n\nExample: curl --doh-insecure --doh-url https://doh.example https://example.com", "metadata": [ { "name": "x-summary", "value": "Allow insecure DoH server connections" }, { "name": "x-see-also", "value": [ "--doh-url" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "dns", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--doh-url", "arguments": [ { "name": "URL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "dns", "description": "Specifies which DNS-over-HTTPS (DoH) server to use to resolve hostnames, instead of using the default name resolver mechanism. The URL must be HTTPS.\n\nSome SSL options that you set for your transfer also applies to DoH since the name lookups take place over SSL. However, the certificate verification settings are not inherited but are controlled separately via --doh-insecure and --doh-cert-status.\n\nThis option is unset if an empty string \"\" is used as the URL. (Added in 7.85.0)\n\nIf --doh-url is provided several times, the last set value is used.\n\nExample: curl --doh-url https://doh.example https://example.com", "metadata": [ { "name": "x-summary", "value": "Resolve hostnames over DoH" }, { "name": "x-see-also", "value": [ "--doh-insecure" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--dump-header", "aliases": [ "-D" ], "arguments": [ { "name": "filename", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "Write the received protocol headers to the specified file. If no headers are received, the use of this option creates an empty file.\n\nWhen used in FTP, the FTP server response lines are considered being \"headers\" and thus are saved there.\n\nHaving 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.\n\nIf --dump-header is provided several times, the last set value is used.\n\nExample: curl --dump-header store.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Write the received headers to " }, { "name": "x-protocols", "value": [ "HTTP", "FTP" ] }, { "name": "x-see-also", "value": [ "--output" ] }, { "name": "x-categories", "value": [ "ftp", "http" ] } ] }, { "name": "--egd-file", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "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.\n\nSpecify the path name to the Entropy Gathering Daemon socket. The socket is used to seed the random engine for SSL connections.\n\nIf --egd-file is provided several times, the last set value is used.\n\nExample: curl --egd-file /random/here https://example.com", "metadata": [ { "name": "x-summary", "value": "EGD socket path for random data" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--random-file" ] } ] }, { "name": "--engine", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Select 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.\n\nIf --engine is provided several times, the last set value is used.\n\nExample: curl --engine flavor https://example.com", "metadata": [ { "name": "x-summary", "value": "Crypto engine to use" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--ciphers", "--curves" ] } ] }, { "name": "--etag-compare", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Make 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.\n\nFor correct results, make sure that the specified file contains only a single line with the desired ETag. An empty file is parsed as an empty ETag.\n\nUse 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.\n\nIf --etag-compare is provided several times, the last set value is used.\n\nExample: curl --etag-compare etag.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Load ETag from file" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--etag-save", "--time-cond" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--etag-save", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Save an HTTP ETag to the specified file. An ETag is a caching related header, usually returned in a response.\n\nIf no ETag is sent by the server, an empty file is created.\n\nIf --etag-save is provided several times, the last set value is used.\n\nExample: curl --etag-save storetag.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Parse incoming ETag and save to a file" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--etag-compare" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--expect100-timeout", "arguments": [ { "name": "seconds", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "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.\n\nThe decimal value needs to provided using a dot (\".\") as decimal separator - not the local version even if it might be using another separator.\n\nIf --expect100-timeout is provided several times, the last set value is used.\n\nExample: curl --expect100-timeout 2.5 -T file https://example.com", "metadata": [ { "name": "x-summary", "value": "How long to wait for 100-continue" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--connect-timeout" ] } ] }, { "name": "--fail", "aliases": [ "-f" ], "group": "http", "description": "Fail fast with no output at all on server errors. This is useful to enable scripts and users to better deal with failed attempts. In normal cases when an HTTP server fails to deliver a document, it returns an HTML document stating so (which often also describes why and more). This command line option prevents curl from outputting that and return error 22.\n\nThis 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).\n\nProviding --fail multiple times has no extra effect. Disable it again with --no-fail.\n\nExample: curl --fail https://example.com", "metadata": [ { "name": "x-summary", "value": "Fail fast with no output on HTTP errors" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--fail-with-body", "--fail-early", "--fail-with-body" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--fail-early", "group": "curl", "description": "Fail and exit on the first detected transfer error.\n\nWhen 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.\n\nUsing 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.\n\nThis 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.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --fail-early multiple times has no extra effect. Disable it again with --no-fail-early.\n\nExample: curl --fail-early https://example.com https://two.example", "metadata": [ { "name": "x-summary", "value": "Fail on first transfer error" }, { "name": "x-see-also", "value": [ "--fail", "--fail-with-body" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--fail-with-body", "group": "http", "description": "Return an error on server errors where the HTTP response code is 400 or greater). In normal cases when an HTTP server fails to deliver a document, it returns an HTML document stating so (which often also describes why and more). This option allows curl to output and save that content but also to return error 22.\n\nThis is an alternative option to --fail which makes curl fail for the same circumstances but without saving the content.\n\nProviding --fail-with-body multiple times has no extra effect. Disable it again with --no-fail-with-body.\n\nExample: curl --fail-with-body https://example.com", "metadata": [ { "name": "x-summary", "value": "Fail on HTTP errors but save the body" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--fail", "--fail-early", "--fail" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "http", "output" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--false-start", "group": "tls", "description": "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.\n\nThis functionality is currently only implemented in the Secure Transport (on iOS 7.0 or later, or OS X 10.9 or later) backend.\n\nProviding --false-start multiple times has no extra effect. Disable it again with --no-false-start.\n\nExample: curl --false-start https://example.com", "metadata": [ { "name": "x-summary", "value": "Enable TLS False Start" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tcp-fastopen" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--form", "aliases": [ "-F" ], "arguments": [ { "name": "name=content", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "For the HTTP protocol family, emulate a filled-in form in which a user has pressed the submit button. This makes curl POST data using the Content-Type multipart/form-data according to RFC 2388.\n\nFor SMTP and IMAP protocols, this composes a multipart mail message to transmit.\n\nThis enables uploading of binary files etc. To force the 'content' part to be a file, prefix the filename with an @ sign. To just get the content part from a file, prefix the filename with the symbol <. The difference between @ and < is then that @ makes a file get attached in the post as a file upload, while the < makes a text field and just get the contents for that text field from a file.\n\nRead 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.\n\nExample: 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:\n\ncurl -F profile=@portrait.jpg https://example.com/upload.cgi\n\nExample: send your name and shoe size in two text fields to the server:\n\ncurl -F name=John -F shoesize=11 https://example.com/\n\nExample: send your essay in a text field to the server. Send it as a plain text field, but get the contents for it from a local file:\n\ncurl -F \"story=HTML message;type=text/html' \\ -F '=)' -F '=@textfile.txt' ... smtp://example.com\n\nData 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.\n\nExample: send multipart mail with a quoted-printable text message and a base64 attached file:\n\ncurl -F '=text message;encoder=quoted-printable' \\ -F '=@localfile;encoder=base64' ... smtp://example.com\n\nSee further examples and details in the MANUAL.\n\n--form can be used several times in a command line\n\nExample: curl --form \"name=curl\" --form \"file=@loadthis\" https://example.com", "metadata": [ { "name": "x-summary", "value": "Specify multipart MIME data" }, { "name": "x-protocols", "value": [ "HTTP", "SMTP", "IMAP" ] }, { "name": "x-see-also", "value": [ "--data", "--form-string", "--form-escape", "--data", "--head", "--upload-file" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "upload" ] } ] }, { "name": "--form-escape", "group": "http", "description": "Pass on names of multipart form fields and files using backslash-escaping instead of percent-encoding.\n\nIf --form-escape is provided several times, the last set value is used.\n\nExample: curl --form-escape -F 'field\\name=curl' -F 'file=@load\"this' https://example.com", "metadata": [ { "name": "x-summary", "value": "Escape form fields using backslash" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--form" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "http", "upload" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--form-string", "arguments": [ { "name": "name=string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "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.\n\n--form-string can be used several times in a command line\n\nExample: curl --form-string \"name=data\" https://example.com", "metadata": [ { "name": "x-summary", "value": "Specify multipart MIME data" }, { "name": "x-protocols", "value": [ "HTTP", "SMTP", "IMAP" ] }, { "name": "x-see-also", "value": [ "--form" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "upload" ] } ] }, { "name": "--ftp-account", "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "When an FTP server asks for \"account data\" after username and password has been provided, this data is sent off using the ACCT command.\n\nIf --ftp-account is provided several times, the last set value is used.\n\nExample: curl --ftp-account \"mr.robot\" ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Account data string" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--user" ] }, { "name": "x-categories", "value": [ "auth", "ftp" ] } ] }, { "name": "--ftp-alternative-to-user", "arguments": [ { "name": "command", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "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.\n\nIf --ftp-alternative-to-user is provided several times, the last set value is used.\n\nExample: curl --ftp-alternative-to-user \"U53r\" ftp://example.com", "metadata": [ { "name": "x-summary", "value": "String to replace USER [name]" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--ftp-account", "--user" ] } ] }, { "name": "--ftp-create-dirs", "group": "curl", "description": "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.\n\nProviding --ftp-create-dirs multiple times has no extra effect. Disable it again with --no-ftp-create-dirs.\n\nExample: curl --ftp-create-dirs -T file ftp://example.com/remote/path/file", "metadata": [ { "name": "x-summary", "value": "Create the remote dirs if not present" }, { "name": "x-protocols", "value": [ "FTP", "SFTP" ] }, { "name": "x-see-also", "value": [ "--create-dirs" ] }, { "name": "x-categories", "value": [ "curl", "ftp", "sftp" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ftp-method", "arguments": [ { "name": "method", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "Control what method curl should use to reach a file on an FTP(S) server. The method argument should be one of the following alternatives:\n\nmulticwd\n\nDo a single CWD operation for each path part in the given URL. For deep hierarchies this means many commands. This is how RFC 1738 says it should be done. This is the default but the slowest behavior.\n\nnocwd\n\nDo no CWD at all. curl does SIZE, RETR, STOR etc and gives the full path to the server for each of these commands. This is the fastest behavior.\n\nsinglecwd\n\nDo one CWD with the full target directory and then operate on the file \"normally\" (like in the multicwd case). This is somewhat more standards compliant than \"nocwd\" but without the full penalty of \"multicwd\".\n\nIf --ftp-method is provided several times, the last set value is used.\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Control CWD usage" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--list-only" ] } ] }, { "name": "--ftp-pasv", "group": "ftp", "description": "Use 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.\n\nReversing an enforced passive really is not doable but you must then instead enforce the correct --ftp-port again.\n\nPassive mode means that curl tries the EPSV command first and then PASV, unless --disable-epsv is used.\n\nProviding --ftp-pasv multiple times has no extra effect. Disable it again with --no-ftp-pasv.\n\nExample: curl --ftp-pasv ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Send PASV/EPSV instead of PORT" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--disable-epsv" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ftp-port", "aliases": [ "-P" ], "arguments": [ { "name": "address", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "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 setup an IP address and port for it to connect to.
should be one of:\n\ninterface\n\ne.g. eth0 to specify which interface's IP address you want to use (Unix only)\n\nIP address\n\ne.g. 192.168.10.1 to specify the exact IP address\n\nhostname\n\ne.g. my.host.domain to specify the machine\n\n-\n\nmake curl pick the same IP address that is already used for the control connection. This is the recommended choice.\n\n.RE .IP\n\nDisable 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++.\n\nYou 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.\n\nIf --ftp-port is provided several times, the last set value is used.\n\nExamples: curl -P - ftp:/example.com curl -P eth0 ftp:/example.com curl -P 192.168.0.2 ftp:/example.com", "metadata": [ { "name": "x-summary", "value": "Send PORT instead of PASV" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--ftp-pasv", "--disable-eprt" ] } ] }, { "name": "--ftp-pret", "group": "ftp", "description": "Send 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.\n\nProviding --ftp-pret multiple times has no extra effect. Disable it again with --no-ftp-pret.\n\nExample: curl --ftp-pret ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Send PRET before PASV" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--ftp-port", "--ftp-pasv" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ftp-skip-pasv-ip", "group": "ftp", "description": "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.\n\nThis option is enabled by default (added in 7.74.0).\n\nThis option has no effect if PORT, EPRT or EPSV is used instead of PASV.\n\nProviding --ftp-skip-pasv-ip multiple times has no extra effect. Disable it again with --no-ftp-skip-pasv-ip.\n\nExample: curl --ftp-skip-pasv-ip ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Skip the IP address for PASV" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--ftp-pasv" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ftp-ssl-ccc", "group": "ftp", "description": "Use CCC (Clear Command Channel) Shuts down the SSL/TLS layer after authenticating. The rest of the control channel communication is be unencrypted. This allows NAT routers to follow the FTP transaction. The default mode is passive.\n\nProviding --ftp-ssl-ccc multiple times has no extra effect. Disable it again with --no-ftp-ssl-ccc.\n\nExample: curl --ftp-ssl-ccc ftps://example.com/", "metadata": [ { "name": "x-summary", "value": "Send CCC after authenticating" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--ssl", "--ftp-ssl-ccc-mode" ] }, { "name": "x-categories", "value": [ "ftp", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ftp-ssl-ccc-mode", "arguments": [ { "name": "active/passive", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "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.\n\nProviding --ftp-ssl-ccc-mode multiple times has no extra effect. Disable it again with --no-ftp-ssl-ccc-mode.\n\nExample: curl --ftp-ssl-ccc-mode active --ftp-ssl-ccc ftps://example.com/", "metadata": [ { "name": "x-summary", "value": "Set CCC mode" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--ftp-ssl-ccc" ] }, { "name": "x-categories", "value": [ "ftp", "tls" ] } ] }, { "name": "--ftp-ssl-control", "group": "ftp", "description": "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.\n\nProviding --ftp-ssl-control multiple times has no extra effect. Disable it again with --no-ftp-ssl-control.\n\nExample: curl --ftp-ssl-control ftp://example.com", "metadata": [ { "name": "x-summary", "value": "Require TLS for login, clear for transfer" }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--ssl" ] }, { "name": "x-categories", "value": [ "ftp", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--get", "aliases": [ "-G" ], "group": "http", "description": "When used, this option makes all data specified with --data, --data-binary or --data-urlencode to be used in an HTTP GET request instead of the POST request that otherwise would be used. The data is appended to the URL with a '?' separator.\n\nIf used in combination with --head, the POST data is instead appended to the URL with a HEAD request.\n\nProviding --get multiple times has no extra effect. Disable it again with --no-get.\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Put the post data in the URL and use GET" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--data", "--request" ] }, { "name": "x-categories", "value": [ "http", "upload" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--globoff", "aliases": [ "-g" ], "group": "curl", "description": "Switch 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.\n\nProviding --globoff multiple times has no extra effect. Disable it again with --no-globoff.\n\nExample: curl -g \"https://example.com/{[]}}}}\"", "metadata": [ { "name": "x-summary", "value": "Disable URL globbing with {} and []" }, { "name": "x-see-also", "value": [ "--config", "--disable" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--happy-eyeballs-timeout-ms", "arguments": [ { "name": "ms", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\nThe 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.\n\nIf --happy-eyeballs-timeout-ms is provided several times, the last set value is used.\n\nExample: curl --happy-eyeballs-timeout-ms 500 https://example.com", "metadata": [ { "name": "x-summary", "value": "Time for IPv6 before IPv4" }, { "name": "x-see-also", "value": [ "--max-time", "--connect-timeout" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--haproxy-clientip", "arguments": [ { "name": "ip", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Sets a client IP in HAProxy PROXY protocol v1 header at the beginning of the connection.\n\nFor 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 exactly be 128.\n\nOtherwise, any string can be accepted for the client IP and get sent.\n\nIt replaces --haproxy-protocol if used, it is not necessary to specify both flags.\n\nIf --haproxy-clientip is provided several times, the last set value is used.\n\nExample: curl --haproxy-clientip $IP", "metadata": [ { "name": "x-summary", "value": "Set address in HAProxy PROXY" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy" ] }, { "name": "x-added-in", "value": "8" }, { "name": "x-categories", "value": [ "http", "proxy" ] } ] }, { "name": "--haproxy-protocol", "group": "http", "description": "Send 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.\n\nThis option is primarily useful when sending test requests to a service that expects this header.\n\nProviding --haproxy-protocol multiple times has no extra effect. Disable it again with --no-haproxy-protocol.\n\nExample: curl --haproxy-protocol https://example.com", "metadata": [ { "name": "x-summary", "value": "Send HAProxy PROXY protocol v1 header" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "http", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--head", "aliases": [ "-I" ], "group": "file", "description": "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 file, curl displays the file size and last modification time only.\n\nProviding --head multiple times has no extra effect. Disable it again with --no-head.\n\nExample: curl -I https://example.com", "metadata": [ { "name": "x-summary", "value": "Show document info only" }, { "name": "x-protocols", "value": [ "HTTP", "FTP", "FILE" ] }, { "name": "x-see-also", "value": [ "--get", "--verbose", "--trace-ascii" ] }, { "name": "x-categories", "value": [ "file", "ftp", "http" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--header", "aliases": [ "-H" ], "arguments": [ { "name": "header/@file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Extra header to include in information sent. When used within an HTTP request, it is added to the regular request headers.\n\nFor an IMAP or SMTP MIME uploaded mail built with --form options, it is prepended to the resulting MIME document, effectively including it at the mail global level. It does not affect raw uploaded mails (Added in 7.56.0).\n\nYou may specify any number of extra headers. Note that if you should add a custom header that has the same name as one of the internal ones curl would use, your externally set header is used instead of the internal one. This allows you to make even trickier stuff than curl would normally do. You should not replace internally set headers without knowing perfectly well what you are doing. Remove an internal header by giving a replacement without content on the right side of the colon, as in: -H \"Host:\". If you send the custom header with no-value then its header must be terminated with a semicolon, such as -H \"X-Custom-Header;\" to send \"X-Custom-Header:\".\n\ncurl 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. curl passes on the verbatim string you give it without any filter or other safe guards. That includes white space and control characters.\n\nThis 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. Added in 7.55.0.\n\nPlease 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 should be added with this option.\n\nYou need --proxy-header to send custom headers intended for an HTTP proxy. Added in 7.37.0.\n\nPassing on a \"Transfer-Encoding: chunked\" header when doing an HTTP request with a request body, makes curl send the data using chunked encoding.\n\nWARNING: 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.\n\n--header can be used several times in a command line\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Pass custom header(s) to server" }, { "name": "x-protocols", "value": [ "HTTP", "IMAP", "SMTP" ] }, { "name": "x-see-also", "value": [ "--user-agent", "--referer" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "imap", "smtp" ] } ] }, { "name": "--help", "aliases": [ "-h" ], "arguments": [ { "name": "category", "required": false, "arity": { "minimum": 0, "maximum": 1 } } ], "group": "curl", "description": "Usage help. List all curl command line options within the given category.\n\nIf no argument is provided, curl displays the most important command line arguments.\n\nFor category all, curl displays help for all options.\n\nIf category is specified, curl displays all available help categories.\n\nExample: curl --help all", "metadata": [ { "name": "x-summary", "value": "Get help for commands" }, { "name": "x-see-also", "value": [ "--verbose" ] } ] }, { "name": "--hostpubmd5", "arguments": [ { "name": "md5", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "scp", "description": "Pass a string containing 32 hexadecimal digits. The string should be the 128 bit MD5 checksum of the remote host's public key, curl refuses the connection with the host unless the checksums match.\n\nIf --hostpubmd5 is provided several times, the last set value is used.\n\nExample: curl --hostpubmd5 e5c1c49020640a5ab0f2034854c321a8 sftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Acceptable MD5 hash of host public key" }, { "name": "x-protocols", "value": [ "SFTP", "SCP" ] }, { "name": "x-see-also", "value": [ "--hostpubsha256" ] }, { "name": "x-categories", "value": [ "scp", "sftp" ] } ] }, { "name": "--hostpubsha256", "arguments": [ { "name": "sha256", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "scp", "description": "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.\n\nThis feature requires libcurl to be built with libssh2 and does not work with other SSH backends.\n\nIf --hostpubsha256 is provided several times, the last set value is used.\n\nExample: curl --hostpubsha256 NDVkMTQxMGQ1ODdmMjQ3MjczYjAyOTY5MmRkMjVmNDQ= sftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Acceptable SHA256 hash of host public key" }, { "name": "x-protocols", "value": [ "SFTP", "SCP" ] }, { "name": "x-see-also", "value": [ "--hostpubmd5" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "scp", "sftp" ] } ] }, { "name": "--hsts", "arguments": [ { "name": "filename", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Enable HSTS for the transfer. If the filename points to an existing HSTS cache file, that is used. After a completed transfer, the cache is saved to the filename again if it has been modified.\n\nIf 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 life time after which the upgrade is no longer performed.\n\nSpecify a \"\" filename (zero length) to avoid loading/saving and make curl just handle HSTS in memory.\n\nIf this option is used several times, curl loads contents from all the files but the last one is used for saving.\n\n--hsts can be used several times in a command line\n\nExample: curl --hsts cache.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Enable HSTS with this cache file" }, { "name": "x-protocols", "value": [ "HTTPS" ] }, { "name": "x-see-also", "value": [ "--proto" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-repeatable", "value": true } ] }, { "name": "--http0.9", "group": "http", "description": "Accept an HTTP version 0.9 response.\n\nHTTP/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 simply transparently downgrades - if allowed.\n\nHTTP/0.9 is disabled by default (added in 7.66.0)\n\nProviding --http0.9 multiple times has no extra effect. Disable it again with --no-http0.9.\n\nExample: curl --http0.9 https://example.com", "metadata": [ { "name": "x-summary", "value": "Allow HTTP 0.9 responses" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--http3" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--http1.0", "aliases": [ "-0" ], "group": "http", "description": "Use HTTP version 1.0 instead of using its internally preferred HTTP version.\n\nProviding --http1.0 multiple times has no extra effect.\n\nExample: curl --http1.0 https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP 1.0" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--http0", "--http1", "--http1", "--http2", "--http2-prior-knowledge", "--http3" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--http1.1", "group": "http", "description": "Use HTTP version 1.1. This is the default with HTTP:// URLs.\n\nProviding --http1.1 multiple times has no extra effect.\n\nExample: curl --http1.1 https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP 1.1" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--http1", "--http0", "--http1", "--http2", "--http2-prior-knowledge", "--http3" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--http2", "group": "http", "description": "Use HTTP/2.\n\nFor HTTPS, this means curl negotiates HTTP/2 in the TLS handshake. curl does this by default.\n\nFor HTTP, this means curl attempts to upgrade the request to HTTP/2 using the Upgrade: request header.\n\nWhen 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.\n\nProviding --http2 multiple times has no extra effect.\n\nExample: curl --http2 https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP/2" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--http1", "--http3", "--no-alpn", "--http2", "--http1", "--http1", "--http2-prior-knowledge", "--http3" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--http2-prior-knowledge", "group": "http", "description": "Issue a non-TLS HTTP requests 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 version in the TLS handshake.\n\nProviding --http2-prior-knowledge multiple times has no extra effect. Disable it again with --no-http2-prior-knowledge.\n\nExample: curl --http2-prior-knowledge https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP 2 without HTTP/1.1 Upgrade" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--http2", "--http3", "--http2-prior-knowledge", "--http1", "--http1", "--http2", "--http3" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--http3", "group": "http", "description": "Attempt HTTP/3 to the host in the URL, but fallback to earlier HTTP versions if the HTTP/3 connection establishment fails. HTTP/3 is only available for HTTPS and not for HTTP URLs.\n\nThis option allows a user to avoid using the Alt-Svc method of upgrading to HTTP/3 when you know that the target speaks HTTP/3 on the given host and port.\n\nWhen 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.\n\nUse --http3-only for similar functionality without a fallback.\n\nProviding --http3 multiple times has no extra effect.\n\nExample: curl --http3 https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP v3" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--http3", "--http1", "--http1", "--http2", "--http2-prior-knowledge", "--http3-only" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--http3-only", "group": "http", "description": "Instructs 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. For HTTP, this option triggers an error.\n\nThis option allows a user to avoid using the Alt-Svc method of upgrading to HTTP/3 when you know that the target speaks HTTP/3 on the given host and port.\n\nThis 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.\n\nProviding --http3-only multiple times has no extra effect.\n\nExample: curl --http3-only https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP v3 only" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--http3", "--http3-only", "--http1", "--http1", "--http2", "--http2-prior-knowledge", "--http3" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--ignore-content-length", "group": "ftp", "description": "For HTTP, Ignore the Content-Length header. This is particularly useful for servers running Apache 1.x, which reports incorrect Content-Length for files larger than 2 gigabytes.\n\nFor FTP, this makes curl skip the SIZE command to figure out the size before downloading a file.\n\nThis option does not work for HTTP if libcurl was built to use hyper.\n\nProviding --ignore-content-length multiple times has no extra effect. Disable it again with --no-ignore-content-length.\n\nExample: curl --ignore-content-length https://example.com", "metadata": [ { "name": "x-summary", "value": "Ignore the size of the remote resource" }, { "name": "x-protocols", "value": [ "FTP", "HTTP" ] }, { "name": "x-see-also", "value": [ "--ftp-skip-pasv-ip" ] }, { "name": "x-categories", "value": [ "ftp", "http" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--include", "aliases": [ "-i" ], "group": "verbose", "description": "Include response headers in the output. 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.\n\nTo view the request headers, consider the --verbose option.\n\nPrior to 7.75.0 curl did not print the headers if --fail was used in combination with this option and there was error reported by server.\n\nProviding --include multiple times has no extra effect. Disable it again with --no-include.\n\nExample: curl -i https://example.com", "metadata": [ { "name": "x-summary", "value": "Include response headers in output" }, { "name": "x-protocols", "value": [ "HTTP", "FTP" ] }, { "name": "x-see-also", "value": [ "--verbose" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--insecure", "aliases": [ "-k" ], "group": "scp", "description": "By default, every secure connection curl makes is verified to be secure before the transfer takes place. This option makes curl skip the verification step and proceed without checking.\n\nWhen 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 which matches 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\n\nFor 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.\n\nWARNING: using this option makes the transfer insecure.\n\nWhen 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.\n\nProviding --insecure multiple times has no extra effect. Disable it again with --no-insecure.\n\nExample: curl --insecure https://example.com", "metadata": [ { "name": "x-summary", "value": "Allow insecure server connections" }, { "name": "x-protocols", "value": [ "TLS", "SFTP", "SCP" ] }, { "name": "x-see-also", "value": [ "--proxy-insecure", "--cacert", "--capath" ] }, { "name": "x-categories", "value": [ "scp", "sftp", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--interface", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Perform an operation using a specified interface. You can enter interface name, IP address or hostname. An example could look like:\n\ncurl --interface eth0:1 https://www.example.com/\n\nOn Linux it can be used to specify a VRF, but the binary needs to either have CAP_NET_RAW or to be run as root. More information about Linux VRF: https://www.kernel.org/doc/Documentation/networking/vrf.txt\n\nIf --interface is provided several times, the last set value is used.\n\nExample: curl --interface eth0 https://example.com", "metadata": [ { "name": "x-summary", "value": "Use network INTERFACE (or address)" }, { "name": "x-see-also", "value": [ "--dns-interface" ] } ] }, { "name": "--ipfs-gateway", "arguments": [ { "name": "URL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "description": "Specify which gateway to use for IPFS and IPNS URLs. Not specifying this instead makes curl check if the IPFS_GATEWAY environment variable is set, or if a \"~/.ipfs/gateway\" file holding the gateway URL exists.\n\nIf you run a local IPFS node, this gateway is by default available under \"http://localhost:8080\". A full example URL would look like:\n\ncurl --ipfs-gateway http://localhost:8080 ipfs://bafybeigagd5nmnn2iys2f3doro7ydrevyr2mzarwidgadawmamiteydbzi\n\nThere are many public IPFS gateways. See for example: https://ipfs.github.io/public-gateway-checker/\n\nIf you opt to go for a remote gateway you need to be aware that you completely trust the gateway. This might be fine in local gateways that you host yourself. 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. This means you locally verify that the data. Consult the docs page on trusted vs trustless: https://docs.ipfs.tech/reference/http/gateway/#trusted-vs-trustless\n\nIf --ipfs-gateway is provided several times, the last set value is used.\n\nExample: curl --ipfs-gateway https://example.com ipfs://", "metadata": [ { "name": "x-summary", "value": "Gateway for IPFS" }, { "name": "x-protocols", "value": [ "IPFS" ] }, { "name": "x-see-also", "value": [ "--help", "--manual" ] }, { "name": "x-added-in", "value": "8" } ] }, { "name": "--ipv4", "aliases": [ "-4" ], "group": "connection", "description": "Use IPv4 addresses only when resolving hostnames, and not for example try IPv6.\n\nProviding --ipv4 multiple times has no extra effect.\n\nExample: curl --ipv4 https://example.com", "metadata": [ { "name": "x-summary", "value": "Resolve names to IPv4 addresses" }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--ipv6" ] }, { "name": "x-categories", "value": [ "connection", "dns" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ipv6", "aliases": [ "-6" ], "group": "connection", "description": "Use IPv6 addresses only when resolving hostnames, and not for example try IPv4.\n\nYour resolver may 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.\n\nProviding --ipv6 multiple times has no extra effect.\n\nExample: curl --ipv6 https://example.com", "metadata": [ { "name": "x-summary", "value": "Resolve names to IPv6 addresses" }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--ipv4" ] }, { "name": "x-categories", "value": [ "connection", "dns" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--json", "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Sends the specified JSON data in a POST request to the HTTP server. --json works as a shortcut for passing on these three options:\n\n--data [arg] --header \"Content-Type: application/json\" --header \"Accept: application/json\"\n\nThere is no verification that the passed in data is actual JSON or that the syntax is correct.\n\nIf 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 @-.\n\nIf this option is used more than once on the same command line, the additional data pieces are concatenated to the previous before sending.\n\nThe headers this option sets can be overridden with --header as usual.\n\n--json can be used several times in a command line\n\nExamples: curl --json '{ \"drink\": \"coffe\" }' https://example.com curl --json '{ \"drink\":' --json ' \"coffe\" }' https://example.com curl --json @prepared https://example.com curl --json @- https://example.com < json.txt", "metadata": [ { "name": "x-summary", "value": "HTTP POST JSON" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--data-binary", "--data-raw", "--form", "--head", "--upload-file" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "post", "upload" ] } ] }, { "name": "--junk-session-cookies", "aliases": [ "-j" ], "group": "http", "description": "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. Typical browsers discard session cookies when they are closed down.\n\nProviding --junk-session-cookies multiple times has no extra effect. Disable it again with --no-junk-session-cookies.\n\nExample: curl --junk-session-cookies -b cookies.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Ignore session cookies read from file" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--cookie", "--cookie-jar" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--keepalive-time", "arguments": [ { "name": "seconds", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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, 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 9 or 10. This option has no effect if --no-keepalive is used.\n\nIf unspecified, the option defaults to 60 seconds.\n\nIf --keepalive-time is provided several times, the last set value is used.\n\nExample: curl --keepalive-time 20 https://example.com", "metadata": [ { "name": "x-summary", "value": "Interval time for keepalive probes" }, { "name": "x-see-also", "value": [ "--no-keepalive", "--max-time" ] } ] }, { "name": "--key", "arguments": [ { "name": "key", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ssh", "description": "Private key filename. Allows you to 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\".\n\nIf curl is built against OpenSSL library, and the engine pkcs11 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\" if none was provided.\n\nIf curl is built against Secure Transport or Schannel then this option is ignored for TLS protocols (HTTPS, etc). Those backends expect the private key to be already present in the keychain or PKCS#12 file containing the certificate.\n\nIf --key is provided several times, the last set value is used.\n\nExample: curl --cert certificate --key here https://example.com", "metadata": [ { "name": "x-summary", "value": "Private key filename" }, { "name": "x-protocols", "value": [ "TLS", "SSH" ] }, { "name": "x-see-also", "value": [ "--key-type", "--cert" ] }, { "name": "x-categories", "value": [ "ssh", "tls" ] } ] }, { "name": "--key-type", "arguments": [ { "name": "type", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "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.\n\nIf --key-type is provided several times, the last set value is used.\n\nExample: curl --key-type DER --key here https://example.com", "metadata": [ { "name": "x-summary", "value": "Private key file type (DER/PEM/ENG)" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--key" ] } ] }, { "name": "--krb", "arguments": [ { "name": "level", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "Enable 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.\n\nIf --krb is provided several times, the last set value is used.\n\nExample: curl --krb clear ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Enable Kerberos with security " }, { "name": "x-protocols", "value": [ "FTP" ] }, { "name": "x-see-also", "value": [ "--delegation", "--ssl", "--krb" ] } ] }, { "name": "--libcurl", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "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!\n\nThis option is global and does not need to be specified for each use of --next.\n\nIf --libcurl is provided several times, the last set value is used.\n\nExample: curl --libcurl client.c https://example.com", "metadata": [ { "name": "x-summary", "value": "Generate libcurl code for this command line" }, { "name": "x-see-also", "value": [ "--verbose" ] }, { "name": "x-global", "value": true } ] }, { "name": "--limit-rate", "arguments": [ { "name": "speed", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\nThe given speed is measured in bytes/second, unless a suffix is appended. Appending 'k' or 'K' counts the number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it gigabytes. The suffixes (k, M, G, T, P) are 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G.\n\nThe rate limiting logic works on averaging the transfer speed to no more than the set threshold over a period of multiple seconds.\n\nIf you also use the --speed-limit option, that option takes precedence and might cripple the rate-limiting slightly, to help keeping the speed-limit logic working.\n\nIf --limit-rate is provided several times, the last set value is used.\n\nExamples: curl --limit-rate 100K https://example.com curl --limit-rate 1000 https://example.com curl --limit-rate 10M https://example.com", "metadata": [ { "name": "x-summary", "value": "Limit transfer speed to RATE" }, { "name": "x-see-also", "value": [ "--rate", "--speed-limit", "--speed-time" ] } ] }, { "name": "--list-only", "aliases": [ "-l" ], "group": "ftp", "description": "When listing an FTP directory, force a name-only view. Maybe particularly useful if the user wants 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.\n\nNote: Some FTP servers list only files in their response to NLST; they do not include sub-directories and symbolic links.\n\nWhen listing an SFTP directory, this switch forces a name-only view, one per line. This is especially useful if the user wants to machine-parse the contents of an SFTP directory since the normal directory view provides more information than just filenames.\n\nWhen retrieving a specific email from POP3, this switch forces a LIST command to be performed instead of RETR. This is particularly useful if the user wants to see if a specific message-id exists on the server and what size it is.\n\nNote: When combined with --request, this option can be used to send a UIDL command instead, so the user may use the email's unique identifier rather than its message-id to make the request.\n\nProviding --list-only multiple times has no extra effect. Disable it again with --no-list-only.\n\nExample: curl --list-only ftp://example.com/dir/", "metadata": [ { "name": "x-summary", "value": "List only mode" }, { "name": "x-protocols", "value": [ "FTP", "POP3", "SFTP" ] }, { "name": "x-see-also", "value": [ "--quote", "--request" ] }, { "name": "x-categories", "value": [ "ftp", "pop3", "sftp" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--local-port", "arguments": [ { "name": "range", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\nIf --local-port is provided several times, the last set value is used.\n\nExample: curl --local-port 1000-3000 https://example.com", "metadata": [ { "name": "x-summary", "value": "Use a local port number within RANGE" }, { "name": "x-see-also", "value": [ "--globoff" ] } ] }, { "name": "--location", "aliases": [ "-L" ], "group": "http", "description": "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 on the new place. If used together with --include or --head, headers from all requested pages are shown.\n\nWhen authentication is used, curl only sends its credentials to the initial host. If a redirect takes curl to a different host, it does not get the user+password pass on. See also --location-trusted on how to change this.\n\nLimit the amount of redirects to follow by using the --max-redirs option.\n\nWhen curl follows a redirect and if 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.\n\nYou 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.\n\nThe method set with --request overrides the method curl would otherwise select to use.\n\nProviding --location multiple times has no extra effect. Disable it again with --no-location.\n\nExample: curl -L https://example.com", "metadata": [ { "name": "x-summary", "value": "Follow redirects" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--resolve", "--alt-svc" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--location-trusted", "group": "auth", "description": "Like --location, but allows sending the name + password to all hosts that the site may redirect to. This may or may not introduce a security breach if the site redirects you to a site to which you send your authentication info (which is clear-text in the case of HTTP Basic authentication).\n\nProviding --location-trusted multiple times has no extra effect. Disable it again with --no-location-trusted.\n\nExample: curl --location-trusted -u user:password https://example.com", "metadata": [ { "name": "x-summary", "value": "Like --location, but send auth to other hosts" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--user" ] }, { "name": "x-categories", "value": [ "auth", "http" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--login-options", "arguments": [ { "name": "options", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Specify the login options to use during server authentication.\n\nYou 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\n\nSince 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).\n\nIf --login-options is provided several times, the last set value is used.\n\nExample: curl --login-options 'AUTH=*' imap://example.com", "metadata": [ { "name": "x-summary", "value": "Server login options" }, { "name": "x-protocols", "value": [ "IMAP", "LDAP", "POP3", "SMTP" ] }, { "name": "x-see-also", "value": [ "--user" ] }, { "name": "x-categories", "value": [ "auth", "imap", "pop3", "smtp" ] } ] }, { "name": "--mail-auth", "arguments": [ { "name": "address", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "smtp", "description": "Specify a single address. This is used to specify the authentication address (identity) of a submitted message that is being relayed to another server.\n\nIf --mail-auth is provided several times, the last set value is used.\n\nExample: curl --mail-auth user@example.come -T mail smtp://example.com/", "metadata": [ { "name": "x-summary", "value": "Originator address of the original email" }, { "name": "x-protocols", "value": [ "SMTP" ] }, { "name": "x-see-also", "value": [ "--mail-rcpt", "--mail-from" ] } ] }, { "name": "--mail-from", "arguments": [ { "name": "address", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "smtp", "description": "Specify a single address that the given mail should get sent from.\n\nIf --mail-from is provided several times, the last set value is used.\n\nExample: curl --mail-from user@example.com -T mail smtp://example.com/", "metadata": [ { "name": "x-summary", "value": "Mail from this address" }, { "name": "x-protocols", "value": [ "SMTP" ] }, { "name": "x-see-also", "value": [ "--mail-rcpt", "--mail-auth" ] } ] }, { "name": "--mail-rcpt", "arguments": [ { "name": "address", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "smtp", "description": "Specify a single email address, username or mailing list name. Repeat this option several times to send to multiple recipients.\n\nWhen 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).\n\nWhen performing a mailing list expand (EXPN command), the recipient should be specified using the mailing list name, such as \"Friends\" or \"London-Office\".\n\n--mail-rcpt can be used several times in a command line\n\nExample: curl --mail-rcpt user@example.net smtp://example.com", "metadata": [ { "name": "x-summary", "value": "Mail to this address" }, { "name": "x-protocols", "value": [ "SMTP" ] }, { "name": "x-see-also", "value": [ "--mail-rcpt-allowfails" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--mail-rcpt-allowfails", "group": "smtp", "description": "When sending data to multiple recipients, by default curl aborts SMTP conversation if at least one of the recipients causes RCPT TO command to return an error.\n\nThe default behavior can be changed by passing --mail-rcpt-allowfails command-line option which makes curl ignore errors and proceed with the remaining valid recipients.\n\nIf all recipients trigger RCPT TO failures and this flag is specified, curl still aborts the SMTP conversation and returns the error received from to the last RCPT TO command.\n\nProviding --mail-rcpt-allowfails multiple times has no extra effect. Disable it again with --no-mail-rcpt-allowfails.\n\nExample: curl --mail-rcpt-allowfails --mail-rcpt dest@example.com smtp://example.com", "metadata": [ { "name": "x-summary", "value": "Allow RCPT TO command to fail" }, { "name": "x-protocols", "value": [ "SMTP" ] }, { "name": "x-see-also", "value": [ "--mail-rcpt" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--manual", "aliases": [ "-M" ], "group": "curl", "description": "Manual. Display the huge help text.\n\nExample: curl --manual", "metadata": [ { "name": "x-summary", "value": "Display the full manual" }, { "name": "x-see-also", "value": [ "--verbose", "--libcurl", "--trace" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--max-filesize", "arguments": [ { "name": "bytes", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Specify 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.\n\nA size modifier may be used. For example, Appending 'k' or 'K' counts the number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it gigabytes. Examples: 200K, 3m and 1G. (Added in 7.58.0)\n\nNOTE: 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.\n\nStarting with curl 8.4.0, this option aborts the transfer if it reaches the threshold during transfer.\n\nIf --max-filesize is provided several times, the last set value is used.\n\nExample: curl --max-filesize 100K https://example.com", "metadata": [ { "name": "x-summary", "value": "Maximum file size to download" }, { "name": "x-protocols", "value": [ "FTP", "HTTP", "MQTT" ] }, { "name": "x-see-also", "value": [ "--limit-rate" ] } ] }, { "name": "--max-redirs", "arguments": [ { "name": "num", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Set maximum number of redirections to follow. When --location is used, to prevent curl from following too many redirects, by default, the limit is set to 50 redirects. Set this option to -1 to make it unlimited.\n\nIf --max-redirs is provided several times, the last set value is used.\n\nExample: curl --max-redirs 3 --location https://example.com", "metadata": [ { "name": "x-summary", "value": "Maximum number of redirects allowed" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--location" ] } ] }, { "name": "--max-time", "aliases": [ "-m" ], "arguments": [ { "name": "seconds", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Set maximum time in seconds that you allow each transfer to take. Prevents your batch jobs from hanging for hours due to slow networks or links going down. This option accepts decimal values.\n\nIf you enable retrying the transfer (--retry) then the maximum time counter is reset each time the transfer is retried. You can use --retry-max-time to limit the retry time.\n\nThe decimal value needs to provided using a dot (.) as decimal separator - not the local version even if it might be using another separator.\n\nIf --max-time is provided several times, the last set value is used.\n\nExamples: curl --max-time 10 https://example.com curl --max-time 2.92 https://example.com", "metadata": [ { "name": "x-summary", "value": "Maximum time allowed for transfer" }, { "name": "x-see-also", "value": [ "--connect-timeout", "--retry-max-time" ] } ] }, { "name": "--metalink", "group": "misc", "description": "This option was previously used to specify a Metalink resource. Metalink support is disabled in curl for security reasons (added in 7.78.0).\n\nIf --metalink is provided several times, the last set value is used.\n\nExample: curl --metalink file https://example.com", "metadata": [ { "name": "x-summary", "value": "Process given URLs as metalink XML file" }, { "name": "x-see-also", "value": [ "--parallel" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--negotiate", "group": "auth", "description": "Enable Negotiate (SPNEGO) authentication.\n\nThis option requires a library built with GSS-API or SSPI support. Use --version to see if your curl supports GSS-API/SSPI or SPNEGO.\n\nWhen using this option, you must also provide a fake --user option to activate the authentication code properly. Sending a '-u :' is enough as the username and password from the --user option are not actually used.\n\nProviding --negotiate multiple times has no extra effect.\n\nExample: curl --negotiate -u : https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP Negotiate (SPNEGO) authentication" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--basic", "--ntlm", "--anyauth", "--proxy-negotiate" ] }, { "name": "x-categories", "value": [ "auth", "http" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--netrc", "aliases": [ "-n" ], "group": "curl", "description": "Make curl scan the .netrc file in the user's home directory for login name and password. This is typically 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 does not have the right permissions (it should be neither world- nor group-readable). The environment variable \"HOME\" is used to find the home directory.\n\nOn Windows two filenames in the home directory are checked: .netrc and _netrc, preferring the former. Older versions on Windows checked for _netrc only.\n\nA quick and simple example of how to setup a .netrc to allow curl to FTP to the machine host.domain.com with username 'myself' and password 'secret' could look similar to:\n\nmachine host.domain.com login myself password secret Providing --netrc multiple times has no extra effect. Disable it again with --no-netrc.\n\nExample: curl --netrc https://example.com", "metadata": [ { "name": "x-summary", "value": "Must read .netrc for username and password" }, { "name": "x-see-also", "value": [ "--netrc-file", "--config", "--user", "--netrc-file", "--netrc-optional" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--netrc-file", "arguments": [ { "name": "filename", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "Set the netrc file to use. Similar to --netrc, except that you also provide the path (absolute or relative).\n\nIt abides by --netrc-optional if specified.\n\nIf --netrc-file is provided several times, the last set value is used.\n\nExample: curl --netrc-file netrc https://example.com", "metadata": [ { "name": "x-summary", "value": "Specify FILE for netrc" }, { "name": "x-see-also", "value": [ "--netrc", "--user", "--config", "--netrc" ] } ] }, { "name": "--netrc-optional", "group": "curl", "description": "Similar to --netrc, but this option makes the .netrc usage optional and not mandatory as the --netrc option does.\n\nProviding --netrc-optional multiple times has no extra effect. Disable it again with --no-netrc-optional.\n\nExample: curl --netrc-optional https://example.com", "metadata": [ { "name": "x-summary", "value": "Use either .netrc or URL" }, { "name": "x-see-also", "value": [ "--netrc-file", "--netrc" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--next", "aliases": [ "-:" ], "group": "curl", "description": "Use a separate operation for the following URL and associated options. This allows you to send several URL requests, each with their own specific options, for example, such as different usernames or custom requests for each.\n\n--next resets all local options and only global ones have their values survive over to the operation following the --next instruction. Global options include --verbose, --trace, --trace-ascii and --fail-early.\n\nFor example, you can do both a GET and a POST in a single command line:\n\ncurl www1.example.com --next -d postthis www2.example.com --next can be used several times in a command line\n\nExamples: curl https://example.com --next -d postthis www2.example.com curl -I https://example.com --next https://example.net/", "metadata": [ { "name": "x-summary", "value": "Make next URL use its separate set of options" }, { "name": "x-see-also", "value": [ "--parallel", "--config" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--no-alpn", "group": "http", "description": "Disable the ALPN TLS extension. ALPN is enabled by default if libcurl was built with an SSL library that supports ALPN. ALPN is used by a libcurl that supports HTTP/2 to negotiate HTTP/2 support with the server during https sessions.\n\nNote that this is the negated option name documented. You can use --alpn to enable ALPN.\n\nProviding --no-alpn multiple times has no extra effect. Disable it again with --alpn.\n\nExample: curl --no-alpn https://example.com", "metadata": [ { "name": "x-summary", "value": "Disable the ALPN TLS extension" }, { "name": "x-protocols", "value": [ "HTTPS" ] }, { "name": "x-see-also", "value": [ "--no-npn", "--http2", "--no-alpn" ] }, { "name": "x-categories", "value": [ "http", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--no-buffer", "aliases": [ "-N" ], "group": "curl", "description": "Disables the buffering of the output stream. In normal work situations, curl uses a standard buffered output stream that has the effect that it outputs the data in chunks, not necessarily exactly when the data arrives. Using this option disables that buffering.\n\nNote that this is the negated option name documented. You can use --buffer to enable buffering again.\n\nProviding --no-buffer multiple times has no extra effect. Disable it again with --buffer.\n\nExample: curl --no-buffer https://example.com", "metadata": [ { "name": "x-summary", "value": "Disable buffering of the output stream" }, { "name": "x-see-also", "value": [ "--progress-bar" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--no-clobber", "group": "curl", "description": "When used in conjunction 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.100 after which it does not create any file.\n\nNote that this is the negated option name documented. You can thus use --clobber to enforce the clobbering, even if --remote-header-name is specified.\n\nProviding --no-clobber multiple times has no extra effect. Disable it again with --clobber.\n\nExample: curl --no-clobber --output local/dir/file https://example.com", "metadata": [ { "name": "x-summary", "value": "Do not overwrite files that already exist" }, { "name": "x-see-also", "value": [ "--output", "--remote-name" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "curl", "output" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--no-keepalive", "group": "connection", "description": "Disables the use of keepalive messages on the TCP connection. curl otherwise enables them by default.\n\nNote that this is the negated option name documented. You can thus use --keepalive to enforce keepalive.\n\nProviding --no-keepalive multiple times has no extra effect. Disable it again with --keepalive.\n\nExample: curl --no-keepalive https://example.com", "metadata": [ { "name": "x-summary", "value": "Disable TCP keepalive on the connection" }, { "name": "x-see-also", "value": [ "--keepalive-time" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--no-npn", "group": "http", "description": "curl never uses NPN, this option has no effect (added in 7.86.0).\n\nDisable the NPN TLS extension. NPN is enabled by default if libcurl was built with an SSL library that supports NPN. NPN is used by a libcurl that supports HTTP/2 to negotiate HTTP/2 support with the server during https sessions.\n\nProviding --no-npn multiple times has no extra effect. Disable it again with --npn.\n\nExample: curl --no-npn https://example.com", "metadata": [ { "name": "x-summary", "value": "Disable the NPN TLS extension" }, { "name": "x-protocols", "value": [ "HTTPS" ] }, { "name": "x-see-also", "value": [ "--no-alpn", "--http2", "--no-npn" ] }, { "name": "x-categories", "value": [ "http", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--no-progress-meter", "group": "verbose", "description": "Option to switch off the progress meter output without muting or otherwise affecting warning and informational messages like --silent does.\n\nNote that this is the negated option name documented. You can thus use --progress-meter to enable the progress meter again.\n\nProviding --no-progress-meter multiple times has no extra effect. Disable it again with --progress-meter.\n\nExample: curl --no-progress-meter -o store https://example.com", "metadata": [ { "name": "x-summary", "value": "Do not show the progress meter" }, { "name": "x-see-also", "value": [ "--verbose", "--silent" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--no-sessionid", "group": "tls", "description": "Disable curl's use of SSL session-ID caching. By default all transfers are done using the cache. Note that while nothing should ever get hurt by attempting to reuse SSL session-IDs, there seem to be broken SSL implementations in the wild that may require you to disable this in order for you to succeed.\n\nNote that this is the negated option name documented. You can thus use --sessionid to enforce session-ID caching.\n\nProviding --no-sessionid multiple times has no extra effect. Disable it again with --sessionid.\n\nExample: curl --no-sessionid https://example.com", "metadata": [ { "name": "x-summary", "value": "Disable SSL session-ID reusing" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--insecure" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--noproxy", "arguments": [ { "name": "no-proxy-list", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Comma-separated list of hosts for which not to use a proxy, if one is specified. The only wildcard is a single \"*\" character, which matches all hosts, and effectively disables the proxy. Each name in this list is matched as either a domain which 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\".\n\nThis option overrides the environment variables that disable the proxy (\"no_proxy\" and \"NO_PROXY\") (added in 7.53.0). If there is an environment variable disabling a proxy, you can set the no proxy list to \"\" to override it.\n\nIP addresses specified to this option can be provided using 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. For example \"192.168.0.0/16\" would match all addresses starting with \"192.168\".\n\nIf --noproxy is provided several times, the last set value is used.\n\nExample: curl --noproxy \"www.example\" https://example.com", "metadata": [ { "name": "x-summary", "value": "List of hosts which do not use proxy" }, { "name": "x-see-also", "value": [ "--proxy" ] } ] }, { "name": "--ntlm", "group": "auth", "description": "Use NTLM authentication. The NTLM authentication method was designed by Microsoft and is used by IIS web servers. It is a proprietary protocol, reverse-engineered by clever people and implemented in curl based on their efforts. 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.\n\nIf you want to enable NTLM for your proxy authentication, then use --proxy-ntlm.\n\nProviding --ntlm multiple times has no extra effect.\n\nExample: curl --ntlm -u user:password https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP NTLM authentication" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy-ntlm", "--ntlm", "--basic", "--negotiate", "--digest", "--anyauth" ] }, { "name": "x-categories", "value": [ "auth", "http" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ntlm-wb", "group": "auth", "description": "Enables NTLM much in the style --ntlm does, but hand over the authentication to the separate binary \"ntlmauth\" application that is executed when needed.\n\nProviding --ntlm-wb multiple times has no extra effect.\n\nExample: curl --ntlm-wb -u user:password https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP NTLM authentication with winbind" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--ntlm", "--proxy-ntlm" ] }, { "name": "x-categories", "value": [ "auth", "http" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--oauth2-bearer", "arguments": [ { "name": "token", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Specify the Bearer Token for OAUTH 2.0 server authentication. The Bearer Token is used in conjunction with the username which can be specified as part of the --url or --user options.\n\nThe Bearer Token and username are formatted according to RFC 6750.\n\nIf --oauth2-bearer is provided several times, the last set value is used.\n\nExample: curl --oauth2-bearer \"mF_9.B5f-4.1JqM\" https://example.com", "metadata": [ { "name": "x-summary", "value": "OAuth 2 Bearer Token" }, { "name": "x-protocols", "value": [ "IMAP", "LDAP", "POP3", "SMTP", "HTTP" ] }, { "name": "x-see-also", "value": [ "--basic", "--ntlm", "--digest" ] } ] }, { "name": "--output", "aliases": [ "-o" ], "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "Write output to the given file instead of stdout. If you are using globbing to fetch multiple documents, you should quote the URL and you can use \"#\" followed by a number in the filename. That variable is then replaced with the current string for the URL being fetched. Like in:\n\ncurl \"http://{one,two}.example.com\" -o \"file_#1.txt\"\n\nor use several variables like:\n\ncurl \"http://{site,host}.host[1-5].example\" -o \"#1_#2\"\n\nYou 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:\n\ncurl -o aa example.com -o bb example.net\n\nand the order of the -o options and the URLs does not matter, just that the first -o is for the first URL and so on, so the above command line can also be written as\n\ncurl example.com example.net -o aa -o bb\n\nTo suppress response bodies, you can redirect output to /dev/null:\n\ncurl example.com -o /dev/null\n\nOr for Windows:\n\ncurl example.com -o nul\n\nSpecify the filename as single minus to force the output to stdout, to override curl's internal binary output in terminal prevention:\n\ncurl https://example.com/jpeg -o - --output can be used several times in a command line\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Write to file instead of stdout" }, { "name": "x-see-also", "value": [ "--remote-name", "--remote-name-all", "--remote-header-name" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--output-dir", "arguments": [ { "name": "dir", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "Specify the directory in which files should be stored, when --remote-name or --output are used.\n\nThe given output directory is used for all URLs and output options on the command line, up until the first --next.\n\nIf the specified target directory does not exist, the operation fails unless --create-dirs is also used.\n\nIf --output-dir is provided several times, the last set value is used.\n\nExample: curl --output-dir \"tmp\" -O https://example.com", "metadata": [ { "name": "x-summary", "value": "Directory to save files in" }, { "name": "x-see-also", "value": [ "--remote-name", "--remote-header-name" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--parallel", "aliases": [ "-Z" ], "group": "connection", "description": "Makes curl perform its transfers in parallel as compared to the regular serial manner.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --parallel multiple times has no extra effect. Disable it again with --no-parallel.\n\nExample: curl --parallel https://example.com -o file1 https://example.com -o file2", "metadata": [ { "name": "x-summary", "value": "Perform transfers in parallel" }, { "name": "x-see-also", "value": [ "--next", "--verbose" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "connection", "curl" ] }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--parallel-immediate", "group": "connection", "description": "When doing parallel transfers, this option instructs curl that it should rather prefer opening up more connections in parallel at once rather than waiting to see if new transfers can be added as multiplexed streams on another connection.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --parallel-immediate multiple times has no extra effect. Disable it again with --no-parallel-immediate.\n\nExample: curl --parallel-immediate -Z https://example.com -o file1 https://example.com -o file2", "metadata": [ { "name": "x-summary", "value": "Do not wait for multiplexing (with --parallel)" }, { "name": "x-see-also", "value": [ "--parallel", "--parallel-max" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "connection", "curl" ] }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--parallel-max", "arguments": [ { "name": "num", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "When asked to do parallel transfers, using --parallel, this option controls the maximum amount of transfers to do simultaneously.\n\nThis option is global and does not need to be specified for each use of --next.\n\nThe default is 50.\n\nIf --parallel-max is provided several times, the last set value is used.\n\nExample: curl --parallel-max 100 -Z https://example.com ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Maximum concurrency for parallel transfers" }, { "name": "x-see-also", "value": [ "--parallel" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "connection", "curl" ] } ] }, { "name": "--pass", "arguments": [ { "name": "phrase", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Passphrase for the private key.\n\nIf --pass is provided several times, the last set value is used.\n\nExample: curl --pass secret --key file https://example.com", "metadata": [ { "name": "x-summary", "value": "Pass phrase for the private key" }, { "name": "x-protocols", "value": [ "SSH", "TLS" ] }, { "name": "x-see-also", "value": [ "--key", "--user" ] }, { "name": "x-categories", "value": [ "auth", "ssh", "tls" ] } ] }, { "name": "--path-as-is", "group": "curl", "description": "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 tell it not to do that.\n\nProviding --path-as-is multiple times has no extra effect. Disable it again with --no-path-as-is.\n\nExample: curl --path-as-is https://example.com/../../etc/passwd", "metadata": [ { "name": "x-summary", "value": "Do not squash .. sequences in URL path" }, { "name": "x-see-also", "value": [ "--request-target" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--pinnedpubkey", "arguments": [ { "name": "hashes", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Use the specified public key file (or hashes) to verify the peer. 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 ';'.\n\nWhen 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.\n\nThis option is independent of option --insecure. If you use both options together then the peer is still verified by public key.\n\nPEM/DER support:\n\nOpenSSL and GnuTLS, wolfSSL (added in 7.43.0), mbedTLS , Secure Transport macOS 10.7+/iOS 10+ (7.54.1), Schannel (7.58.1)\n\nsha256 support:\n\nOpenSSL, GnuTLS and wolfSSL, mbedTLS (added in 7.47.0), Secure Transport macOS 10.7+/iOS 10+ (7.54.1), Schannel (7.58.1)\n\nOther SSL backends not supported.\n\nIf --pinnedpubkey is provided several times, the last set value is used.\n\nExamples: curl --pinnedpubkey keyfile https://example.com curl --pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com", "metadata": [ { "name": "x-summary", "value": "FILE/HASHES Public key to verify peer against" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--hostpubsha256" ] } ] }, { "name": "--post301", "group": "http", "description": "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 ubiquitous in web browsers, so curl does the conversion by default to maintain consistency. However, a server may require a POST to remain a POST after such a redirection. This option is meaningful only when using --location.\n\nProviding --post301 multiple times has no extra effect. Disable it again with --no-post301.\n\nExample: curl --post301 --location -d \"data\" https://example.com", "metadata": [ { "name": "x-summary", "value": "Do not switch to GET after a 301 redirect" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--post302", "--post303", "--location" ] }, { "name": "x-categories", "value": [ "http", "post" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--post302", "group": "http", "description": "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 does the conversion by default to maintain consistency. However, a server may require a POST to remain a POST after such a redirection. This option is meaningful only when using --location.\n\nProviding --post302 multiple times has no extra effect. Disable it again with --no-post302.\n\nExample: curl --post302 --location -d \"data\" https://example.com", "metadata": [ { "name": "x-summary", "value": "Do not switch to GET after a 302 redirect" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--post301", "--post303", "--location" ] }, { "name": "x-categories", "value": [ "http", "post" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--post303", "group": "http", "description": "Violate RFC 7231/6.4.4 and do not convert POST requests into GET requests when following 303 redirect. A server may require a POST to remain a POST after a 303 redirection. This option is meaningful only when using --location.\n\nProviding --post303 multiple times has no extra effect. Disable it again with --no-post303.\n\nExample: curl --post303 --location -d \"data\" https://example.com\n\n--preproxy [protocol://]host[:port] Use the specified SOCKS proxy before connecting to an HTTP or HTTPS --proxy. In such a case curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy. Hence pre proxy.\n\nThe 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.\n\nIf the port number is not specified in the proxy string, it is assumed to be 1080.\n\nUser 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.\n\nIf --preproxy is provided several times, the last set value is used.\n\nExample: curl --preproxy socks5://proxy.example -x http://http.example https://example.com", "metadata": [ { "name": "x-summary", "value": "Do not switch to GET after a 303 redirect" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy", "--socks5" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "http", "post" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--progress-bar", "aliases": [ "-#" ], "group": "verbose", "description": "Make curl display transfer progress as a simple progress bar instead of the standard, more informational, meter.\n\nThis 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 is 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.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --progress-bar multiple times has no extra effect. Disable it again with --no-progress-bar.\n\nExample: curl -# -O https://example.com", "metadata": [ { "name": "x-summary", "value": "Display transfer progress as a bar" }, { "name": "x-see-also", "value": [ "--styled-output" ] }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--proto", "arguments": [ { "name": "protocols", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Limit what protocols to allow for transfers. Protocols are evaluated left to right, are comma separated, and are each a protocol name or 'all', optionally prefixed by zero or more modifiers. Available modifiers are:\n\n+\n\nPermit this protocol in addition to protocols already permitted (this is the default if no modifier is used).\n\n-\n\nDeny this protocol, removing it from the list of protocols already permitted.\n\n=\n\nPermit only this protocol (ignoring the list already permitted), though subject to later modification by subsequent entries in the comma separated list.\n\n.RE .IP\n\nFor example: --proto -ftps uses the default protocols, but disables ftps\n\n--proto -all,https,+http only enables http and https\n\n--proto =http,https also only enables http and https\n\nUnknown 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.\n\nThis option can be used multiple times, in which case the effect is the same as concatenating the protocols into one instance of the option.\n\nIf --proto is provided several times, the last set value is used.\n\nExample: curl --proto =http,https,sftp https://example.com", "metadata": [ { "name": "x-summary", "value": "Enable/disable PROTOCOLS" }, { "name": "x-see-also", "value": [ "--proto-redir", "--proto-default" ] }, { "name": "x-categories", "value": [ "connection", "curl" ] } ] }, { "name": "--proto-default", "arguments": [ { "name": "protocol", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Use protocol for any provided URL missing a scheme.\n\nAn unknown or unsupported protocol causes error CURLE_UNSUPPORTED_PROTOCOL.\n\nThis option does not change the default proxy protocol (http).\n\nWithout this option set, curl guesses protocol based on the hostname, see --url for details.\n\nIf --proto-default is provided several times, the last set value is used.\n\nExample: curl --proto-default https ftp.example.com", "metadata": [ { "name": "x-summary", "value": "Use PROTOCOL for any URL missing a scheme" }, { "name": "x-see-also", "value": [ "--proto", "--proto-redir" ] }, { "name": "x-categories", "value": [ "connection", "curl" ] } ] }, { "name": "--proto-redir", "arguments": [ { "name": "protocols", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Limit what protocols to allow on redirects. Protocols denied by --proto are not overridden by this option. See --proto for how protocols are represented.\n\nExample, allow only HTTP and HTTPS on redirect:\n\ncurl --proto-redir -all,http,https http://example.com\n\nBy default curl only allows HTTP, HTTPS, FTP and FTPS on redirects (added in 7.65.2). Specifying all or +all enables all protocols on redirects, which is not good for security.\n\nIf --proto-redir is provided several times, the last set value is used.\n\nExample: curl --proto-redir =http,https https://example.com", "metadata": [ { "name": "x-summary", "value": "Enable/disable PROTOCOLS on redirect" }, { "name": "x-see-also", "value": [ "--proto" ] }, { "name": "x-categories", "value": [ "connection", "curl" ] } ] }, { "name": "--proxy-anyauth", "group": "auth", "description": "Automatically pick a suitable authentication method when communicating with the given HTTP proxy. This might cause an extra request/response round-trip.\n\nProviding --proxy-anyauth multiple times has no extra effect.\n\nExample: curl --proxy-anyauth --proxy-user user:passwd -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Pick any proxy authentication method" }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-basic", "--proxy-digest" ] }, { "name": "x-categories", "value": [ "auth", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-basic", "group": "auth", "description": "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.\n\nProviding --proxy-basic multiple times has no extra effect.\n\nExample: curl --proxy-basic --proxy-user user:passwd -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Use Basic authentication on the proxy" }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-anyauth", "--proxy-digest" ] }, { "name": "x-categories", "value": [ "auth", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-ca-native", "group": "tls", "description": "Use the CA store from the native operating system to verify the HTTPS proxy. By default, curl uses a CA store provided in a single file or directory, but when using this option it interfaces the operating system's own vault.\n\nThis option works for curl on Windows when built to use OpenSSL, wolfSSL (added in 8.3.0) or GnuTLS (added in 8.5.0). When curl on Windows is built to use Schannel, this feature is implied and curl then only uses the native CA store.\n\nProviding --proxy-ca-native multiple times has no extra effect. Disable it again with --no-proxy-ca-native.\n\nExample: curl --ca-native https://example.com", "metadata": [ { "name": "x-summary", "value": "Load CA certs from the OS to verify proxy" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--cacert", "--capath", "--insecure" ] }, { "name": "x-added-in", "value": "8" }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-cacert", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --cacert but used in HTTPS proxy context.\n\nIf --proxy-cacert is provided several times, the last set value is used.\n\nExample: curl --proxy-cacert CA-file.txt -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "CA certificates to verify proxy against" }, { "name": "x-see-also", "value": [ "--proxy-capath", "--cacert", "--capath", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-capath", "arguments": [ { "name": "dir", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --capath but used in HTTPS proxy context.\n\nUse the specified certificate directory to verify the proxy. Multiple paths can be provided by separated 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.\n\nIf this option is set, the default capath value is ignored.\n\nIf --proxy-capath is provided several times, the last set value is used.\n\nExample: curl --proxy-capath /local/directory -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "CA directory to verify proxy against" }, { "name": "x-see-also", "value": [ "--proxy-cacert", "--proxy", "--capath" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-cert", "arguments": [ { "name": "cert[:passwd]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --cert but used in HTTPS proxy context.\n\nIf --proxy-cert is provided several times, the last set value is used.\n\nExample: curl --proxy-cert file -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Set client certificate for proxy" }, { "name": "x-see-also", "value": [ "--proxy-cert-type" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-cert-type", "arguments": [ { "name": "type", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --cert-type but used in HTTPS proxy context.\n\nIf --proxy-cert-type is provided several times, the last set value is used.\n\nExample: curl --proxy-cert-type PEM --proxy-cert file -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Client certificate type for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--proxy-cert" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-ciphers", "arguments": [ { "name": "list", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --ciphers but used in HTTPS proxy context.\n\nSpecifies which ciphers to use in the connection to the HTTPS proxy. The list of ciphers must specify valid ciphers. Read up on SSL cipher list details on this URL:\n\nhttps://curl.se/docs/ssl-ciphers.html\n\nIf --proxy-ciphers is provided several times, the last set value is used.\n\nExample: curl --proxy-ciphers ECDHE-ECDSA-AES256-CCM8 -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "SSL ciphers to use for proxy" }, { "name": "x-see-also", "value": [ "--ciphers", "--curves", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-crlfile", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --crlfile but used in HTTPS proxy context.\n\nIf --proxy-crlfile is provided several times, the last set value is used.\n\nExample: curl --proxy-crlfile rejects.txt -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Set a CRL list for proxy" }, { "name": "x-see-also", "value": [ "--crlfile", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-digest", "group": "proxy", "description": "Use HTTP Digest authentication when communicating with the given proxy. Use --digest for enabling HTTP Digest with a remote host.\n\nProviding --proxy-digest multiple times has no extra effect.\n\nExample: curl --proxy-digest --proxy-user user:passwd -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Digest auth with the proxy" }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-anyauth", "--proxy-basic" ] }, { "name": "x-categories", "value": [ "proxy", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-header", "arguments": [ { "name": "header/@file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "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.\n\ncurl 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.\n\nHeaders specified with this option are not included in requests that curl knows are not be sent to a proxy.\n\nThis option can take an argument in @filename style, which then adds a header for each line in the input file (added in 7.55.0). Using @- makes curl read the headers from stdin.\n\nThis option can be used multiple times to add/replace/remove multiple headers.\n\n--proxy-header can be used several times in a command line\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Pass custom header(s) to proxy" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--proxy-http2", "group": "http", "description": "Negotiate HTTP/2 with an HTTPS proxy. The proxy might still only offer HTTP/1 and then curl sticks to using that version.\n\nThis has no effect for any other kinds of proxies.\n\nProviding --proxy-http2 multiple times has no extra effect. Disable it again with --no-proxy-http2.\n\nExample: curl --proxy-http2 -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP/2 with HTTPS proxy" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-http2" ] }, { "name": "x-added-in", "value": "8" }, { "name": "x-categories", "value": [ "http", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-insecure", "group": "proxy", "description": "Same as --insecure but used in HTTPS proxy context.\n\nEvery secure connection curl makes is verified to be secure before the transfer takes place. This option makes curl skip the verification step with a proxy and proceed without checking.\n\nWhen 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\n\nWARNING: using this option makes the transfer to the proxy insecure.\n\nProviding --proxy-insecure multiple times has no extra effect. Disable it again with --no-proxy-insecure.\n\nExample: curl --proxy-insecure -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Skip HTTPS proxy cert verification" }, { "name": "x-see-also", "value": [ "--proxy", "--insecure" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-key", "arguments": [ { "name": "key", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --key but used in HTTPS proxy context.\n\nIf --proxy-key is provided several times, the last set value is used.\n\nExample: curl --proxy-key here -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Private key for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--proxy-key-type", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-key-type", "arguments": [ { "name": "type", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Same as --key-type but used in HTTPS proxy context.\n\nIf --proxy-key-type is provided several times, the last set value is used.\n\nExample: curl --proxy-key-type DER --proxy-key here -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Private key file type for proxy" }, { "name": "x-see-also", "value": [ "--proxy-key", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-negotiate", "group": "auth", "description": "Use HTTP Negotiate (SPNEGO) authentication when communicating with the given proxy. Use --negotiate for enabling HTTP Negotiate (SPNEGO) with a remote host.\n\nProviding --proxy-negotiate multiple times has no extra effect.\n\nExample: curl --proxy-negotiate --proxy-user user:passwd -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP Negotiate (SPNEGO) auth with the proxy" }, { "name": "x-see-also", "value": [ "--proxy-anyauth", "--proxy-basic" ] }, { "name": "x-categories", "value": [ "auth", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-ntlm", "group": "auth", "description": "Use HTTP NTLM authentication when communicating with the given proxy. Use --ntlm for enabling NTLM with a remote host.\n\nProviding --proxy-ntlm multiple times has no extra effect.\n\nExample: curl --proxy-ntlm --proxy-user user:passwd -x http://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "NTLM authentication with the proxy" }, { "name": "x-see-also", "value": [ "--proxy-negotiate", "--proxy-anyauth" ] }, { "name": "x-categories", "value": [ "auth", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-pass", "arguments": [ { "name": "phrase", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Same as --pass but used in HTTPS proxy context.\n\nIf --proxy-pass is provided several times, the last set value is used.\n\nExample: curl --proxy-pass secret --proxy-key here -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Pass phrase for the private key for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-key" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "proxy", "tls" ] } ] }, { "name": "--proxy-pinnedpubkey", "arguments": [ { "name": "hashes", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "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 ';'.\n\nWhen 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.\n\nIf --proxy-pinnedpubkey is provided several times, the last set value is used.\n\nExamples: curl --proxy-pinnedpubkey keyfile https://example.com curl --proxy-pinnedpubkey 'sha256//ce118b51897f4452dc' https://example.com", "metadata": [ { "name": "x-summary", "value": "FILE/HASHES public key to verify proxy with" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--pinnedpubkey", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-service-name", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Set the service name for proxy negotiation.\n\nIf --proxy-service-name is provided several times, the last set value is used.\n\nExample: curl --proxy-service-name \"shrubbery\" -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "SPNEGO proxy service name" }, { "name": "x-see-also", "value": [ "--service-name", "--proxy" ] }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-ssl-allow-beast", "group": "proxy", "description": "Same as --ssl-allow-beast but used in HTTPS proxy context.\n\nProviding --proxy-ssl-allow-beast multiple times has no extra effect. Disable it again with --no-proxy-ssl-allow-beast.\n\nExample: curl --proxy-ssl-allow-beast -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Allow security flaw for interop for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--ssl-allow-beast", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-ssl-auto-client-cert", "group": "proxy", "description": "Same as --ssl-auto-client-cert but used in HTTPS proxy context.\n\nThis is only supported by Schannel.\n\nProviding --proxy-ssl-auto-client-cert multiple times has no extra effect. Disable it again with --no-proxy-ssl-auto-client-cert.\n\nExample: curl --proxy-ssl-auto-client-cert -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Auto client certificate for proxy" }, { "name": "x-see-also", "value": [ "--ssl-auto-client-cert", "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-tls13-ciphers", "arguments": [ { "name": "ciphersuite list", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Specify which cipher suites to use in the connection to your HTTPS proxy when 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:\n\nhttps://curl.se/docs/ssl-ciphers.html\n\nThis option is currently used only when curl is built to use OpenSSL 1.1.1 or later. If you are using a different SSL backend you can try setting TLS 1.3 cipher suites by using the --proxy-ciphers option.\n\nIf --proxy-tls13-ciphers is provided several times, the last set value is used.\n\nExample: curl --proxy-tls13-ciphers TLS_AES_128_GCM_SHA256 -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS 1.3 proxy cipher suites" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tls13-ciphers", "--curves", "--proxy-ciphers" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "proxy", "tls" ] } ] }, { "name": "--proxy-tlsauthtype", "arguments": [ { "name": "type", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Same as --tlsauthtype but used in HTTPS proxy context.\n\nIf --proxy-tlsauthtype is provided several times, the last set value is used.\n\nExample: curl --proxy-tlsauthtype SRP -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS authentication type for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-tlsuser" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "proxy", "tls" ] } ] }, { "name": "--proxy-tlspassword", "arguments": [ { "name": "string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Same as --tlspassword but used in HTTPS proxy context.\n\nIf --proxy-tlspassword is provided several times, the last set value is used.\n\nExample: curl --proxy-tlspassword passwd -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS password for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-tlsuser" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "proxy", "tls" ] } ] }, { "name": "--proxy-tlsuser", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Same as --tlsuser but used in HTTPS proxy context.\n\nIf --proxy-tlsuser is provided several times, the last set value is used.\n\nExample: curl --proxy-tlsuser smith -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS username for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--proxy", "--proxy-tlspassword" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "proxy", "tls" ] } ] }, { "name": "--proxy-tlsv1", "group": "auth", "description": "Same as --tlsv1 but used in HTTPS proxy context.\n\nProviding --proxy-tlsv1 multiple times has no extra effect.\n\nExample: curl --proxy-tlsv1 -x https://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "TLSv1 for HTTPS proxy" }, { "name": "x-see-also", "value": [ "--proxy" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "proxy", "tls" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--proxy-user", "aliases": [ "-U" ], "arguments": [ { "name": "user:password", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Specify the username and password to use for proxy authentication.\n\nIf you use a Windows SSPI-enabled curl binary and do either Negotiate or NTLM authentication then you can tell curl to select the username and password from your environment by specifying a single colon with this option: \"-U :\".\n\nOn 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 cleared. Such sensitive data should be retrieved from a file instead or similar and never used in clear text in a command line.\n\nIf --proxy-user is provided several times, the last set value is used.\n\nExample: curl --proxy-user smith:secret -x proxy https://example.com\n\n-x, --proxy [protocol://]host[:port] Use the specified proxy.\n\nThe proxy string can be specified with a protocol:// prefix. No protocol specified or http:// it is treated as an HTTP proxy. Use socks4://, socks4a://, socks5:// or socks5h:// to request a specific SOCKS version to be used.\n\nUnix domain sockets are supported for socks proxy. Set localhost for the host part. e.g. socks5h://localhost/path/to/socket.sock\n\nHTTPS proxy support works set with the https:// protocol prefix for OpenSSL and GnuTLS (added in 7.52.0). It also works for BearSSL, mbedTLS, rustls, Schannel, Secure Transport and wolfSSL (added in 7.87.0).\n\nUnrecognized and unsupported proxy protocols cause an error (added in 7.52.0). Ancient curl versions ignored unknown schemes and used http:// instead.\n\nIf the port number is not specified in the proxy string, it is assumed to be 1080.\n\nThis 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.\n\nAll 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.\n\nUser 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.\n\nThe proxy host can be specified the same way as the proxy environment variables, including the protocol prefix (http://) and the embedded user + password.\n\nWhen a proxy is used, the active FTP mode as set with --ftp-port, cannot be used.\n\nIf --proxy is provided several times, the last set value is used.\n\nExample: curl --proxy http://proxy.example https://example.com", "metadata": [ { "name": "x-summary", "value": "Proxy user and password" }, { "name": "x-see-also", "value": [ "--socks5", "--proxy-basic" ] }, { "name": "x-categories", "value": [ "auth", "proxy" ] } ] }, { "name": "--proxy1.0", "arguments": [ { "name": "host[:port]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Use the specified HTTP 1.0 proxy. If the port number is not specified, it is assumed at port 1080.\n\nThe only difference between this and the HTTP proxy option --proxy, is that attempts to use CONNECT through the proxy specifies an HTTP 1.0 protocol instead of the default HTTP 1.1.\n\nProviding --proxy1.0 multiple times has no extra effect.\n\nExample: curl --proxy1.0 http://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Use HTTP/1.0 proxy on given port" }, { "name": "x-see-also", "value": [ "--proxy", "--socks5", "--preproxy" ] } ] }, { "name": "--proxytunnel", "aliases": [ "-p" ], "group": "proxy", "description": "When an HTTP proxy is used --proxy, this option makes curl tunnel the traffic through the proxy. The tunnel approach is made with the HTTP proxy CONNECT request and requires that the proxy allows direct connect to the remote port number curl wants to tunnel through to.\n\nTo suppress proxy CONNECT response headers when curl is set to output headers use --suppress-connect-headers.\n\nProviding --proxytunnel multiple times has no extra effect. Disable it again with --no-proxytunnel.\n\nExample: curl --proxytunnel -x http://proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "HTTP proxy tunnel (using CONNECT)" }, { "name": "x-see-also", "value": [ "--proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--pubkey", "arguments": [ { "name": "key", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Public key filename. Allows you to provide your public key in this separate file.\n\ncurl 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.\n\nIf --pubkey is provided several times, the last set value is used.\n\nExample: curl --pubkey file.pub sftp://example.com/", "metadata": [ { "name": "x-summary", "value": "SSH Public key filename" }, { "name": "x-protocols", "value": [ "SFTP", "SCP" ] }, { "name": "x-see-also", "value": [ "--pass" ] }, { "name": "x-categories", "value": [ "auth", "scp", "sftp" ] } ] }, { "name": "--quote", "aliases": [ "-Q" ], "arguments": [ { "name": "command", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "Send an arbitrary command to the remote FTP or SFTP server. Quote commands are sent BEFORE the transfer takes place (just 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 '-'.\n\n(FTP only) To make commands be sent after curl has changed the working directory, just before the file transfer command(s), prefix the command with a '+'. This is not performed when a directory listing is performed.\n\nYou may specify any number of commands.\n\nBy 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.\n\nYou must send syntactically correct FTP commands as RFC 959 defines to FTP servers, or one of the commands listed below to SFTP servers.\n\nSFTP is a binary protocol. Unlike for FTP, curl interprets SFTP quote commands itself before sending them to the server. Filenames may be quoted shell-style to embed spaces or special characters. Following is the list of all supported SFTP quote commands:\n\natime date file\n\nThe 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)\n\nchgrp group file\n\nThe 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.\n\nchmod mode file\n\nThe chmod command modifies the file mode bits of the specified file. The mode operand is an octal integer mode number.\n\nchown user file\n\nThe 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.\n\nln source_file target_file\n\nThe ln and symlink commands create a symbolic link at the target_file location pointing to the source_file location.\n\nmkdir directory_name\n\nThe mkdir command creates the directory named by the directory_name operand.\n\nmtime date file\n\nThe 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)\n\npwd\n\nThe pwd command returns the absolute path name of the current working directory.\n\nrename source target\n\nThe rename command renames the file or directory named by the source operand to the destination path named by the target operand.\n\nrm file\n\nThe rm command removes the file specified by the file operand.\n\nrmdir directory\n\nThe rmdir command removes the directory entry specified by the directory operand, provided it is empty.\n\nsymlink source_file target_file\n\nSee ln.\n\n--quote can be used several times in a command line\n\nExample: curl --quote \"DELE file\" ftp://example.com/foo", "metadata": [ { "name": "x-summary", "value": "Send command(s) to server before transfer" }, { "name": "x-protocols", "value": [ "FTP", "SFTP" ] }, { "name": "x-see-also", "value": [ "--request" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "ftp", "sftp" ] } ] }, { "name": "--random-file", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "misc", "description": "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.\n\nSpecify the path name to file containing random data. The data may be used to seed the random engine for SSL connections.\n\nIf --random-file is provided several times, the last set value is used.\n\nExample: curl --random-file rubbish https://example.com", "metadata": [ { "name": "x-summary", "value": "File for reading random data from" }, { "name": "x-see-also", "value": [ "--egd-file" ] } ] }, { "name": "--range", "aliases": [ "-r" ], "arguments": [ { "name": "range", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "file", "description": "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.\n\n0-499\n\nspecifies the first 500 bytes\n\n500-999\n\nspecifies the second 500 bytes\n\n-500\n\nspecifies the last 500 bytes\n\n9500-\n\nspecifies the bytes from offset 9500 and forward\n\n0-0,-1\n\nspecifies the first and last byte only(*)(HTTP)\n\n100-199,500-599\n\nspecifies two separate 100-byte ranges(*) (HTTP)\n\n.RE .IP\n\n(*) = NOTE that these make the server reply with a multipart response, which is returned as-is by curl! Parsing or otherwise transforming this response is the responsibility of the caller.\n\nOnly 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.\n\nMany 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.\n\nFTP 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.\n\nIf --range is provided several times, the last set value is used.\n\nExample: curl --range 22-44 https://example.com", "metadata": [ { "name": "x-summary", "value": "Retrieve only the bytes within RANGE" }, { "name": "x-protocols", "value": [ "HTTP", "FTP", "SFTP", "FILE" ] }, { "name": "x-see-also", "value": [ "--continue-at", "--append" ] }, { "name": "x-categories", "value": [ "file", "ftp", "http", "sftp" ] } ] }, { "name": "--rate", "arguments": [ { "name": "max request rate", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\nIf 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.\n\nThe 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.\n\nIf curl is told to allow 10 requests per minute, it does not start the next request until 6 seconds have elapsed since the previous transfer was started.\n\nThis function uses millisecond resolution. If the allowed frequency is set more than 1000 per second, it instead runs unrestricted.\n\nWhen retrying transfers, enabled with --retry, the separate retry delay logic is used and not this setting.\n\nThis option is global and does not need to be specified for each use of --next.\n\nIf --rate is provided several times, the last set value is used.\n\nExamples: curl --rate 2/s https://example.com ... curl --rate 3/h https://example.com ... curl --rate 14/m https://example.com ...", "metadata": [ { "name": "x-summary", "value": "Request rate for serial transfers" }, { "name": "x-see-also", "value": [ "--limit-rate", "--retry-delay" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-global", "value": true } ] }, { "name": "--raw", "group": "http", "description": "When used, it disables all internal HTTP decoding of content or transfer encodings and instead makes them passed on unaltered, raw.\n\nProviding --raw multiple times has no extra effect. Disable it again with --no-raw.\n\nExample: curl --raw https://example.com", "metadata": [ { "name": "x-summary", "value": "Do HTTP raw; no transfer decoding" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--tr-encoding" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--referer", "aliases": [ "-e" ], "arguments": [ { "name": "URL", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Set the referrer URL in the HTTP request. This can also be set 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.\n\nIf --referer is provided several times, the last set value is used.\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Referrer URL" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--user-agent", "--header" ] } ] }, { "name": "--remote-header-name", "aliases": [ "-J" ], "group": "output", "description": "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.\n\nThe file is saved in the current directory, or in the directory specified with --output-dir.\n\nIf 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.\n\nThere is no attempt to decode %-sequences (yet) in the provided filename, so this option may provide you with rather unexpected filenames.\n\nThis feature uses the name from the \"filename\" field, it does not yet support the \"filename*\" field (filenames with explicit character sets).\n\nWARNING: 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.\n\nProviding --remote-header-name multiple times has no extra effect. Disable it again with --no-remote-header-name.\n\nExample: curl -OJ https://example.com/file", "metadata": [ { "name": "x-summary", "value": "Use the header-provided filename" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--remote-name" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--remote-name", "aliases": [ "-O" ], "group": "output", "description": "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.)\n\nThe 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.\n\nThe 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.\n\nThere 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.\n\nYou may use this option as many times as the number of URLs you have.\n\n--remote-name can be used several times in a command line\n\nExample: curl -O https://example.com/filename", "metadata": [ { "name": "x-summary", "value": "Write output to file named as remote file" }, { "name": "x-see-also", "value": [ "--remote-name-all", "--output-dir", "--remote-header-name" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--remote-name-all", "group": "output", "description": "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.\n\nProviding --remote-name-all multiple times has no extra effect. Disable it again with --no-remote-name-all.\n\nExample: curl --remote-name-all ftp://example.com/file1 ftp://example.com/file2", "metadata": [ { "name": "x-summary", "value": "Use the remote filename for all URLs" }, { "name": "x-see-also", "value": [ "--remote-name" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--remote-time", "aliases": [ "-R" ], "group": "output", "description": "Makes 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.\n\nProviding --remote-time multiple times has no extra effect. Disable it again with --no-remote-time.\n\nExample: curl --remote-time -o foo https://example.com", "metadata": [ { "name": "x-summary", "value": "Set remote file's time on local output" }, { "name": "x-see-also", "value": [ "--remote-name", "--time-cond" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--remove-on-error", "group": "curl", "description": "Remove 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.\n\nIf the output is not a regular file, this option has no effect.\n\nProviding --remove-on-error multiple times has no extra effect. Disable it again with --no-remove-on-error.\n\nExample: curl --remove-on-error -o output https://example.com", "metadata": [ { "name": "x-summary", "value": "Remove output file on errors" }, { "name": "x-see-also", "value": [ "--fail" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--request", "aliases": [ "-X" ], "arguments": [ { "name": "method", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Change the method to use when starting the transfer.\n\ncurl passes on the verbatim string you give it its the request without any filter or other safe guards. That includes white space and control characters.\n\nHTTP\n\nSpecifies 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.\n\nNormally you do not need this option. All sorts of GET, HEAD, POST and PUT requests are rather invoked by using dedicated command line options.\n\nThis 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.\n\nThe method string you set with --request is used for all requests, which if you for example use --location may cause unintended side-effects when curl does not change request method according to the HTTP 30x response codes - and similar.\n\nFTP\n\nSpecifies a custom FTP command to use instead of LIST when doing file lists with FTP.\n\nPOP3\n\nSpecifies a custom POP3 command to use instead of LIST or RETR.\n\nIMAP\n\nSpecifies a custom IMAP command to use instead of LIST.\n\nSMTP\n\nSpecifies a custom SMTP command to use instead of HELP or VRFY.\n\nIf --request is provided several times, the last set value is used.\n\nExamples: curl -X \"DELETE\" https://example.com curl -X NLST ftp://example.com/", "metadata": [ { "name": "x-summary", "value": "Specify request method to use" }, { "name": "x-see-also", "value": [ "--request-target" ] } ] }, { "name": "--request-target", "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "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 *\".\n\ncurl passes on the verbatim string you give it its the request without any filter or other safe guards. That includes white space and control characters.\n\nIf --request-target is provided several times, the last set value is used.\n\nExample: curl --request-target \"*\" -X OPTIONS https://example.com", "metadata": [ { "name": "x-summary", "value": "Specify the target for this request" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--request" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--resolve", "arguments": [ { "name": "[+]host:port:addr[,addr]...", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Provide a custom address for a specific host and port pair. Using this, you can make the curl requests(s) use a specified address and prevent the otherwise normally resolved address to be used. Consider it a sort of /etc/hosts alternative provided on the command line. The port number should be the number used for the specific protocol the host is used for. It means you need several entries if you want to provide address for the same host but different ports.\n\nBy specifying \"*\" as host you can tell curl to resolve any host and specific port pair to the specified address. Wildcard is resolved last so any --resolve with a specific host and port is used first.\n\nThe provided address set by this option is used even if --ipv4 or --ipv6 is set to make curl use another IP version.\n\nBy prefixing the host with a '+' you can make the entry time out after curl's default timeout (1 minute). Note that this only makes sense for long running parallel transfers with a lot of files. In such cases, if this option is used curl tries to resolve the host as it normally would once the timeout has expired.\n\nSupport for providing the IP address within [brackets] was added in 7.57.0.\n\nSupport for providing multiple IP addresses per entry was added in 7.59.0.\n\nSupport for resolving with wildcard was added in 7.64.0.\n\nSupport for the '+' prefix was added in 7.75.0.\n\n--resolve can be used several times in a command line\n\nExample: curl --resolve example.com:443:127.0.0.1 https://example.com", "metadata": [ { "name": "x-summary", "value": "Resolve host+port to address" }, { "name": "x-see-also", "value": [ "--connect-to", "--alt-svc" ] }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "connection", "dns" ] } ] }, { "name": "--retry", "arguments": [ { "name": "num", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "If a transient error is returned when curl tries to perform a transfer, it retries this number of times before giving up. Setting the number to 0 makes curl do no retries (which is the default). Transient error means either: a timeout, an FTP 4xx response code or an HTTP 408, 429, 500, 502, 503 or 504 response code.\n\nWhen 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 remains delay between the rest of the retries. By using --retry-delay you disable this exponential backoff algorithm. See also --retry-max-time to limit the total time allowed for retries.\n\ncurl complies with the Retry-After: response header if one was present to know when to issue the next retry (added in 7.66.0).\n\nIf --retry is provided several times, the last set value is used.\n\nExample: curl --retry 7 https://example.com", "metadata": [ { "name": "x-summary", "value": "Retry request if transient problems occur" }, { "name": "x-see-also", "value": [ "--retry-max-time" ] } ] }, { "name": "--retry-all-errors", "group": "curl", "description": "Retry on any error. This option is used together with --retry.\n\nThis option is the \"sledgehammer\" of retrying. Do not use this option by default (for example 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.\n\nWARNING: 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.\n\nBy default curl does not return 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 then 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) then combine with --fail.\n\nProviding --retry-all-errors multiple times has no extra effect. Disable it again with --no-retry-all-errors.\n\nExample: curl --retry 5 --retry-all-errors https://example.com", "metadata": [ { "name": "x-summary", "value": "Retry all errors (with --retry)" }, { "name": "x-see-also", "value": [ "--retry" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--retry-connrefused", "group": "curl", "description": "In addition to the other conditions, consider ECONNREFUSED as a transient error too for --retry. This option is used together with --retry.\n\nProviding --retry-connrefused multiple times has no extra effect. Disable it again with --no-retry-connrefused.\n\nExample: curl --retry-connrefused --retry 7 https://example.com", "metadata": [ { "name": "x-summary", "value": "Retry on connection refused (with --retry)" }, { "name": "x-see-also", "value": [ "--retry", "--retry-all-errors" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--retry-delay", "arguments": [ { "name": "seconds", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "Make 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). This option is only interesting if --retry is also used. Setting this delay to zero makes curl use the default backoff time.\n\nIf --retry-delay is provided several times, the last set value is used.\n\nExample: curl --retry-delay 5 --retry 7 https://example.com", "metadata": [ { "name": "x-summary", "value": "Wait time between retries" }, { "name": "x-see-also", "value": [ "--retry" ] } ] }, { "name": "--retry-max-time", "arguments": [ { "name": "seconds", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "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.\n\nIf --retry-max-time is provided several times, the last set value is used.\n\nExample: curl --retry-max-time 30 --retry 10 https://example.com", "metadata": [ { "name": "x-summary", "value": "Retry only within this period" }, { "name": "x-see-also", "value": [ "--retry" ] } ] }, { "name": "--sasl-authzid", "arguments": [ { "name": "identity", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Use this authorization identity (authzid), during SASL PLAIN authentication, in addition to the authentication identity (authcid) as specified by --user.\n\nIf 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.\n\nIf --sasl-authzid is provided several times, the last set value is used.\n\nExample: curl --sasl-authzid zid imap://example.com/", "metadata": [ { "name": "x-summary", "value": "Identity for SASL PLAIN authentication" }, { "name": "x-see-also", "value": [ "--login-options" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--sasl-ir", "group": "auth", "description": "Enable initial response in SASL authentication.\n\nProviding --sasl-ir multiple times has no extra effect. Disable it again with --no-sasl-ir.\n\nExample: curl --sasl-ir imap://example.com/", "metadata": [ { "name": "x-summary", "value": "Initial response in SASL authentication" }, { "name": "x-see-also", "value": [ "--sasl-authzid" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--service-name", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "misc", "description": "Set the service name for SPNEGO.\n\nIf --service-name is provided several times, the last set value is used.\n\nExample: curl --service-name sockd/server https://example.com", "metadata": [ { "name": "x-summary", "value": "SPNEGO service name" }, { "name": "x-see-also", "value": [ "--negotiate", "--proxy-service-name" ] } ] }, { "name": "--show-error", "aliases": [ "-S" ], "group": "curl", "description": "When used with --silent, it makes curl show an error message if it fails.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --show-error multiple times has no extra effect. Disable it again with --no-show-error.\n\nExample: curl --show-error --silent https://example.com", "metadata": [ { "name": "x-summary", "value": "Show error even when -s is used" }, { "name": "x-see-also", "value": [ "--no-progress-meter" ] }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--silent", "aliases": [ "-s" ], "group": "verbose", "description": "Silent or quiet mode. Do not show progress meter or error messages. Makes Curl mute. It still outputs the data you ask for, potentially even to the terminal/stdout unless you redirect it.\n\nUse --show-error in addition to this option to disable progress meter but still show error messages.\n\nProviding --silent multiple times has no extra effect. Disable it again with --no-silent.\n\nExample: curl -s https://example.com", "metadata": [ { "name": "x-summary", "value": "Silent mode" }, { "name": "x-see-also", "value": [ "--verbose", "--stderr", "--no-progress-meter" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--socks4", "arguments": [ { "name": "host[:port]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Use the specified SOCKS4 proxy. If the port number is not specified, it is assumed at port 1080. Using this socket type make curl resolve the hostname and passing the address on to the proxy.\n\nTo specify proxy on a unix domain socket, use localhost for host, e.g. \"socks4://localhost/path/to/socket.sock\"\n\nThis option overrides any previous use of --proxy, as they are mutually exclusive.\n\nThis option is superfluous since you can specify a socks4 proxy with --proxy using a socks4:// protocol prefix.\n\n--preproxy can be used to specify a SOCKS proxy at the same time proxy is used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.\n\nIf --socks4 is provided several times, the last set value is used.\n\nExample: curl --socks4 hostname:4096 https://example.com", "metadata": [ { "name": "x-summary", "value": "SOCKS4 proxy on given host + port" }, { "name": "x-see-also", "value": [ "--socks4a", "--socks5", "--socks5-hostname" ] } ] }, { "name": "--socks4a", "arguments": [ { "name": "host[:port]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "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.\n\nTo specify proxy on a unix domain socket, use localhost for host, e.g. \"socks4a://localhost/path/to/socket.sock\"\n\nThis option overrides any previous use of --proxy, as they are mutually exclusive.\n\nThis option is superfluous since you can specify a socks4a proxy with --proxy using a socks4a:// protocol prefix.\n\n--preproxy can be used to specify a SOCKS proxy at the same time --proxy is used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.\n\nIf --socks4a is provided several times, the last set value is used.\n\nExample: curl --socks4a hostname:4096 https://example.com", "metadata": [ { "name": "x-summary", "value": "SOCKS4a proxy on given host + port" }, { "name": "x-see-also", "value": [ "--socks4", "--socks5", "--socks5-hostname" ] } ] }, { "name": "--socks5", "arguments": [ { "name": "host[:port]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Use the specified SOCKS5 proxy - but resolve the hostname locally. If the port number is not specified, it is assumed at port 1080.\n\nTo specify proxy on a unix domain socket, use localhost for host, e.g. \"socks5://localhost/path/to/socket.sock\"\n\nThis option overrides any previous use of --proxy, as they are mutually exclusive.\n\nThis option is superfluous since you can specify a socks5 proxy with --proxy using a socks5:// protocol prefix.\n\n--preproxy can be used to specify a SOCKS proxy at the same time --proxy is used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.\n\nThis option (as well as --socks4) does not work with IPV6, FTPS or LDAP.\n\nIf --socks5 is provided several times, the last set value is used.\n\nExample: curl --socks5 proxy.example:7000 https://example.com", "metadata": [ { "name": "x-summary", "value": "SOCKS5 proxy on given host + port" }, { "name": "x-see-also", "value": [ "--socks5-hostname", "--socks4a" ] } ] }, { "name": "--socks5-basic", "group": "auth", "description": "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.\n\nProviding --socks5-basic multiple times has no extra effect.\n\nExample: curl --socks5-basic --socks5 hostname:4096 https://example.com", "metadata": [ { "name": "x-summary", "value": "Username/password auth for SOCKS5 proxies" }, { "name": "x-see-also", "value": [ "--socks5" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--socks5-gssapi", "group": "auth", "description": "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.\n\nProviding --socks5-gssapi multiple times has no extra effect. Disable it again with --no-socks5-gssapi.\n\nExample: curl --socks5-gssapi --socks5 hostname:4096 https://example.com", "metadata": [ { "name": "x-summary", "value": "Enable GSS-API auth for SOCKS5 proxies" }, { "name": "x-see-also", "value": [ "--socks5" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-categories", "value": [ "auth", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--socks5-gssapi-nec", "group": "auth", "description": "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.\n\nProviding --socks5-gssapi-nec multiple times has no extra effect. Disable it again with --no-socks5-gssapi-nec.\n\nExample: curl --socks5-gssapi-nec --socks5 hostname:4096 https://example.com", "metadata": [ { "name": "x-summary", "value": "Compatibility with NEC SOCKS5 server" }, { "name": "x-see-also", "value": [ "--socks5" ] }, { "name": "x-categories", "value": [ "auth", "proxy" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--socks5-gssapi-service", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Set the service name for a socks server. Default is rcmd/server-fqdn.\n\nIf --socks5-gssapi-service is provided several times, the last set value is used.\n\nExample: curl --socks5-gssapi-service sockd --socks5 hostname:4096 https://example.com", "metadata": [ { "name": "x-summary", "value": "SOCKS5 proxy service name for GSS-API" }, { "name": "x-see-also", "value": [ "--socks5" ] }, { "name": "x-categories", "value": [ "auth", "proxy" ] } ] }, { "name": "--socks5-hostname", "arguments": [ { "name": "host[:port]", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "proxy", "description": "Use the specified SOCKS5 proxy (and let the proxy resolve the hostname). If the port number is not specified, it is assumed at port 1080.\n\nTo specify proxy on a unix domain socket, use localhost for host, e.g. \"socks5h://localhost/path/to/socket.sock\"\n\nThis option overrides any previous use of --proxy, as they are mutually exclusive.\n\nThis option is superfluous since you can specify a socks5 hostname proxy with --proxy using a socks5h:// protocol prefix.\n\n--preproxy can be used to specify a SOCKS proxy at the same time --proxy is used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.\n\nIf --socks5-hostname is provided several times, the last set value is used.\n\nExample: curl --socks5-hostname proxy.example:7000 https://example.com", "metadata": [ { "name": "x-summary", "value": "SOCKS5 proxy, pass hostname to proxy" }, { "name": "x-see-also", "value": [ "--socks5", "--socks4a" ] } ] }, { "name": "--speed-limit", "aliases": [ "-Y" ], "arguments": [ { "name": "speed", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\nIf --speed-limit is provided several times, the last set value is used.\n\nExample: curl --speed-limit 300 --speed-time 10 https://example.com", "metadata": [ { "name": "x-summary", "value": "Stop transfers slower than this" }, { "name": "x-see-also", "value": [ "--speed-time", "--limit-rate", "--max-time" ] } ] }, { "name": "--speed-time", "aliases": [ "-y" ], "arguments": [ { "name": "seconds", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "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.\n\nThis 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.\n\nIf --speed-time is provided several times, the last set value is used.\n\nExample: curl --speed-limit 300 --speed-time 10 https://example.com", "metadata": [ { "name": "x-summary", "value": "Trigger 'speed-limit' abort after this time" }, { "name": "x-see-also", "value": [ "--speed-limit", "--limit-rate" ] } ] }, { "name": "--ssl", "group": "tls", "description": "Warning: this is considered an insecure option. Consider using --ssl-reqd instead to be sure curl upgrades to a secure connection.\n\nTry to use SSL/TLS for the connection. 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.\n\nThis 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.\n\nPlease note that a server may close the connection if the negotiation does not succeed.\n\nThis option was formerly known as --ftp-ssl. That option name can still be used but might be removed in a future version.\n\nProviding --ssl multiple times has no extra effect. Disable it again with --no-ssl.\n\nExample: curl --ssl pop3://example.com/", "metadata": [ { "name": "x-summary", "value": "Try enabling TLS" }, { "name": "x-protocols", "value": [ "FTP", "IMAP", "POP3", "SMTP", "LDAP" ] }, { "name": "x-see-also", "value": [ "--ssl-reqd", "--insecure", "--ciphers" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ssl-allow-beast", "group": "tls", "description": "Do not work around a security flaw in the SSL3 and TLS1.0 protocols known as BEAST. If this option is not used, the SSL layer may use workarounds known to cause interoperability problems with some older SSL implementations.\n\nWARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.\n\nProviding --ssl-allow-beast multiple times has no extra effect. Disable it again with --no-ssl-allow-beast.\n\nExample: curl --ssl-allow-beast https://example.com", "metadata": [ { "name": "x-summary", "value": "Allow security flaw to improve interop" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--proxy-ssl-allow-beast", "--insecure" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ssl-auto-client-cert", "group": "tls", "description": "(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.\n\nProviding --ssl-auto-client-cert multiple times has no extra effect. Disable it again with --no-ssl-auto-client-cert.\n\nExample: curl --ssl-auto-client-cert https://example.com", "metadata": [ { "name": "x-summary", "value": "Use auto client certificate (Schannel)" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--proxy-ssl-auto-client-cert" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--ssl-no-revoke", "group": "tls", "description": "(Schannel) Disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.\n\nProviding --ssl-no-revoke multiple times has no extra effect. Disable it again with --no-ssl-no-revoke.\n\nExample: curl --ssl-no-revoke https://example.com", "metadata": [ { "name": "x-summary", "value": "Disable cert revocation checks (Schannel)" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--crlfile" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ssl-reqd", "group": "tls", "description": "Require SSL/TLS for the connection. Terminates the connection if the transfer cannot be upgraded to use SSL/TLS.\n\nThis 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.\n\nThis 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.\n\nThis option was formerly known as --ftp-ssl-reqd.\n\nProviding --ssl-reqd multiple times has no extra effect. Disable it again with --no-ssl-reqd.\n\nExample: curl --ssl-reqd ftp://example.com", "metadata": [ { "name": "x-summary", "value": "Require SSL/TLS" }, { "name": "x-protocols", "value": [ "FTP", "IMAP", "POP3", "SMTP", "LDAP" ] }, { "name": "x-see-also", "value": [ "--ssl", "--insecure" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--ssl-revoke-best-effort", "group": "tls", "description": "(Schannel) Ignore certificate revocation checks when they failed due to missing/offline distribution points for the revocation check lists.\n\nProviding --ssl-revoke-best-effort multiple times has no extra effect. Disable it again with --no-ssl-revoke-best-effort.\n\nExample: curl --ssl-revoke-best-effort https://example.com", "metadata": [ { "name": "x-summary", "value": "Ignore missing cert CRL dist points" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--crlfile", "--insecure" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--sslv2", "aliases": [ "-2" ], "group": "tls", "description": "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).\n\nProviding --sslv2 multiple times has no extra effect.\n\nExample: curl --sslv2 https://example.com", "metadata": [ { "name": "x-summary", "value": "SSLv2" }, { "name": "x-protocols", "value": [ "SSL" ] }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--sslv2", "--sslv3", "--tlsv1", "--tlsv1", "--tlsv1" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--sslv3", "aliases": [ "-3" ], "group": "tls", "description": "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).\n\nProviding --sslv3 multiple times has no extra effect.\n\nExample: curl --sslv3 https://example.com", "metadata": [ { "name": "x-summary", "value": "SSLv3" }, { "name": "x-protocols", "value": [ "SSL" ] }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--sslv3", "--sslv2", "--tlsv1", "--tlsv1", "--tlsv1" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--stderr", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "verbose", "description": "Redirect all writes to stderr to the specified file instead. If the filename is a plain '-', it is instead written to stdout.\n\nThis option is global and does not need to be specified for each use of --next.\n\nIf --stderr is provided several times, the last set value is used.\n\nExample: curl --stderr output.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Where to redirect stderr" }, { "name": "x-see-also", "value": [ "--verbose", "--silent" ] }, { "name": "x-global", "value": true } ] }, { "name": "--styled-output", "group": "verbose", "description": "Enable automatic use of bold font styles when writing HTTP headers to the terminal. Use --no-styled-output to switch them off.\n\nStyled output requires a terminal that supports bold fonts. This feature is not present on curl for Windows due to lack of this capability.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --styled-output multiple times has no extra effect. Disable it again with --no-styled-output.\n\nExample: curl --styled-output -I https://example.com", "metadata": [ { "name": "x-summary", "value": "Enable styled output for HTTP headers" }, { "name": "x-see-also", "value": [ "--head", "--verbose" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--suppress-connect-headers", "group": "proxy", "description": "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 --include 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.\n\nProviding --suppress-connect-headers multiple times has no extra effect. Disable it again with --no-suppress-connect-headers.\n\nExample: curl --suppress-connect-headers --include -x proxy https://example.com", "metadata": [ { "name": "x-summary", "value": "Suppress proxy CONNECT response headers" }, { "name": "x-see-also", "value": [ "--dump-header", "--include", "--proxytunnel" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--tcp-fastopen", "group": "connection", "description": "Enable use of TCP Fast Open (RFC 7413). TCP Fast Open is a TCP extension that allows data to get sent earlier over the connection (before the final handshake ACK) if the client and server have been connected previously.\n\nProviding --tcp-fastopen multiple times has no extra effect. Disable it again with --no-tcp-fastopen.\n\nExample: curl --tcp-fastopen https://example.com", "metadata": [ { "name": "x-summary", "value": "Use TCP Fast Open" }, { "name": "x-see-also", "value": [ "--false-start" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--tcp-nodelay", "group": "connection", "description": "Turn on the TCP_NODELAY option. See the curl_easy_setopt(3) man page for details about this option.\n\ncurl sets this option by default and you need to explicitly switch it off if you do not want it on (added in 7.50.2).\n\nProviding --tcp-nodelay multiple times has no extra effect. Disable it again with --no-tcp-nodelay.\n\nExample: curl --tcp-nodelay https://example.com", "metadata": [ { "name": "x-summary", "value": "Set TCP_NODELAY" }, { "name": "x-see-also", "value": [ "--no-buffer" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--telnet-option", "aliases": [ "-t" ], "arguments": [ { "name": "opt=val", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "telnet", "description": "Pass options to the telnet protocol. Supported options are:\n\n`TTYPE=`\n\nSets the terminal type.\n\n`XDISPLOC=`\n\nSets the X display location.\n\n`NEW_ENV=`\n\nSets an environment variable.\n\n--telnet-option can be used several times in a command line\n\nExample: curl -t TTYPE=vt100 telnet://example.com/", "metadata": [ { "name": "x-summary", "value": "Set telnet option" }, { "name": "x-see-also", "value": [ "--config" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--tftp-blksize", "arguments": [ { "name": "value", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tftp", "description": "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.\n\nIf --tftp-blksize is provided several times, the last set value is used.\n\nExample: curl --tftp-blksize 1024 tftp://example.com/file", "metadata": [ { "name": "x-summary", "value": "Set TFTP BLKSIZE option" }, { "name": "x-protocols", "value": [ "TFTP" ] }, { "name": "x-see-also", "value": [ "--tftp-no-options" ] } ] }, { "name": "--tftp-no-options", "group": "tftp", "description": "Do not to send TFTP options requests. This improves interop with some legacy servers that do not acknowledge or properly implement TFTP options. When this option is used --tftp-blksize is ignored.\n\nProviding --tftp-no-options multiple times has no extra effect. Disable it again with --no-tftp-no-options.\n\nExample: curl --tftp-no-options tftp://192.168.0.1/", "metadata": [ { "name": "x-summary", "value": "Do not send any TFTP options" }, { "name": "x-protocols", "value": [ "TFTP" ] }, { "name": "x-see-also", "value": [ "--tftp-blksize" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--time-cond", "aliases": [ "-z" ], "arguments": [ { "name": "time", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "ftp", "description": "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 or 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 pages for date expression details.\n\nStart the date expression with a dash (-) to make it request for a document that is older than the given date/time, default is a document that is newer than the specified date/time.\n\nIf provided a non-existing file, curl outputs a warning about that fact and proceeds to do the transfer without a time condition.\n\nIf --time-cond is provided several times, the last set value is used.\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Transfer based on a time condition" }, { "name": "x-protocols", "value": [ "HTTP", "FTP" ] }, { "name": "x-see-also", "value": [ "--etag-compare", "--remote-time" ] }, { "name": "x-categories", "value": [ "ftp", "http" ] } ] }, { "name": "--tls-max", "arguments": [ { "name": "VERSION", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "VERSION defines maximum supported TLS version. The minimum acceptable version is set by tlsv1.0, tlsv1.1, tlsv1.2 or tlsv1.3.\n\nIf the connection is done without TLS, this option has no effect. This includes QUIC-using (HTTP/3) transfers.\n\ndefault\n\nUse up to recommended TLS version.\n\n1.0\n\nUse up to TLSv1.0.\n\n1.1\n\nUse up to TLSv1.1.\n\n1.2\n\nUse up to TLSv1.2.\n\n1.3\n\nUse up to TLSv1.3.\n\nIf --tls-max is provided several times, the last set value is used.\n\nExamples: curl --tls-max 1.2 https://example.com curl --tls-max 1.3 --tlsv1.2 https://example.com", "metadata": [ { "name": "x-summary", "value": "Maximum allowed TLS version" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsv1", "--tlsv1", "--tlsv1", "--tlsv1", "--tls-max" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--tls13-ciphers", "arguments": [ { "name": "list", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "tls", "description": "Specifies 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:\n\nhttps://curl.se/docs/ssl-ciphers.html\n\nThis option is currently used only when curl is built to use OpenSSL 1.1.1 or later, or Schannel. If you are using a different SSL backend you can try setting TLS 1.3 cipher suites by using the --ciphers option.\n\nIf --tls13-ciphers is provided several times, the last set value is used.\n\nExample: curl --tls13-ciphers TLS_AES_128_GCM_SHA256 https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS 1.3 cipher suites to use" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--ciphers", "--curves", "--proxy-tls13-ciphers" ] }, { "name": "x-added-in", "value": "7" } ] }, { "name": "--tlsauthtype", "arguments": [ { "name": "type", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "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.\n\nIf --tlsauthtype is provided several times, the last set value is used.\n\nExample: curl --tlsauthtype SRP https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS authentication type" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsuser" ] }, { "name": "x-categories", "value": [ "auth", "tls" ] } ] }, { "name": "--tlspassword", "arguments": [ { "name": "string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Set password for use with the TLS authentication method specified with --tlsauthtype. Requires that --tlsuser also be set.\n\nThis option does not work with TLS 1.3.\n\nIf --tlspassword is provided several times, the last set value is used.\n\nExample: curl --tlspassword pwd --tlsuser user https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS password" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsuser" ] }, { "name": "x-categories", "value": [ "auth", "tls" ] } ] }, { "name": "--tlsuser", "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Set username for use with the TLS authentication method specified with --tlsauthtype. Requires that --tlspassword also is set.\n\nThis option does not work with TLS 1.3.\n\nIf --tlsuser is provided several times, the last set value is used.\n\nExample: curl --tlspassword pwd --tlsuser user https://example.com", "metadata": [ { "name": "x-summary", "value": "TLS username" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlspassword" ] }, { "name": "x-categories", "value": [ "auth", "tls" ] } ] }, { "name": "--tlsv1", "aliases": [ "-1" ], "group": "tls", "description": "Use at least TLS version 1.x when negotiating with a remote TLS server. That means TLS version 1.0 or higher\n\nProviding --tlsv1 multiple times has no extra effect.\n\nExample: curl --tlsv1 https://example.com", "metadata": [ { "name": "x-summary", "value": "TLSv1.0 or greater" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--http1", "--http2", "--tlsv1", "--tlsv1", "--tlsv1", "--tlsv1" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--tlsv1.0", "group": "tls", "description": "Forces curl to use TLS version 1.0 or later when connecting to a remote TLS server.\n\nIn 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.\n\nProviding --tlsv1.0 multiple times has no extra effect.\n\nExample: curl --tlsv1.0 https://example.com", "metadata": [ { "name": "x-summary", "value": "TLSv1.0 or greater" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsv1" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--tlsv1.1", "group": "tls", "description": "Forces curl to use TLS version 1.1 or later when connecting to a remote TLS server.\n\nIn 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.\n\nProviding --tlsv1.1 multiple times has no extra effect.\n\nExample: curl --tlsv1.1 https://example.com", "metadata": [ { "name": "x-summary", "value": "TLSv1.1 or greater" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsv1", "--tls-max" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--tlsv1.2", "group": "tls", "description": "Forces curl to use TLS version 1.2 or later when connecting to a remote TLS server.\n\nIn old versions of curl this option was documented to allow _only_ TLS 1.2. That behavior was inconsistent depending on the TLS library. Use --tls-max if you want to set a maximum TLS version.\n\nProviding --tlsv1.2 multiple times has no extra effect.\n\nExample: curl --tlsv1.2 https://example.com", "metadata": [ { "name": "x-summary", "value": "TLSv1.2 or greater" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsv1", "--tls-max" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--tlsv1.3", "group": "tls", "description": "Forces curl to use TLS version 1.3 or later when connecting to a remote TLS server.\n\nIf the connection is done without TLS, this option has no effect. This includes QUIC-using (HTTP/3) transfers.\n\nNote that TLS 1.3 is not supported by all TLS backends.\n\nProviding --tlsv1.3 multiple times has no extra effect.\n\nExample: curl --tlsv1.3 https://example.com", "metadata": [ { "name": "x-summary", "value": "TLSv1.3 or greater" }, { "name": "x-protocols", "value": [ "TLS" ] }, { "name": "x-see-also", "value": [ "--tlsv1", "--tls-max" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-negatable", "value": true } ] }, { "name": "--tr-encoding", "group": "http", "description": "Request a compressed Transfer-Encoding response using one of the algorithms curl supports, and uncompress the data while receiving it.\n\nProviding --tr-encoding multiple times has no extra effect. Disable it again with --no-tr-encoding.\n\nExample: curl --tr-encoding https://example.com", "metadata": [ { "name": "x-summary", "value": "Request compressed transfer encoding" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--compressed" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--trace", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "verbose", "description": "Save 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.\n\nNote that 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.\n\nThis option is global and does not need to be specified for each use of --next.\n\nIf --trace is provided several times, the last set value is used.\n\nExample: curl --trace log.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Write a debug trace to FILE" }, { "name": "x-see-also", "value": [ "--trace-ascii", "--trace-config", "--trace-ids", "--trace-time", "--verbose", "--trace-ascii" ] }, { "name": "x-global", "value": true } ] }, { "name": "--trace-ascii", "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "verbose", "description": "Save 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.\n\nThis is similar to --trace, but 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.\n\nNote that 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.\n\nThis option is global and does not need to be specified for each use of --next.\n\nIf --trace-ascii is provided several times, the last set value is used.\n\nExample: curl --trace-ascii log.txt https://example.com", "metadata": [ { "name": "x-summary", "value": "Like --trace, but without hex output" }, { "name": "x-see-also", "value": [ "--verbose", "--trace", "--trace", "--verbose" ] }, { "name": "x-global", "value": true } ] }, { "name": "--trace-config", "arguments": [ { "name": "string", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "verbose", "description": "Set configuration for trace output. 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.\n\nIn addition to trace component names, specify \"ids\" and \"time\" to avoid extra --trace-ids or --trace-time parameters.\n\nSee the curl_global_trace(3) man page for more details.\n\nThis option is global and does not need to be specified for each use of --next.\n\n--trace-config can be used several times in a command line\n\nExample: curl --trace-config ids,http/2 https://example.com", "metadata": [ { "name": "x-summary", "value": "Details to log in trace/verbose output" }, { "name": "x-see-also", "value": [ "--verbose", "--trace" ] }, { "name": "x-added-in", "value": "8" }, { "name": "x-repeatable", "value": true }, { "name": "x-global", "value": true } ] }, { "name": "--trace-ids", "group": "verbose", "description": "Prepends the transfer and connection identifiers to each trace or verbose line that curl displays.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --trace-ids multiple times has no extra effect. Disable it again with --no-trace-ids.\n\nExample: curl --trace-ids --trace-ascii output https://example.com", "metadata": [ { "name": "x-summary", "value": "Transfer + connection ids in verbose output" }, { "name": "x-see-also", "value": [ "--trace", "--verbose" ] }, { "name": "x-added-in", "value": "8" }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--trace-time", "group": "verbose", "description": "Prepends a time stamp to each trace or verbose line that curl displays.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --trace-time multiple times has no extra effect. Disable it again with --no-trace-time.\n\nExample: curl --trace-time --trace-ascii output https://example.com", "metadata": [ { "name": "x-summary", "value": "Add time stamps to trace/verbose output" }, { "name": "x-see-also", "value": [ "--trace", "--verbose" ] }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--unix-socket", "arguments": [ { "name": "path", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "connection", "description": "Connect through this Unix domain socket, instead of using the network.\n\nIf --unix-socket is provided several times, the last set value is used.\n\nExample: curl --unix-socket socket-path https://example.com", "metadata": [ { "name": "x-summary", "value": "Connect through this Unix domain socket" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--abstract-unix-socket" ] } ] }, { "name": "--upload-file", "aliases": [ "-T" ], "arguments": [ { "name": "file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "upload", "description": "Upload the specified local file to the remote URL.\n\nIf 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 or curl thinks that your last directory name is the remote filename to use.\n\nWhen 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.\n\nUse 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.\n\nIf this option is used with an HTTP(S) URL, the PUT method is used.\n\nYou 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.\n\nWhen uploading to an SMTP server: 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.\n\n--upload-file can be used several times in a command line\n\nExamples: curl -T file https://example.com curl -T \"img[1-1000].png\" ftp://ftp.example.com/ curl --upload-file \"{file1,file2}\" https://example.com", "metadata": [ { "name": "x-summary", "value": "Transfer local FILE to destination" }, { "name": "x-see-also", "value": [ "--get", "--head", "--request", "--data" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--url", "arguments": [ { "name": "url", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "Specify a URL to fetch.\n\nIf the given URL is missing a scheme name (such as \"http://\" or \"ftp://\" etc) then curl makes a guess based on the host. If the outermost subdomain name matches DICT, FTP, IMAP, LDAP, POP3 or SMTP then that protocol is used, otherwise HTTP is used. Guessing can be avoided by providing a full URL including the scheme, or disabled by setting a default protocol (added in 7.45.0), see --proto-default for details.\n\nTo control where this URL is written, use the --output or the --remote-name options.\n\nWARNING: On Windows, particular \"file://\" accesses can be converted to network accesses by the operating system. Beware!\n\n--url can be used several times in a command line\n\nExample: curl --url https://example.com", "metadata": [ { "name": "x-summary", "value": "URL to work with" }, { "name": "x-see-also", "value": [ "--next", "--config" ] }, { "name": "x-repeatable", "value": true } ] }, { "name": "--url-query", "arguments": [ { "name": "data", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "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:\n\nIf the argument starts with a '+' (plus), the rest of the string is provided as-is unencoded.\n\nThe query part of a URL is the one following the question mark on the right end.\n\n--url-query can be used several times in a command line\n\nExamples: 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", "metadata": [ { "name": "x-summary", "value": "Add a URL query part" }, { "name": "x-protocols", "value": [ "all" ] }, { "name": "x-see-also", "value": [ "--data-urlencode", "--get" ] }, { "name": "x-added-in", "value": "7" }, { "name": "x-repeatable", "value": true }, { "name": "x-categories", "value": [ "http", "post", "upload" ] } ] }, { "name": "--use-ascii", "aliases": [ "-B" ], "group": "misc", "description": "Enable ASCII transfer mode. For FTP, this can also be enforced by using a URL that ends with \";type=A\". This option causes data sent to stdout to be in text mode for win32 systems.\n\nProviding --use-ascii multiple times has no extra effect. Disable it again with --no-use-ascii.\n\nExample: curl -B ftp://example.com/README", "metadata": [ { "name": "x-summary", "value": "Use ASCII/text transfer" }, { "name": "x-protocols", "value": [ "FTP", "LDAP" ] }, { "name": "x-see-also", "value": [ "--crlf", "--data-ascii" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--user", "aliases": [ "-u" ], "arguments": [ { "name": "user:password", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "auth", "description": "Specify the username and password to use for server authentication. Overrides --netrc and --netrc-optional.\n\nIf you simply specify the username, curl prompts for a password.\n\nThe 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.\n\nOn 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 cleared. Such sensitive data should be retrieved from a file instead or similar and never used in clear text in a command line.\n\nWhen 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.\n\nWhen using NTLM, the username can be specified simply as the username, without the domain, if there is a single domain and forest in your setup for example.\n\nTo 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.\n\nIf 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 :\".\n\nIf --user is provided several times, the last set value is used.\n\nExample: curl -u user:secret https://example.com", "metadata": [ { "name": "x-summary", "value": "Server user and password" }, { "name": "x-see-also", "value": [ "--netrc", "--config" ] } ] }, { "name": "--user-agent", "aliases": [ "-A" ], "arguments": [ { "name": "name", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "http", "description": "Specify the User-Agent string to send to the HTTP server. To encode blanks in the string, surround the string with single quote marks. This header can also be set with the --header or the --proxy-header options.\n\nIf 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 (\" \").\n\nIf --user-agent is provided several times, the last set value is used.\n\nExample: curl -A \"Agent 007\" https://example.com", "metadata": [ { "name": "x-summary", "value": "Send User-Agent to server" }, { "name": "x-protocols", "value": [ "HTTP" ] }, { "name": "x-see-also", "value": [ "--header", "--proxy-header" ] } ] }, { "name": "--variable", "arguments": [ { "name": "[%]name=text/@file", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "curl", "description": "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.\n\nSetting the same variable name again overwrites the old contents with the new.\n\nThe 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}}\".\n\n--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.\n\n--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.\n\nWhen 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.\n\nAvailable functions:\n\ntrim\n\nremoves all leading and trailing white space.\n\njson\n\noutputs the content using JSON string quoting rules.\n\nurl\n\nshows the content URL (percent) encoded.\n\nb64\n\nexpands the variable base64 encoded\n\n--variable can be used several times in a command line\n\nExample: curl --variable name=smith https://example.com", "metadata": [ { "name": "x-summary", "value": "Set variable" }, { "name": "x-see-also", "value": [ "--config" ] }, { "name": "x-added-in", "value": "8" }, { "name": "x-repeatable", "value": true } ] }, { "name": "--verbose", "aliases": [ "-v" ], "group": "verbose", "description": "Makes curl verbose during the operation. Useful for debugging and seeing what's going on under the hood. A line starting with > means header data sent by curl, < means header data received by curl that is hidden in normal cases, and a line starting with * means additional info provided by curl.\n\nIf you only want HTTP headers in the output, --include or --dump-header might be more suitable options.\n\nIf you think this option still does not give you enough details, consider using --trace or --trace-ascii instead.\n\nNote that 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.\n\nThis option is global and does not need to be specified for each use of --next.\n\nProviding --verbose multiple times has no extra effect. Disable it again with --no-verbose.\n\nExample: curl --verbose https://example.com", "metadata": [ { "name": "x-summary", "value": "Make the operation more talkative" }, { "name": "x-see-also", "value": [ "--include", "--silent", "--trace", "--trace-ascii", "--trace", "--trace-ascii" ] }, { "name": "x-global", "value": true }, { "name": "x-negatable", "value": true } ] }, { "name": "--version", "aliases": [ "-V" ], "group": "curl", "description": "Displays information about curl and the libcurl version it uses.\n\nThe first line includes the full version of curl, libcurl and other 3rd party libraries linked with the executable.\n\nThe second line (starts with \"Release-Date:\") shows the release date.\n\nThe third line (starts with \"Protocols:\") shows all protocols that libcurl reports to support.\n\nThe fourth line (starts with \"Features:\") shows specific features libcurl reports to offer. Available features include:\n\n`alt-svc`\n\nSupport for the Alt-Svc: header is provided.\n\n`AsynchDNS`\n\nThis curl uses asynchronous name resolves. Asynchronous name resolves can be done using either the c-ares or the threaded resolver backends.\n\n`brotli`\n\nSupport for automatic brotli compression over HTTP(S).\n\n`CharConv`\n\ncurl was built with support for character set conversions (like EBCDIC)\n\n`Debug`\n\nThis curl uses a libcurl built with Debug. This enables more error-tracking and memory debugging etc. For curl-developers only!\n\n`gsasl`\n\nThe built-in SASL authentication includes extensions to support SCRAM because libcurl was built with libgsasl.\n\n`GSS-API`\n\nGSS-API is supported.\n\n`HSTS`\n\nHSTS support is present.\n\n`HTTP2`\n\nHTTP/2 support has been built-in.\n\n`HTTP3`\n\nHTTP/3 support has been built-in.\n\n`HTTPS-proxy`\n\nThis curl is built to support HTTPS proxy.\n\n`IDN`\n\nThis curl supports IDN - international domain names.\n\n`IPv6`\n\nYou can use IPv6 with this.\n\n`Kerberos`\n\nKerberos V5 authentication is supported.\n\n`Largefile`\n\nThis curl supports transfers of large files, files larger than 2GB.\n\n`libz`\n\nAutomatic decompression (via gzip, deflate) of compressed files over HTTP is supported.\n\n`MultiSSL`\n\nThis curl supports multiple TLS backends.\n\n`NTLM`\n\nNTLM authentication is supported.\n\n`NTLM_WB`\n\nNTLM delegation to winbind helper is supported.\n\n`PSL`\n\nPSL is short for Public Suffix List and means that this curl has been built with knowledge about \"public suffixes\".\n\n`SPNEGO`\n\nSPNEGO authentication is supported.\n\n`SSL`\n\nSSL versions of various protocols are supported, such as HTTPS, FTPS, POP3S and so on.\n\n`SSPI`\n\nSSPI is supported.\n\n`TLS-SRP`\n\nSRP (Secure Remote Password) authentication is supported for TLS.\n\n`TrackMemory`\n\nDebug memory tracking is supported.\n\n`Unicode`\n\nUnicode support on Windows.\n\n`UnixSockets`\n\nUnix sockets support is provided.\n\n`zstd`\n\nAutomatic decompression (via zstd) of compressed files over HTTP is supported.\n\nExample: curl --version", "metadata": [ { "name": "x-summary", "value": "Show version number and quit" }, { "name": "x-see-also", "value": [ "--help", "--manual" ] }, { "name": "x-negatable", "value": true } ] }, { "name": "--write-out", "aliases": [ "-w" ], "arguments": [ { "name": "format", "required": true, "arity": { "minimum": 1, "maximum": 1 } } ], "group": "verbose", "description": "Make curl display information on stdout after a completed transfer. 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 \"@-\".\n\nThe 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 just write them as %%. You can output a newline by using \\n, a carriage return with \\r and a tab space with \\t.\n\nThe output is by default written to standard output, but can be changed with %{stderr} and %output{}.\n\nOutput HTTP headers from the most recent request by using %header{name} where name is the case insensitive name of the header (without the trailing colon). The header contents are exactly as sent over the network, with leading and trailing whitespace trimmed (added in 7.84.0).\n\nSelect 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.\n\nThis output is done independently of if the file transfer was successful or not.\n\nIf the specified action or output specified with this option fails in any way, it does not make curl return a (different) error.\n\nNOTE: 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.\n\nThe variables available are:\n\n`certs`\n\nOutput the certificate chain with details. Supported only by the OpenSSL, GnuTLS, Schannel and Secure Transport backends. (Added in 7.88.0)\n\n`content_type`\n\nThe Content-Type of the requested document, if there was any.\n\n`errormsg`\n\nThe error message. (Added in 7.75.0)\n\n`exitcode`\n\nThe numerical exit code of the transfer. (Added in 7.75.0)\n\n`filename_effective`\n\nThe 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. (Added in 7.26.0)\n\n`ftp_entry_path`\n\nThe initial path curl ended up in when logging on to the remote FTP server.\n\n`header_json`\n\nA 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)\n\nThe 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.\n\n`http_code`\n\nThe numerical response code that was found in the last retrieved HTTP(S) or FTP(s) transfer.\n\n`http_connect`\n\nThe numerical code that was found in the last response (from a proxy) to a curl CONNECT request.\n\n`http_version`\n\nThe http version that was effectively used. (Added in 7.50.0)\n\n`json`\n\nA JSON object with all available keys. (Added in 7.70.0)\n\n`local_ip`\n\nThe IP address of the local end of the most recently done connection - can be either IPv4 or IPv6.\n\n`local_port`\n\nThe local port number of the most recently done connection.\n\n`method`\n\nThe http method used in the most recent HTTP request. (Added in 7.72.0)\n\n`num_certs`\n\nNumber of server certificates received in the TLS handshake. Supported only by the OpenSSL, GnuTLS, Schannel and Secure Transport backends. (Added in 7.88.0)\n\n`num_connects`\n\nNumber of new connects made in the recent transfer.\n\n`num_headers`\n\nThe 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)\n\n`num_redirects`\n\nNumber of redirects that were followed in the request.\n\n`onerror`\n\nThe rest of the output is only shown if the transfer returned a non-zero error. (Added in 7.75.0)\n\n`proxy_ssl_verify_result`\n\nThe result of the HTTPS proxy's SSL peer certificate verification that was requested. 0 means the verification was successful. (Added in 7.52.0)\n\n`proxy_used`\n\nReturns 1 if the previous transfer used a proxy, otherwise 0. Useful to for example determine if a \"NOPROXY\" pattern matched the hostname or not. (Added in 8.7.0)\n\n`redirect_url`\n\nWhen 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.\n\n`referer`\n\nThe Referer: header, if there was any. (Added in 7.76.0)\n\n`remote_ip`\n\nThe remote IP address of the most recently done connection - can be either IPv4 or IPv6.\n\n`remote_port`\n\nThe remote port number of the most recently done connection.\n\n`response_code`\n\nThe numerical response code that was found in the last transfer (formerly known as \"http_code\").\n\n`scheme`\n\nThe URL scheme (sometimes called protocol) that was effectively used. (Added in 7.52.0)\n\n`size_download`\n\nThe total amount of bytes that were downloaded. This is the size of the body/data that was transferred, excluding headers.\n\n`size_header`\n\nThe total amount of bytes of the downloaded headers.\n\n`size_request`\n\nThe total amount of bytes that were sent in the HTTP request.\n\n`size_upload`\n\nThe total amount of bytes that were uploaded. This is the size of the body/data that was transferred, excluding headers.\n\n`speed_download`\n\nThe average download speed that curl measured for the complete download. Bytes per second.\n\n`speed_upload`\n\nThe average upload speed that curl measured for the complete upload. Bytes per second.\n\n`ssl_verify_result`\n\nThe result of the SSL peer certificate verification that was requested. 0 means the verification was successful.\n\n`stderr`\n\nFrom this point on, the --write-out output is written to standard error. (Added in 7.63.0)\n\n`stdout`\n\nFrom 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. (Added in 7.63.0)\n\n`time_appconnect`\n\nThe time, in seconds, it took from the start until the SSL/SSH/etc connect/handshake to the remote host was completed.\n\n`time_connect`\n\nThe time, in seconds, it took from the start until the TCP connect to the remote host (or proxy) was completed.\n\n`time_namelookup`\n\nThe time, in seconds, it took from the start until the name resolving was completed.\n\n`time_pretransfer`\n\nThe time, in seconds, it took from the start until the file transfer was just about to begin. This includes all pre-transfer commands and negotiations that are specific to the particular protocol(s) involved.\n\n`time_redirect`\n\nThe 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.\n\n`time_starttransfer`\n\nThe time, in seconds, it took from the start until the first byte is received. This includes time_pretransfer and also the time the server needed to calculate the result.\n\n`time_total`\n\nThe total time, in seconds, that the full operation lasted.\n\n`url`\n\nThe URL that was fetched. (Added in 7.75.0)\n\n`url.scheme`\n\nThe scheme part of the URL that was fetched. (Added in 8.1.0)\n\n`url.user`\n\nThe user part of the URL that was fetched. (Added in 8.1.0)\n\n`url.password`\n\nThe password part of the URL that was fetched. (Added in 8.1.0)\n\n`url.options`\n\nThe options part of the URL that was fetched. (Added in 8.1.0)\n\n`url.host`\n\nThe host part of the URL that was fetched. (Added in 8.1.0)\n\n`url.port`\n\nThe 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)\n\n`url.path`\n\nThe path part of the URL that was fetched. (Added in 8.1.0)\n\n`url.query`\n\nThe query part of the URL that was fetched. (Added in 8.1.0)\n\n`url.fragment`\n\nThe fragment part of the URL that was fetched. (Added in 8.1.0)\n\n`url.zoneid`\n\nThe zone id part of the URL that was fetched. (Added in 8.1.0)\n\n`urle.scheme`\n\nThe scheme part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.user`\n\nThe user part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.password`\n\nThe password part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.options`\n\nThe options part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.host`\n\nThe host part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.port`\n\nThe 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)\n\n`urle.path`\n\nThe path part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.query`\n\nThe query part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.fragment`\n\nThe fragment part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urle.zoneid`\n\nThe zone id part of the effective (last) URL that was fetched. (Added in 8.1.0)\n\n`urlnum`\n\nThe 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)\n\n`url_effective`\n\nThe URL that was fetched last. This is most meaningful if you have told curl to follow location: headers.\n\nIf --write-out is provided several times, the last set value is used.\n\nExample: curl -w '%{response_code}\\n' https://example.com", "metadata": [ { "name": "x-summary", "value": "Output FORMAT after completion" }, { "name": "x-see-also", "value": [ "--verbose", "--head" ] } ] }, { "name": "--xattr", "group": "misc", "description": "When saving output to a file, tell curl to store file metadata in extended file attributes. Currently, the URL is stored in the \"xdg.origin.url\" attribute and, for HTTP, the content type is stored in the \"mime_type\" attribute. If the file system does not support extended attributes, a warning is issued.\n\nProviding --xattr multiple times has no extra effect. Disable it again with --no-xattr.\n\nExample: curl --xattr -o storage https://example.com", "metadata": [ { "name": "x-summary", "value": "Store metadata in extended file attributes" }, { "name": "x-see-also", "value": [ "--remote-time", "--write-out", "--verbose" ] }, { "name": "x-negatable", "value": true } ] } ], "exitCodes": [ { "code": 0, "description": "Success. The operation completed successfully according to the instructions." }, { "code": 1, "description": "Unsupported protocol. This build of curl has no support for this protocol." }, { "code": 2, "description": "Failed to initialize." }, { "code": 3, "description": "URL malformed. The syntax was not correct." }, { "code": 4, "description": "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." }, { "code": 5, "description": "Could not resolve proxy. The given proxy host could not be resolved." }, { "code": 6, "description": "Could not resolve host. The given remote host could not be resolved." }, { "code": 7, "description": "Failed to connect to host." }, { "code": 8, "description": "Weird server reply. The server sent data curl could not parse." }, { "code": 9, "description": "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." }, { "code": 10, "description": "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." }, { "code": 11, "description": "FTP weird PASS reply. Curl could not parse the reply sent to the PASS request." }, { "code": 12, "description": "During an active FTP session while waiting for the server to connect back to curl, the timeout expired." }, { "code": 13, "description": "FTP weird PASV reply, Curl could not parse the reply sent to the PASV request." }, { "code": 14, "description": "FTP weird 227 format. Curl could not parse the 227-line the server sent." }, { "code": 15, "description": "FTP cannot use host. Could not resolve the host IP we got in the 227-line." }, { "code": 16, "description": "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." }, { "code": 17, "description": "FTP could not set binary. Could not change transfer method to binary." }, { "code": 18, "description": "Partial file. Only a part of the file was transferred." }, { "code": 19, "description": "FTP could not download/access the given file, the RETR (or similar) command failed." }, { "code": 21, "description": "FTP quote error. A quote command returned error from the server." }, { "code": 22, "description": "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." }, { "code": 23, "description": "Write error. Curl could not write data to a local filesystem or similar." }, { "code": 25, "description": "Failed starting the upload. For FTP, the server typically denied the STOR command." }, { "code": 26, "description": "Read error. Various reading problems." }, { "code": 27, "description": "Out of memory. A memory allocation request failed." }, { "code": 28, "description": "Operation timeout. The specified time-out period was reached according to the conditions." }, { "code": 30, "description": "FTP PORT failed. The PORT command failed. Not all FTP servers support the PORT command, try doing a transfer using PASV instead." }, { "code": 31, "description": "FTP could not use REST. The REST command failed. This command is used for resumed FTP transfers." }, { "code": 33, "description": "HTTP range error. The range \"command\" did not work." }, { "code": 34, "description": "HTTP post error. Internal post-request generation error." }, { "code": 35, "description": "SSL connect error. The SSL handshaking failed." }, { "code": 36, "description": "Bad download resume. Could not continue an earlier aborted download." }, { "code": 37, "description": "FILE could not read file. Failed to open the file. Permissions?" }, { "code": 38, "description": "LDAP cannot bind. LDAP bind operation failed." }, { "code": 39, "description": "LDAP search failed." }, { "code": 41, "description": "Function not found. A required LDAP function was not found." }, { "code": 42, "description": "Aborted by callback. An application told curl to abort the operation." }, { "code": 43, "description": "Internal error. A function was called with a bad parameter." }, { "code": 45, "description": "Interface error. A specified outgoing interface could not be used." }, { "code": 47, "description": "Too many redirects. When following redirects, curl hit the maximum amount." }, { "code": 48, "description": "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!" }, { "code": 49, "description": "Malformed telnet option." }, { "code": 52, "description": "The server did not reply anything, which here is considered an error." }, { "code": 53, "description": "SSL crypto engine not found." }, { "code": 54, "description": "Cannot set SSL crypto engine as default." }, { "code": 55, "description": "Failed sending network data." }, { "code": 56, "description": "Failure in receiving network data." }, { "code": 58, "description": "Problem with the local certificate." }, { "code": 59, "description": "Could not use specified SSL cipher." }, { "code": 60, "description": "Peer certificate cannot be authenticated with known CA certificates." }, { "code": 61, "description": "Unrecognized transfer encoding." }, { "code": 63, "description": "Maximum file size exceeded." }, { "code": 64, "description": "Requested FTP SSL level failed." }, { "code": 65, "description": "Sending the data requires a rewind that failed." }, { "code": 66, "description": "Failed to initialize SSL Engine." }, { "code": 67, "description": "The username, password, or similar was not accepted and curl failed to log in." }, { "code": 68, "description": "File not found on TFTP server." }, { "code": 69, "description": "Permission problem on TFTP server." }, { "code": 70, "description": "Out of disk space on TFTP server." }, { "code": 71, "description": "Illegal TFTP operation." }, { "code": 72, "description": "Unknown TFTP transfer ID." }, { "code": 73, "description": "File already exists (TFTP)." }, { "code": 74, "description": "No such user (TFTP)." }, { "code": 77, "description": "Problem reading the SSL CA cert (path? access rights?)." }, { "code": 78, "description": "The resource referenced in the URL does not exist." }, { "code": 79, "description": "An unspecified error occurred during the SSH session." }, { "code": 80, "description": "Failed to shut down the SSL connection." }, { "code": 82, "description": "Could not load CRL file, missing or wrong format." }, { "code": 83, "description": "Issuer check failed." }, { "code": 84, "description": "The FTP PRET command failed." }, { "code": 85, "description": "Mismatch of RTSP CSeq numbers." }, { "code": 86, "description": "Mismatch of RTSP Session Identifiers." }, { "code": 87, "description": "Unable to parse FTP file list." }, { "code": 88, "description": "FTP chunk callback reported error." }, { "code": 89, "description": "No connection available, the session is queued." }, { "code": 90, "description": "SSL public key does not matched pinned public key." }, { "code": 91, "description": "Invalid SSL certificate status." }, { "code": 92, "description": "Stream error in HTTP/2 framing layer." }, { "code": 93, "description": "An API function was called from inside a callback." }, { "code": 94, "description": "An authentication function returned an error." }, { "code": 95, "description": "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." }, { "code": 96, "description": "QUIC connection error. This error may be caused by an SSL library error. QUIC is the protocol used for HTTP/3 transfers." }, { "code": 97, "description": "Proxy handshake error." }, { "code": 98, "description": "A client-side certificate is required to complete the TLS handshake." }, { "code": 99, "description": "Poll or select returned fatal error." }, { "code": 100, "description": "A value or data field grew larger than allowed." } ], "examples": [ "curl https://example.com", "curl -o page.html https://example.com", "curl -L -O https://example.com/file.tar.gz", "curl -d name=value https://example.com/form", "curl -H 'Accept: application/json' -u user:password https://example.com/api" ], "metadata": [ { "name": "x-documentation", "value": "https://curl.se/docs/manpage.html" }, { "name": "x-usage", "value": "curl [options...] " }, { "name": "x-protocols", "value": [ "dict", "file", "ftp", "ftps", "gopher", "gophers", "http", "https", "imap", "imaps", "ipfs", "ipns", "ldap", "ldaps", "mqtt", "pop3", "pop3s", "rtsp", "smb", "smbs", "smtp", "smtps", "telnet", "tftp" ] }, { "name": "x-features", "value": [ "alt-svc", "AsynchDNS", "GSS-API", "HSTS", "HTTP2", "HTTPS-proxy", "IPv6", "Kerberos", "Largefile", "libz", "MultiSSL", "NTLM", "SPNEGO", "SSL", "threadsafe", "UnixSockets" ] }, { "name": "x-categories", "value": [ { "name": "auth", "description": "Different types of authentication methods" }, { "name": "connection", "description": "Low level networking operations" }, { "name": "curl", "description": "The command line tool itself" }, { "name": "dns", "description": "General DNS options" }, { "name": "file", "description": "FILE protocol options" }, { "name": "ftp", "description": "FTP protocol options" }, { "name": "http", "description": "HTTP and HTTPS protocol options" }, { "name": "imap", "description": "IMAP protocol options" }, { "name": "misc", "description": "Options that don't fit into any other category" }, { "name": "output", "description": "Filesystem output" }, { "name": "pop3", "description": "POP3 protocol options" }, { "name": "post", "description": "HTTP Post specific options" }, { "name": "proxy", "description": "All options related to proxies" }, { "name": "scp", "description": "SCP protocol options" }, { "name": "sftp", "description": "SFTP protocol options" }, { "name": "smtp", "description": "SMTP protocol options" }, { "name": "ssh", "description": "SSH protocol options" }, { "name": "telnet", "description": "TELNET protocol options" }, { "name": "tftp", "description": "TFTP protocol options" }, { "name": "tls", "description": "All TLS/SSL related options" }, { "name": "upload", "description": "All options for uploads" }, { "name": "verbose", "description": "Options related to any kind of command line output of curl" } ] } ] }, "info": { "title": "curl", "summary": "Transfer a URL", "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, POP3, POP3S, RTMP, RTMPS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP, WS and WSS.\n\ncurl is powered by libcurl for all transfer-related features. See libcurl(3) for details.", "version": "8.7.1", "contact": { "name": "curl project", "url": "https://curl.se" }, "license": { "name": "curl License", "identifier": "curl" } }, "conventions": { "groupOptions": true, "optionSeparator": " " } }