Export Project

Command Execution

When you export a project present in the local directory, the CLI will fetch the project’s component configurations from the remote console. If no components have been configured, the default configurations will be written to the project-template JSON file.

  • The project must be mandatorily available in the remote console to be exported.
  • If the console contains updated functions or client code that are not present in the local directory, they will be fetched automatically.

  1. To export a project associated with a Catalyst project directory in your local system, execute the following command from the directory in your terminal:
catalyst iac:export

This will initiate the export job. Catalyst will assign a unique Job ID to the export operation. You can use this Job ID to check the status of the job any time.

CLI IaC Export

  1. After the export job is complete, the CLI will prompt you for the export ZIP file download. Press Y , then press Enter to download the ZIP into your project directory.

CLI IaC Export

The ZIP file will be available in the home directory of your project directory in the standard format as discussed in the previous section, along with the functions and client directories, and the catalyst.json file.

Note: You can export a project that is not associated with the current directory the command is being executed from, by using the –project <name_or_project_id> option.

Export Project Options


You can export the production environment of a project directly, instead of its development environment which is the default for all CLI actions.

This can be done by pointing to the production environment using the –production option while executing the command from the project directory like:

catalyst iac:export --production

This will export the configurations of the project from its production environment in the same manner as discussed in the previous section.

Last Updated 2023-04-19 15:32:07 +0530 +0530