• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 Long: config
2 Arg: <file>
3 Help: Read config from a file
4 Short: K
5 Category: curl
6 ---
7 
8 Specify a text file to read curl arguments from. The command line arguments
9 found in the text file will be used as if they were provided on the command
10 line.
11 
12 Options and their parameters must be specified on the same line in the file,
13 separated by whitespace, colon, or the equals sign. Long option names can
14 optionally be given in the config file without the initial double dashes and
15 if so, the colon or equals characters can be used as separators. If the option
16 is specified with one or two dashes, there can be no colon or equals character
17 between the option and its parameter.
18 
19 If the parameter contains whitespace (or starts with : or =), the parameter
20 must be enclosed within quotes. Within double quotes, the following escape
21 sequences are available: \\\\, \\", \\t, \\n, \\r and \\v. A backslash
22 preceding any other letter is ignored.
23 
24 If the first column of a config line is a '#' character, the rest of the line
25 will be treated as a comment.
26 
27 Only write one option per physical line in the config file.
28 
29 Specify the filename to --config as '-' to make curl read the file from stdin.
30 
31 Note that to be able to specify a URL in the config file, you need to specify
32 it using the --url option, and not by simply writing the URL on its own
33 line. So, it could look similar to this:
34 
35 url = "https://curl.se/docs/"
36 
37 When curl is invoked, it (unless --disable is used) checks for a default
38 config file and uses it if found. The default config file is checked for in
39 the following places in this order:
40 
41 1) Use the CURL_HOME environment variable if set
42 
43 2) Use the XDG_CONFIG_HOME environment variable if set (Added in 7.73.0)
44 
45 3) Use the HOME environment variable if set
46 
47 4) Non-windows: use getpwuid to find the home directory
48 
49 5) Windows: use APPDATA if set
50 
51 6) Windows: use "USERPROFILE\Application Data" if set
52 
53 7) On windows, if there is no .curlrc file in the home dir, it checks for one
54 in the same dir the curl executable is placed. On Unix-like systems, it will
55 simply try to load .curlrc from the determined home dir.
56 
57 .nf
58 # --- Example file ---
59 # this is a comment
60 url = "example.com"
61 output = "curlhere.html"
62 user-agent = "superagent/1.0"
63 
64 # and fetch another URL too
65 url = "example.com/docs/manpage.html"
66 -O
67 referer = "http://nowhereatall.example.com/"
68 # --- End of example file ---
69 .fi
70 
71 This option can be used multiple times to load multiple config files.
72