close_sim - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Unload the current simulation without exiting Vivado


close_sim [‑force] [‑quiet] [‑verbose]


Name Description
[-force] Forces the closing of the simulation, even if changes would be lost. Default behavior is to reject the closing with an error if changes would be lost.
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution



Close the current AMD Vivado™ simulation.

Note: This command does not support third party simulators.


-force - (Optional) Force closing the simulation even if changes would be lost. Does not prompt to save changes before closing.

-quiet - (Optional) Execute the command quietly, returning no messages from the command. The command also returns TCL_OK regardless of any errors encountered during execution.
Note: Any errors encountered on the command-line, while launching the command, will be returned. Only errors occurring inside the command will be trapped.
-verbose - (Optional) Temporarily override any message limits and return all messages from this command.
Note: Message limits can be defined with the set_msg_config command.


The following example closes the current simulation, forcing the close even if changes would be lost:

close_sim -force