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 non_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 finishes processing.
  • Tcl mode runs the sourced script, and returns to the Tcl command prompt when finished.
  1. Navigate to the directory where the lab materials are stored:
    • On Linux: cd <Extract_Dir>/lab_4
  2. Launch the Vivado Design Suite Tcl shell and source a Tcl script to create the tutorial design:
    • On Linux: vivado -mode tcl -source non_project_run.tcl
    • On Windows, click Start > All Programs > AMD Design Tools > Vivado 2026.1 > Vivado 2026.1 Tcl Shell to launch the Vivado Design Suite Tcl shell.
  3. In the Tcl shell:
    • Navigate to the directory where the lab materials are stored:
      Vivado% cd <Extract_Dir>/lab_4
    • Source the Tcl script to create the design:
      Vivado% source non_project_run.tcl

      After the sourced script is complete, the Tcl shell displays the Vivado% prompt.

      Important: If your Tcl script contains an error, the script halts execution at the point of the error. You must 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.


    Running the script results in the creation of a directory called IP. The system writes output products for the various IPs used in the design to this directory. It also writes reports, design checkpoints, and a bitstream for the design to disk.

  4. You can open the design in the Vivado IDE to perform further analysis. To open the Vivado IDE from the Tcl prompt type: start_gui.