Source the Tcl Script - Source the Tcl Script - 2026.1 English

Source the Tcl Script - Source the Tcl Script - 2026.1 English - UG939

Vivado Design Suite Tutorial: Designing with IP (UG939)

Document ID

UG939

Release Date

2026-07-15

Version

2026.1 English

You can run the project_run.tcl script in Vivado Design Suite batch mode or Tcl mode.

Batch mode runs the sourced script, and automatically exits the tool after the script has finished processing.
Tcl mode runs the sourced script, and return to the Tcl command prompt when finished.
- On Linux:
  Change to the directory where the lab materials are stored:
```
cd <Extract_Dir>/lab_3
```
  Launch the Vivado Design Suite Tcl shell and source a Tcl script to create the tutorial design:
```
vivado -mode tcl -source project_run.tcl
```
- On Windows:
  Launch the Vivado Design Suite Tcl shell:
```
Start > All Programs > Xilinx Design Tools > Vivado 2025.2 > Vivado 2025.2 Tcl Shell
```
  Your Vivado Design Suite installation might be called something different from AMD Design Tools on the Start menu.

In the Tcl shell, change to the directory where the lab materials are stored:
```
Vivado% cd <extract_dir>/lab_3
```
Source the Tcl script to create the design:
```
Vivado% source project_run.tcl
```
Important: If your Tcl script has an error in it, the script halts execution at the point of the error. You need to fix the error, and re-source the Tcl script as needed. If you are running in Tcl mode, you might need to close the current project with close_project, or exit the Vivado tool to source the Tcl script again.

After the script executes, a project directory structure is created, default log and reports are generated, a synthesized netlist is produced, design is fully implemented, and a bitstream is created. You can use the Vivado IDE to examine the design, the various reports, and to perform analysis on the design.
To open the GUI from the Tcl prompt type:
```
start_gui
```