!download

Downloads a file from a specified URL or git release.

Note

This action by default overrides the iso action property to true, meaning this will run during ISO injection rather than during the OOBE.

Required Parameters

Parameter	Description	Type
destination	Specifies the destination file name or path for the download. If no path root is specified, it will download into the playbook’s active Executables directory.	string
url	Specifies a direct URL to download from. This is not required when git is specified	string
git	Specifies a git repository to download from. Note that regex must be specified with this. This is not required when url is specified	string
regex	Specifies regular expression to filter git release files. If necessary, use '.*' as a wildcard to get the first release file. This is only required when git is specified	string

Optional Parameters

Parameter	Description	Type	Default
overwrite	Indicates whether or not to overwrite an existing file at destination if it already exists.	bool	false
package	Specifies a package name for matching with a software Package in playbook.conf. See ISO Compatibility	string	None

Examples

Downloads Brave browser standalone installer executable and runs it:

- !download:
  option: "browser-brave"
  url: 'https://github.com/brave/brave-browser/releases/latest/download/BraveBrowserStandaloneSetup.exe'
  destination: "BraveBrowserStandaloneSetup.exe"

- !run:
  exeDir: true
  exe: "BraveBrowserStandaloneSetup.exe"
  args: '/silent /install'
  weight: 70

Downloads the latest Ungoogled Chromium release from the winchrome GitHub repository:

- !download:
  git: 'https://github.com/macchrome/winchrome'
  regex: 'chromium-.*_Win64\.7z'
  destination: "ugc.7z"