Option Parameters

  • Besides the configuration option, all options can and should be defined in the configuration file

  • The command-line options should only be used to override these values in specific situations

If the configuration option has not been specified, the system tries to locate the Magento Edition, based on the specified installation-dir option.

Suppose the installation-dir option IS specified explicitly, and the directory is a valid Magento root directory.

In that case, the application tries to load database credentials from the app/etc/env.php script, so it is not necessary to specify a database configuration in the configuration file or as a command-line parameter.

The following configuration option parameters are available:
Option Parameters Default value Description


Operation System Hostname

The system name to use.

  • Will be added to the mail subject if mails are configured

  • Contains the system name (Operating System Name) or hostname

  • The value is automatically recognized

  • See Example in Properties: system-name


The default working directory

The installation-dir defines the current Project ROOT working directory.

For a Magento Installation it is the Magento installation directory, otherwise it is your project folder.



The Unique identifier for the import operation.

Since the UUID can only get specified as a temporary value for each CLI import transaction, it is impossible to define or set it as a fixed value in a configuration file.



The explicit PID filename to use.



Activate/deactivate cache functionality for cache.configurable type caches.



Specify the number of issues that get displayed on the CLI console.



The Magento edition to be used(CE | EE).



The installed the Magento version (e.g. 1.4.3).


Specify the pathname to the used configuration file.



Specify the path to the custom configuration directory containing snippets to override the default values with your own configuration.

  • It is strongly recommended that, by default, the value for custom-configuration-dir is <magento-install-directory>/app/etc/configuration

  • As soon as a default configuration is copied, changed, extended, or modified and stored under the path specified in custom-configuration-dir, only this configuration takes effect and always overwrites the original configuration

  • The configuration handling is mainly based on the PHP framework Symfony, and therefore unexpected effects maid occur in different configuration constellations

    • Consequently, it is always recommended to test modified configurations concerning unwanted side effects



The directory to be monitored for new imported files.



The destination directory of the imported files.


The archive directory of the import files.



The flag to activate the artefact archiving functionality.



The flag whether or not the import artefacts have to be cleared.


The database ID used for the import process.

If not specified, the database with the default flag will be used.


The DSN used to connect to the Magento database for the imported data.


The username used to connect to the Magento database


The password used to connect to the Magento database


The table prefix used by the Magento database

  "databases": [
      "id": "local",
      "db-table-prefix": "myprefix_",



The debug mode activation flag



The log level to use (see Monolog documentation for further information).

Log Levels:



The flag to wrap the import process into a single transaction


Additional options passed as JSON format string (must have the same format as the configuration file used).

The given additional options will be merged with the already existing parameters from the configuration file.


Path to a custom JSON encoded parameter file.

The parameter file will be merged with the parameter from the existing configuration file.


The prefix of the files that should be imported and moved to the temporary directory of the import



Predefined constant to remove empty values in EAV attribute values, categories, products, and customers.



Strict mode logs PDO exceptions in a log file in the following cases:
  • if a URL already exists

  • if an SKU gets not found

If strict mode is disabled, the error gets logged to a validation.json file to guarantee that the importer continues to run.


The relative/absolute pathname of the destination file



To report all available Configuration json files on debug logs


The Magento configuration directory.

This is especially useful when running import during Magento integration tests