Skip to content

synQup CLI User Commands

With the following commands you can export and import flows to a JSON file. The file contains the following information: - Flows - Job Dispatcher Mappings - Filesystems - Environments and environment-specific configurations - Config Snippets - Cron entries

Commands

Command Description
synqup:export Export flows and filesystems(if no flowId) to a JSON file
synqup:import Import flows and filesystems to a JSON file

Export flows

By default, a JSON file with the name 'SynQupExport.json' will be created in the root directory of the project.

Arguments:

  • flowId: (Optional) Export only the flow with the given ID. If this argument is not provided, all flows will be exported.

Options:

  • --exclude-cron: (Optional) If set, cron entries will not be exported.
  • --exclude-dispatch-condition: (Optional) If set, dispatch conditions will not be exported.
  • --exclude-environment: (Optional) If set, environments will not be exported.
  • --exclude-config-snippet: (Optional) If set, config snippets will not be exported.

Import flows

Imports flows from a JSON file. The file must be in the root directory of the project.

Arguments:

  • file-path: (Optional) File path of the JSON file to import. If this argument is not provided, you will be asked for a file path. The default file path will be 'SynQupExport.json'.

Options:

  • --only-if-no-flows: (Optional) If set, the import will only be done if there are no flows in the database. This avoids duplicating flows and other conflicts.