Saving Vivado Project Information in a Tcl File - 2023.2 English

Vivado Design Suite User Guide: Designing IP Subsystems Using IP Integrator (UG994)

Document ID
UG994
Release Date
2023-10-18
Version
2023.2 English

To save overall project settings, select File > Project > Write Tcl.

Figure 1. Writing a Tcl File for the Project

In the Write Project to Tcl dialog box, shown in the following figure, specify the name and location of the Tcl file and select any other options.

Figure 2. Write Project to Tcl Dialog Box with Tcl for Block Design

There are several options available in this dialog box. If the Copy sources to new project option and the Recreate Block Design using Tcl option are both checked, the Tcl script to create the project as well as the script to recreate the block design are all included in the script. The same can be done by using the write_project_tcl command in the Tcl Console, as follows:

write_project_tcl <path to file>/<filename>.tcl

You can also check the option Copy sources to new project without checking the Recreate Block Design using Tcl. In this case, the block design is imported from the original design and added to the project. In other words, the block design is copied from the original design and added to the sources of the project.

Figure 3. Write Project to Tcl Dialog Box with Options to Copy Block Design

The same can be done by using the write_project_tcl command in the Tcl Console, as follows:

write_project_tcl -use_bd_files <path to file>/<filename>.tcl

Finally, you can create the Tcl script for the project with both Copy sources to new project and Recreate Block Design using Tcl options unchecked. In this case, the project is created as specified; however, the block design sources are not copied into the project. The block design is rather a “remote” block design, meaning that it points to the block design in the original project.

Figure 4. Write Project to Tcl Dialog Box with Option to Use the “Remote” Block Design

This can also be achieved by typing the following Tcl command in the Tcl Console:

write_project_tcl -no_copy_sources -use_bd_files <path to file>/<filename>.tcl