hop -h

Usage: hop [-hV] [--dev-debug] [--dev-debug-wait] [-s=<systemProperties>[,
           <systemProperties>...]]... [COMMAND]
      --dev-debug        Allow a Hop developer to debug remotely
      --dev-debug-wait   Allow a Hop developer to debug remotely. The script
                           will wait until a debugging session is set up.
  -h, --help             Show this help message and exit.
  -s, --system-properties=<systemProperties>[,<systemProperties>...]
                         A comma separated list of KEY=VALUE pairs
  -V, --version          Print version information and exit.
Commands:
  help         Display help information about the specified command.
  conf         Configure Hop
  driver       Manage JDBC drivers (list, install)
  encrypt      Encrypt secrets
  gui          The Hop GUI
  import       Import metadata
  marketplace  Install and manage optional Hop plugins from a Maven repository
  run          Run a pipeline or workflow
  search       Search in Hop metadata
  server       Run a Hop server

hop --version

hop run --help

Usage: hop run [-hov] [-au] [-a=<startActionName>] [-e=<environmentOption>]
               [-f=<filename>] [-j=<projectOption>] [-l=<level>]
               [-lf=<logFile>] [-m=<metadataExportFile>]
               [-ps=<parametersSeparator>] [-r=<runConfigurationName>]
               [-p=<parameters>]... [-s=<systemProperties>[,
               <systemProperties>...]]...
Run a pipeline or workflow
  -a, --startaction=<startActionName>
                          The name of the action where to start a workflow
      -au, --allow-unsupported
                          Allow running pipelines or workflows that contain
                            transforms or actions marked UNSUPPORTED on the
                            selected engine. By default such runs are rejected
                            at startup with the list of incompatible elements;
                            this flag is the CLI equivalent of the GUI "Run
                            anyway" override.
  -e, --environment=<environmentOption>
                          The name of the lifecycle environment to use
  -f, --file=<filename>   The filename of the workflow or pipeline to run
  -h, --help              Displays this help message and quits.
  -j, --project=<projectOption>
                          The name of the project to use
  -l, --level=<level>     The debug level, one of NOTHING, ERROR, MINIMAL,
                            BASIC, DETAILED, DEBUG, ROWLEVEL
      -lf, --logfile=<logFile>
                          The complete filename where hop-run will write the
                            Hop console log
  -m, --metadata-export=<metadataExportFile>
                          A file containing exported metadata in JSON format
  -o, --printoptions      Print the used options
  -p, --parameters=<parameters>
                          A list of PARAMETER=VALUE pairs (default separator:
                            comma). For values containing the separator, wrap
                            in double quotes, e.g. -p 'key1="value1,value2"'
      -ps, --parameters-separator=<parametersSeparator>
                          A character to be used as separator for our list of
                            PARAMETER=VALUE pairs (default is ,)
  -r, --runconfig=<runConfigurationName>
                          The name of the Run Configuration to use
  -s, --system-properties=<systemProperties>[,<systemProperties>...]
                          A comma separated list of KEY=VALUE pairs
  -v, --version           Print version information and exit

hop run -f pipelines/my-first-pipeline.hpl

