Intel® Quartus® Prime Pro Edition User Guide: Platform Designer

ID 683609
Date 6/20/2022
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

8.11. Archive and Extract Platform Designer Systems with qsys-archive

The qsys-archive command allows you to archive a system, extract an archived system, and retrieve information about the system's dependencies.
Table 204.   qsys-archive Command-Line Options
Option Usage Description

<1st arg file>

Required

The filename of the root Platform Designer system, Platform Designer file archive, or the Intel® Quartus® Prime project file.

--search-path[=<value>]

Optional

If you omit this option, Platform Designer uses a standard default path. If you specify this option, Platform Designer searches a comma-separated list of paths. To include the standard path in your replacement, use "$", for example: /extra/dir,$.

--archive

Optional

Creates a zip archive of the specified Platform Designer system or the Intel® Quartus® Prime project.

--report-file[=<value>]

Optional

Lists the files that the Platform Designer system or the Intel® Quartus® Prime project references, and writes the files list to the specified name in .txt format.

--output-directory[=<file>]

Optional

Specifies the output directory to save the archive.

--extract

Optional

Extracts all the files in the given archive.

--output-name[=<value>]

Optional

Specifies the output name to save the archive or report.

collect-to-common-directory[=<true|false>]

Optional

When archiving, collects all the .qsys files in the root directory of the archive and all .ip files in a single ip directory, and updates all the matching references. The default option is true.

new-quartus-project[=<value>]

Optional

Creates a new Intel® Quartus® Prime project which contains all the .ip and system files referenced by the Platform Designer system or the Intel® Quartus® Prime project.

quartus-project[=<value>]

Optional

When you use this command in combination with:
  • --report-file—adds all the referenced files to the Intel® Quartus® Prime project.
  • --extract—adds all extracted files to the specified project.
  • --archive—archives all the system and .ip files referenced in the Intel® Quartus® Prime project.

--rev

Optional

Specifies the name of the Intel® Quartus® Prime project revision.

--include-generated-files

Optional

Includes all the generated files of the Platform Designer system.

--force

Optional

Forcefully creates the specified archive or report, overwriting any existing archives or reports.

--jvm-max-heap-size=<value>

Optional

Specifies the maximum memory size Platform Designer uses for allocations when running qsys-edit. Specify this value as <size><unit>, where unit is m (or M) for multiples of megabytes, or g (or G) for multiples of gigabytes. The default value is 512m.

--help

Optional

Displays help for qsys-archive.

Alternatively, you can archive and restore your system using the Platform Designer GUI. For more information, refer to Saving and Archiving Platform Designer Systems section.