Hop GUI

Hop GUI is the visual integrated development environment (IDE) for Apache Hop.

Usage

Start Hop GUI with hop-gui.bat on Windows or hop-gui.sh on Linux and macOS, or with the hop gui command.

Without extra options Hop GUI opens the last used project. You can also select a project, a lifecycle environment, and a file to open:

hop gui -j samples -f '{openvar}PROJECT_HOME{closevar}/transforms/add-a-checksum.hpl'
hop gui -e production -f long-running-test.hpl

Relative filenames are resolved against the current directory, then against ${PROJECT_HOME} once the project is enabled.

The same -j, -e and -f options work with hop-gui.sh / hop-gui.bat. --project-locations and --in-memory are parsed by the hop command and are not available on hop-gui.sh / hop-gui.bat.

Usage
Output of help
Usage: hop gui [-hV] [-im] [-e=<environmentOption>] [-f=<filename>]
               [-j=<projectOption>]
               [--environment-conf-files=<environmentConfigFiles>[,
               <environmentConfigFiles>...]]... [--environments=<environments>[,
               <environments>...]]... [-pl=<projectLocations>[,
               <projectLocations>...]]...
The Hop GUI
  -e, --environment=<environmentOption>
                          The name of the lifecycle environment to use
  -f, --file=<filename>   The filename of the workflow or pipeline to open
  -h, --help              Show this help message and exit.
      -im, --in-memory    Keep configuration in memory without persisting to
                            hop-config.json
  -j, --project=<projectOption>
                          The name of the project to use
      -pl, --project-locations=<projectLocations>[,<projectLocations>...]
                          Comma-separated list of project locations
                            (name=location or archive files)
  -V, --version           Print version information and exit.

The available options are listed in more detail in the table below:

Short Extended Description

-e

--environment

The name of the lifecycle environment to enable. The project name is taken from that environment, so you do not need -j as well. See Projects and Environments.

-f

--file

The filename of the workflow or pipeline to open. Relative paths are resolved against the current directory, then ${PROJECT_HOME}.

-h

--help

Displays this help message and quits.

-im

--in-memory

Keep Hop configuration in memory. Changes are not written to hop-config.json.

-j

--project

The name of the project to enable. Not needed when -e is set.

-pl

--project-locations

Comma-separated project locations to register for this process only (name=/path or a zip/jar). See Use a project without hop-config.json.

--environments

Comma-separated environment definitions (name=[project:]file1;file2) registered in memory for this process.

--environment-conf-files / --environment-config-files

Extra environment configuration files to apply to the enabled project or environment.

-V

--version

Print version information and exit.

To open a project that is not listed in hop-config.json:

hop --project-locations my-project=/path/to/project gui -j my-project -f pipeline.hpl