We have detected your current browser version is not the latest one. Xilinx.com uses the latest web technologies to bring you the best online experience possible. Please upgrade to a Xilinx.com supported browser:Chrome, Firefox, Internet Explorer 11, Safari. Thank you!

AR# 43008

PlanAhead - Can PlanAhead write out a Tcl script to run the complete project from scratch?


Is there a feature in the PlanAhead tool to create a Tcl script that allows for the regeneration of a PlanAhead project with all settings?


In PlanAhead this feature is not currently available. 

The PlanAhead User Guide (UG632) suggests that you capture a PlanAhead project with all of its settings by copying the necessary Tcl commands from the journal, (.jou), file into a Tcl script. 

To do this:

  1. Open the Journal File, (.jou) and/or Log file, (.log), from within the PlanAhead GUI.
  2. With the original project open, go to File -> Open Journal File.

The journal file contains all the commands run when using the PlanAhead tool. 

According to the user guide, "You can copy Tcl commands from the log files for use either in the Tcl command window or in a batch file."

You can also open the journal and log files without opening the PlanAhead tool. 

The PlanAhead journal file and log file are written to the following locations:

  • For Windows OS:
    (for example, C:\Documents and Settings\johnsmith\Application Data\Xilinx\PlanAhead)
  • For Linux OS:
    (for example, /home/johnsmith/.Xilinx/PlanAhead)

Note: the .jou file is not a complete Tcl script that you can use as is.
Most importantly, ensure that you insert the wait_on_runs command before any command that requires a previous command to complete before the command is executed.


In the following example, synth_1 must be complete before impl_1 can be run:

launch_runs synth_1
wait_on_run synth_1

The user guide also outlines the options available when running the Tcl script.

In Vivado, use the write_project_tcl command.

AR# 43008
Date 03/23/2015
Status Active
Type General Article
  • PlanAhead - 12.1
  • PlanAhead - 13.1
Page Bookmarked