Skip to main content
Version: v4.0

Wix.exe command-line reference

info

TODO: WiX v4 documentation is under development.

The Wix.exe .NET tool provides a reassuringly old-fashioned command-line interface to WiX. Like the dotnet command-line tool that inspired it, Wix.exe has a number of command, some with subcommands, and both required and optional switches.

Wix.exe commands

Wix.exe offers the following commands:

Wix.exe commandDescription
wix buildBuild a wixlib, package, or bundle.
wix msiSpecialized operations for manipulating Windows Installer packages.
wix burnSpecialized operations for manipulating Burn-based bundles.
wix extensionManage WiX extension cache.
wix convertConvert v3 source code to v4 source code.
wix formatEnsure consistent formatting of source code.

Wix.exe has the following switches common to all commands:

SwitchDescription
--help or -hShow command line help.
--versionDisplay WiX Toolset version in use.
--nologoSuppress displaying the logo information.

wix build command

SwitchDescription
-archArchitecture of the package or bundle. Valid values are: x86, x64, arm64. Default: x86. Equivalent MSBuild property: InstallerPlatform
-bindfiles or -bfBind files into an output .wixlib. Ignored if not building a .wixlib.
-bindpath or -bBind path to search for content files.
-bindpath:target or -btBind path to search for target package's content files. Only used when building a patch.
-bindpath:update or -buBind path to search for update package's content files. Only used when building a patch.
-cabcache or -ccSet a folder to cache cabinets across builds.
-cultureAdds a culture to filter localization files.
-define or -dSets a preprocessor variable.
-defaultcompressionlevel or -dclSpecifies the compression level used when none is specified via MediaTemplate or Media. Valid values are: none, low, medium, high, mszip. Default: medium. Equivalent MSBuild property: DefaultCompressionLevel
-include or -iFolder to search for include files.
-intermediatefolderOptional working folder. If not specified a folder in %TMP% will be created.
-locLocalization file to use in the build. By default, .wxl files are recognized as localization.
-libLibrary file to use in the build. By default, .wixlb files are recognized as libraries.
-srcSource file to use in the build. By default, .wxs files are recognized as source code.
-out or -oPath to output the build to.
-outputtypeExplicitly set the output type if it cannot be determined from the output.
-pdbOptional path to output .wixpdb. Default will write .wixpdb beside output path.
-pdbtypeSwitch to disable creation of .wixpdb. Types: full or none.

wix msi command

The wix msi command has the following subcommands:

SubcommandDescription
wix msi decompileConverts a Windows Installer database back into source code.
wix msi inscribeUpdates MSI database with cabinet signature information.
wix msi transformCreates an MST transform file.
wix msi validateValidates MSI database using standard or custom ICEs.

wix burn command

The wix burn command has the following subcommands:

SubcommandDescription
wix burn detachDetach the Burn engine from a bundle so it can be signed.
wix burn extractExtract the internals of a bundle to a folder.
wix burn reattachReattach a signed Burn engine to a bundle.
wix burn remotepayloadGenerate source code for a remote payload.

wix extension command

The wix extension command has the following subcommands:

SubcommandDescription
wix extension addAdd extension to the cache.
wix extension listList extensions in the cache.
wix extension removeRemove extension from the cache.

wix convert command

The wix convert command has the following switches:

SwitchDescription
--dry-run or -nOnly display errors, do not update files.
--recurse or -rSearch for matching files in current dir and subdirs.
-set1{file}Primary settings file.
-set2{file}Secondary settings file (overrides primary).
-indent:nIndentation multiple (overrides default of 4).

wix format command

The wix format command has the following switches:

SwitchDescription
--dry-run or -nOnly display errors, do not update files.
--recurse or -rSearch for matching files in current dir and subdirs.
-set1{file}Primary settings file.
-set2{file}Secondary settings file (overrides primary).
-indent:nIndentation multiple (overrides default of 4).