Using Tcl Help - 2022.2 English

Vivado Design Suite User Guide: Using the Vivado IDE (UG893)

Document ID
Release Date
2022.2 English

In the command line entry box at the bottom of the Tcl Console, type:


To get detailed information about a command, type:

help <command_name>


<command_name> -help

For example

help add_files


add_files -help

The Tcl Console displays the list of available commands or command options based on the command you enter.

Tip: To make it easier to read the command help, double-click the Tcl Console tab or press Alt - to maximize it.

For explicit command syntax, perform the command once, then view the vivado.jou file in the invocation directory. For more information on creating Tcl scripts, see the Vivado Design Suite User Guide: Using Tcl Scripting (UG894). For a complete list of Tcl commands, refer to the Vivado Design Suite Tcl Command Reference Guide (UG835).

Important: The vivado.jou file is a good starting point for creating a Tcl script. However, it is not intended to be used as a script itself.