# Hop

## Hop

The `hop` command line tool is simplification of the many scripts that the project ships with like 'hop-run\`, `hop-search`, `hop-gui`, and so on. The main goal is to have a single wrapper script to make maintenance easier for the developers, but also to allow plugins to contribute new commands.

Usage

\== Usage

To see the usage of the `hop` tool, you can simply use the `help` command to see which commands are available:

```highlight
$ ./hop help
Usage: hop [-hV] [-s=<systemProperties>[,<systemProperties>...]]... [COMMAND]
  -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
  doc      Generate documentation
  encrypt  Encrypt secrets
  gui      The Hop GUI
  import   Import metadata
  run      Run a pipeline or workflow
  search   Search in Hop metadata
  server   Run a Hop server
```

\== Options

| Option | Description                                                                             |
| ------ | --------------------------------------------------------------------------------------- |
| -s     | One or more system parameters. These will be set prior to execution of a given command. |
| -h     | Displays this help message and quits                                                    |
| -V     | Show the current Hop version                                                            |

Last updated 2025-09-04 18:20:58 +0200


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.primeur.com/data-shaper-1.21/index-1/hop.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.