report_config_flows - report_config_flows - 2026.1 English

report_config_flows - report_config_flows - 2026.1 English - UG835

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID

UG835

Release Date

2026-06-23

Version

2026.1 English

Report Config Flow Configurations.

Syntax

report_config_flows [‑file <arg>] [‑append] [‑force] [‑return_string]
    [‑quiet] [‑verbose] [‑no_header]

Usage

Name	Description
`[-file]`	Filename to output results to. (send output to console if -file is not used)
`[-append]`	Append to existing file
`[-force]`	Overwrite existing file
`[-return_string]`	Return report as string
`[-quiet]`	Ignore command errors
`[-verbose]`	Suspend message limits during command execution
`[-no_header]`	Do not generate a report header

Description

Reports the current configuration settings for design flows. This command displays flow parameters and their values in a formatted table.

The report includes option names, allowable values for each option, current value, default value, parameter type, and description. By default, the report is displayed in the console. Use -file to write the report to a file, or -return_string to capture it as a Tcl variable.

The report displays design, device, and speed file information in the header when a design is open. The hidden and advanced parameters are only shown in the report when they have non-default values.

Note: Use report_config_flows after setting flow options with config_flows to verify the current configuration.

Arguments

-file - (Optional) Write the report into the specified file. The specified file will be overwritten if one already exists, unless -append is also specified.

Note: If the path is not specified as part of the file name, the file will be written into the current working directory, or the directory from which the tool was launched.

-append - (Optional) Append the output of the command to the specified file rather than overwriting it.

Note: The -append option can only be used with the -file option.

-force - (Optional) Overwrite an existing file without prompting. Use with -file option.

-return_string - (Optional) Directs the output to a Tcl string rather than to the standard output. The Tcl string can be captured by a variable definition and parsed or otherwise processed.

Note: The -return_string and -file options are mutually exclusive.

-no_header - (Optional) Do not generate the report header (tool version, date, design, device, speed file information). Only the settings table is displayed.

-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.

Examples

The following example displays config flows settings in the console:

report_config_flows

The following example writes the report to a file:

report_config_flows -file config_settings.txt

The following example appends the report to an existing file:

report_config_flows -file config_settings.txt -append

The following example captures the report as a string variable:

set report [report_config_flows -return_string]
puts $report

The following example displays the report without header:

report_config_flows -no_header

The following example forces overwrite of an existing file:

report_config_flows -file config.txt -force