project_archive (::quartus::project_ui)

The following table displays information for the project_archive Tcl command:

Tcl Package and Version

Belongs to ::quartus::project_ui 1.0

Syntax project_archive [-h | -help] [-long_help] [-all_revisions] [-include_libraries] [-include_outputs] [-overwrite] [-use_file_set <file_set> ] [-version_compatible_database] <archive_name>
Arguments -h | -help Short help
-long_help Long help with examples and possible return values
-all_revisions Option to archive all revisions
-include_libraries Option to include related system libraries
-include_outputs Option to include output files in archive
-overwrite Option to overwrite any currently existing archive file
-use_file_set <file_set> Option to create the archive using the specified file set
-version_compatible_database Option to include version-compatible database if supported
<archive_name> Archive file name
Archives an open project and its related files into a
Quartus Prime Archive File (.qar).

The description of operations is as follows:

Option                         Description
------                         -------------------------
use_file_set                   Creates the archive using the specified
                               file set. By default, the 'basic'
                               file set is used. For more information
                               about file sets, type: quartus_sh --archive -list_file_sets

all_revisions                  Archives all revisions.

overwrite                      Overwrites existing archive file.

include_outputs                Includes output files in archive.

include_libraries              Includes related Megafunction and
                               IP library files.

version_compatible_database    Includes version-compatible database
                               if supported.
Example Usage
## Default mode: Archive current revisions without output files or libraries
project_archive chiptrip.qar

## Archive all revisions without output files or libraries
project_archive chiptrip.qar -all_revisions

## Archive current revision with version-compatible database if supported
project_archive chiptrip.qar -version_compatible_database

## Same as first one, but overwrite any existing archive file
project_archive chiptrip.qar -overwrite

## Include outut files and libraries
project_archive chiptrip.qar -include_outputs -include_libraries
Return Value Code Name Code String Return
TCL_OK 0 INFO: Operation successful
TCL_ERROR 1 ERROR: Error(s) found while archiving the project. See error message(s) for details.
TCL_ERROR 1 ERROR: Project archive failed. Some files could not be processed. Refer to the Quartus Prime Archive Log File (<archive_name>.qarlog).
TCL_ERROR 1 ERROR: Can't run Tcl command while a process is in progress: <string>. To run the command, stop the compilation or simulation; or wait for the compilation or simulation to complete.
TCL_ERROR 1 ERROR: You must open a project before you can use this command.