2026/10/11 05:45:48 - HopRun - Enabling project 'default'
2026/10/11 05:45:48 - HopRun - Two-way password encoder initialized with plugin ID 'Hop' for project 'default'
2026/10/11 05:45:48 - HopRun - Starting pipeline: /opt/data/apache-hop/project/pipelines/my-first-pipeline.hpl
2026/10/11 05:45:48 - my-first-pipeline - Executing this pipeline using the Local Pipeline Engine with run configuration 'local'
2026/10/11 05:45:48 - my-first-pipeline - Execution started for pipeline [my-first-pipeline]
2026/10/11 05:45:48 - Generate Rows.0 - Finished processing (I=0, O=0, R=0, W=10, U=0, E=0)
2026/10/11 05:45:48 - Dummy.0 - Finished processing (I=0, O=0, R=10, W=10, U=0, E=0)
2026/10/11 05:45:48 - my-first-pipeline - Pipeline duration : 0.093 seconds [  0.093" ]
2026/10/11 05:45:48 - my-first-pipeline - Execution finished on a local pipeline engine with run configuration 'local'

hop run -f pipelines/my-first-pipeline.hpl -p row_limit=15

Generate Rows.0 - Finished processing (I=0, O=0, R=0, W=15, U=0, E=0)
Dummy.0 - Finished processing (I=0, O=0, R=15, W=15, U=0, E=0)

hop run -f pipelines/my-first-pipeline.hpl -o

HopRun - OPTION: filename : '/opt/data/apache-hop/project/pipelines/my-first-pipeline.hpl'
HopRun - OPTION: run configuration : 'local'
HopRun - OPTION: Logging level : Basic

hop run -f pipelines/my-first-pipeline.hpl -lf /opt/data/apache-hop/logs/pipeline.log -l ROWLEVEL

2026/10/11 05:46:57 - HopRun - Starting pipeline: /opt/data/apache-hop/project/pipelines/my-first-pipeline.hpl
2026/10/11 05:46:57 - my-first-pipeline - Executing this pipeline using the Local Pipeline Engine with run configuration 'local'
2026/10/11 05:46:57 - my-first-pipeline - Execution started for pipeline [my-first-pipeline]

hop run -f workflows/my-first-workflow.hwf

2026/10/11 05:46:08 - HopRun - Starting workflow: /opt/data/apache-hop/project/workflows/my-first-workflow.hwf
2026/10/11 05:46:08 - my-first-workflow - Start of workflow execution
2026/10/11 05:46:08 - my-first-workflow - Starting action [Start]
2026/10/11 05:46:08 - my-first-workflow - Finished action [Start] (result=[true])
2026/10/11 05:46:08 - my-first-workflow - Starting action [Dummy Action]
2026/10/11 05:46:08 - my-first-workflow - Finished action [Dummy Action] (result=[true])
2026/10/11 05:46:08 - my-first-workflow - Workflow execution finished
2026/10/11 05:46:08 - my-first-workflow - Workflow duration : 0.027 seconds [  0.027" ]

hop server --help

Usage: hop server [-ahV] [-gs] [-e=<environmentOption>] [-id=<id>]
                  [-j=<projectOption>] [-l=<level>] [-n=<serverName>]
                  [-p=<password>] [-ps=<pipelineName>] [-swt=<shutdownTimeout>]
                  [-u=<username>] [-ws=<workflowName>] [-s=<systemProperties>[,
                  <systemProperties>...]]... [<parameters>...]
Run a Hop server
  -a, --auth              Does the Hop web server have authentication enabled
  -e, --environment=<environmentOption>
                          The name of the lifecycle environment to use
  -g, --general-status    List the general status of the server
  -h, --help              Show this help message and exit.
      -id=<id>            Specify the ID of the pipeline or workflow to query
  -j, --project=<projectOption>
                          The name of the project to use
  -l, --level=<level>     The debug level, one of NOTHING, ERROR, MINIMAL,
                            BASIC, DETAILED, DEBUG, ROWLEVEL
  -n, --server-name=<serverName>
                          The name of the server to start as defined in the
                            metadata.
  -p, --password=<password>
                          The server password.  Required for administrative
                            operations only, not for starting the server.
      -ps, --pipeline-status=<pipelineName>
                          List the status of the pipeline with this name (also
                            specify the -id option)
  -s, --system-properties=<systemProperties>[,<systemProperties>...]
                          A comma separated list of KEY=VALUE pairs
      -swt, --shutdown-timeout=<shutdownTimeout>
  -u, --username=<username>
                          The username.  Required for administrative operations
                            only, not for starting the server.
      -ws, --workflow-status=<workflowName>
                          List the status of the workflow with this name

hop server

HopServer - Enabling project 'default'
HopServer - Two-way password encoder initialized with plugin ID 'Hop' for project 'default'
HopServer - Installing timer to purge stale objects after 1440 minutes.
HopServer - Hop Server: Basic authentication is ENABLED
HopServer - Created listener for webserver @ address : localhost:8080

Usage: hop conf [-hv] [-cdb] [-eap] [-ec] [-ed] [-el] [-em] [-exafs] [-exv]
                [-ey] [--git-gui-diff-ignore-position] [--git-gui-enabled]
                [--git-gui-search-parent-folders] [-oh] [-pc] [-pd] [-pkf]
                [-pl] [-pla] [-plm] [-plt] [-pm] [-pn] [-py] [-sat] [-sit]
                [-wd] [-we] [-aza=<account>] [-aze=<localEmulatorUrl>]
                [-azk=<key>] [-cfg=<configFile>]
                [-dc=<defaultProjectConfigFile>] [-de=<defaultEnvironment>]
                [-dp=<defaultProject>] [-dv=<describeVariable>]
                [-e=<environmentName>] [-ep=<environmentProject>]
                ...
Configure Hop
      -aza, --azure-account=<account>

hop encrypt --help

Usage: hop encrypt [-hV] [-hop] [-server]
Encrypt secrets
  -h, --help              Show this help message and exit.
      -hop, --hop         Generate an obfuscated or encrypted password
                            (depending on the configuration), for use in XML,
                            password or metadata files
      -server, --server   generate an obfuscated password to include in the
                            hop-server password file 'pwd/hop.pwd'
  -V, --version           Print version information and exit.

hop gui --help

Usage: hop gui [-hV]
The Hop GUI
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.