--linkhook Options - --linkhook Options - 2026.1 English - UG1702

Vitis Reference Guide (UG1702)

Document ID: UG1702
Release Date: 2026-06-23
Version: 2026.1 English

Use the --linkhook.XXX options below to specify Tcl scripts to run at specific steps during Vitis linking. Valid steps can be determined using the --linkhook.list_steps command as described below.

--linkhook.custom

--linkhook.custom <step name, path to script file>

Specifies a Tcl script to execute at a predefined point in the build process. The path to specify the script can be an absolute path, or partial path relative to the build directory.

For example, the following command runs the specified Tcl script before the SysLink step in the build:

v++ -l --linkhook.custom preSysLink,./runScript.tcl

-linkhook.do_first

--linkhook.do_first <step name, path to script file>

Specifies a Tcl script to execute before the given step name. The path to specify the script can be an absolute path, or partial path relative to the build directory.

For example, the following command runs the specified Tcl script before the place_design step in the build:

v++ -l --linkhook.do_first vpl.impl.place_design,runScript.tcl

-linkhook.do_last

--linkhook.do_last <step name, path to script file>

Specifies a Tcl script to execute immediately after the given step completes. The path to specify the script can be an absolute path, or partial path relative to the build directory.

For example, the following command runs the specified Tcl script after the place_design step in the build:

v++ -l --linkhook.do_last vpl.impl.place_design,runScript.tcl

-linkhook.list_steps

--linkhook.list_steps

List default and optional build steps that support script hooks for a specified target. This command requires the --target to be specified in addition to the --link option.

For example:

v++ --target hw -l --linkhook.list_steps

The command returns both default steps that Vitis always enables during the build process. The command also returns optional steps you can enable. For instructions on enabling optional steps, see the following section.

For data center acceleration: Managing Vivado Synthesis, Implementation, and Timing Closure in the Data Center Acceleration using Vitis (UG1700)
For embedded design development: Managing Vivado Synthesis, Implementation, and Timing Closure in the Embedded Design Development Using Vitis (UG1701)