Executing a Tcl Script at Startup - 2024.1 English

Vivado Design Suite User Guide: Using Tcl Scripting (UG894)

Document ID
UG894
Release Date
2024-05-30
Version
2024.1 English

To specify a script to be executed at startup on the Vivado tools command line, use the -source option:

vivado -source myscript.tcl

The following is equivalent to manually sourcing the script after first starting Vivado tools:

source myscript.tcl

A checkpoint can also be specified on the command line along with a Tcl script:

vivado design.dcp -source myscript.tcl

The above command line is equivalent to manually opening the checkpoint and then sourcing the script:

open_checkpoint design.dcp
source myscript.tcl

The combination of a checkpoint and script provides the flexibility to write a Tcl script independent of any design and then easily associate a checkpoint with the script:

vivado design1.dcp -source myscript.tcl
vivado design2.dcp -source myscript.tcl