EDI Converter Command Line Tool Installation

Installation Steps

  • Download and install Java from the Oracle website. You can also use OpenJDK. Java 17 or higher is required. We recommend installing the latest long-term support (LTS) release of Java (Java 25). You can also install Java using sdkman or a package manager on Linux or macOS. Once you install Java, verify the version by running java -version in a terminal.
  • If Java is already installed on your system, verify that you have the correct version by running java -version; it must be version 17 or higher.
  • If you have JAVA_HOME environment variable defined, make sure that it points to Java 17 or higher. Alternatively, you can delete the JAVA_HOME variable. To view environment variables on Windows, go to “Settings/Advanced system settings”, “Advanced” tab, click “Environment Variables…”.
  • Download the zip file with the converter from this link.
  • Unzip the converter’s zip file; the root folder/directory of the installation will be ediconvert.
  • (Optional) Install autocompletion (bash and zsh). Download the completion script, save it to a location of your choice, and source it from your shell configuration file (e.g., ~/.bashrc or ~/.zshrc). If you have bash_completion installed, place it in the appropriate location, such as /etc/bash_completion.d. You can find more details here.

Many Windows systems have Java 8 pre-installed. The converter requires Java 17 or later; it will fail when Java 8 is used. Follow the steps above to ensure that you have the correct version of Java.

You need a license key to run the converter. Request your trial license key here.

Once you receive your edi-license.txt license file, save it into the installation folder, i.e., into ediconvert. Alternatively, you can save the license file in a different location; then you need to set the EDI_LICENSE_FILE environment variable to point to it. You can also copy the license key to the EDI_LICENSE_KEY environment variable.

You can run the converter by providing the full path, e.g., ediconvert\bin\ediconvert on Windows or ediconvert/bin/ediconvert on Linux/macOS.

We recommend adding the bin directory of the converter to the “Path” so you can run it from anywhere. On Windows, go to “Settings/Advanced system settings”, open the “Advanced” tab, click “Environment Variables…”, select “Path”, and click “Edit…”. Create a new entry with the absolute path to the bin folder. On Linux/macOS, append it to the PATH variable in your shell configuration file, e.g., for .bashrc: export PATH=$PATH:ediconvert/bin.

All examples in this documentation assume that you’ve added the converter to the path, so we omit the full path to bin/ediconvert.

Run ediconvert -V to view the license and version information.

License File and License Key Configuration

The default location of the license file is the converter’s installation folder, e.g., ediconvert.

Alternatively, you can save the license file anywhere and define the environment variable EDI_LICENSE_FILE with the path to the license file.

For Linux/macOS, add the variable to your profile:

export EDI_LICENSE_FILE=<absolute path to the file>

For Windows, create a new environment variable EDI_LICENSE_FILE from “Settings/Advanced system settings.”

You can also set your license key using the environment variable EDI_LICENSE_KEY. Copy the entire content of edi-license.txt into that variable. In this case, you don’t need to save the license key file anywhere.

Run ediconvert -V to view the license information and the location of the license file.