Tcl Batch Mode - 2021.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2021.2 English
You can use the Vivado tools in batch mode by supplying a Tcl script when invoking the tool. Use the following command either at the Linux command prompt or within a Windows Command Prompt window:
vivado -mode batch -source <your_Tcl_script>

The Vivado Design Suite Tcl shell will open, run the specified Tcl script, and exit when the script completes. In batch mode, you can queue up a series of Tcl scripts to process a number of designs overnight through synthesis, simulation, and implementation, and review the results on the following morning.

You can also pass arguments to the Vivado command when sourcing a Tcl script in batch mode. The -tclargs option lets you specify arguments for the Tcl script you are running. For example:
vivado -mode batch -source script.tcl -tclargs "FPGA=115-2"
Important: You must enclose the Tcl argument and value in quotes as shown in the example above, or there can be an error in handling the argument.