write_hw_platform_metadata - 2023.2 English

Vivado Design Suite Tcl Command Reference Guide (UG835)

Document ID
Release Date
2023.2 English

Write the unified JSON metadata file for the current design


write_hw_platform_metadata [‑quiet] [‑verbose] [<file>]


The name of the unified JSON metadata file.


Name Description
[-quiet] Ignore command errors
[-verbose] Suspend message limits during command execution
[<file>] Unified JSON metadata file Values: A filename with alphanumeric characters and .json extension.


Vitis, Platform, FileIO


Writes a JSON metadata file for the platform represented by the current design.

This command returns the name of the JSON file written, or returns an error if it fails.


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

<file> - (Required) The name of the JSON file to write. Must use the .json file extension.

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.


The following example writes the JSON file for the current project:

write_hw_platform_metadata C:/Data/zc102_platform.json