Skip to main content

Downloads an HTTP resource from the specified URL to a file., file, { options })


url is the URL to be downloaded.

file is the destination file that will be written to.

options is a table of options used for this HTTP request.

Return Values

There are two return values.

result_str, response_code =, file, { options })
  • result_str is set to "OK" if successful or contains a description of the failure.
  • result_code is the HTTP result code of the download.


local result_str, response_code ="", "")
function progress(total, current)
local ratio = current / total;
ratio = math.min(math.max(ratio, 0), 1);
local percent = math.floor(ratio * 100);
print("Download progress (" .. percent .. "%/100%)")

local result_str, response_code ="", "", {
progress = progress,
headers = { "From: Premake", "Referer: Premake" },
userpwd = "username:password"

Backward compatible function signature

The previous signature of this function was, file, progress, headers)

and continues to be supported. This is equivalent to, file, { progress = progress, headers = headers })


Premake 5.0 or later.

See Also