Configuration Perspective

Enable the AI Assistant

When disabled, the AI Assistant does not open and sends no prompts; saved conversations stay readable in its perspective. Default is off. Before applying AI changes, work on a Git feature branch so you can revert the project if needed.

false

Default AI provider

Named AI Provider metadata used by the AI Assistant. Pipelines can still pick a different provider. Accepts variables.

Allow sending full XML

Second gate for the session "Include full XML" checkbox. Off by default. Full XML is large and can contain SQL, filenames and notes. Leave this off unless you need it, and only after secrets live in environment variables or a keystore.

false

Keep conversations after Hop GUI closes

Saves the AI Assistant sessions of each project as plain text (questions, answers, proposals and options, not the context that was sent) in the audit folder, ${HOP_AUDIT_FOLDER}, next to the other things Hop GUI remembers per project. That folder is on your machine and outside the project, so the conversations do not end up in version control. Uncheck to start every Hop GUI session without conversations.

true

When a window closes during a question

What happens to a question that is still waiting for its answer when you close the AI Assistant window or dock. Finish in the background records the answer in the session, so you find it when you open the session again. Cancel stops waiting, as Stop does, and no answer is recorded. Exiting Hop GUI always stops a question that is still waiting.

Finish in the background

Extra context

Standing notes sent with every AI Assistant question, such as project conventions. Empty by default: the notes that come with the AI plugin already say that metadata names are case-sensitive, that pipeline and workflow run configurations are different types, and that Hop is not Kettle. Accepts variables.

Context files

One VFS path per line. Files that exist are appended to the system prompt as instructions the assistant follows; missing files are skipped. Variables are resolved. Empty by default. Only list files you wrote for the AI Assistant, for example ${PROJECT_HOME}/ai-assistant.md: an AGENTS.md is usually written for coding agents, and a file from someone else's project can steer the assistant. Accepts variables.

Indentation (spaces)

Number of spaces to indent nested SQL. Calcite default is 4; Hop default is 2.

2

Line length

Preferred maximum line length. 0 means no maximum.

0

Clause starts a new line

Start FROM, WHERE, GROUP BY, HAVING, WINDOW and ORDER BY on a new line.

true

Clause is followed by a new line

Clause (FROM, WHERE, GROUP BY, HAVING, WINDOW, ORDER BY) is followed by a new line

false

Always use parentheses

Wrap every expression in parentheses even when operator precedence does not require it.

false

Leading comma

Commas in SELECT, GROUP BY and ORDER clauses should appear at the start of the line.

false

SELECT items on separate lines

Put each item in the SELECT list on its own line.

true

FROM items on separate lines

Put each item in the FROM list on its own line.

true

WHERE items on separate lines

Put each item in the WHERE list on its own line.

true

GROUP BY items on separate lines

Put each item in a GROUP BY list on its own line.

true

ORDER BY items on separate lines

Put each item in an ORDER BY list on its own line.

true

CASE clauses on new lines

Put WHEN, THEN and ELSE of a CASE expression at the start of a new line.

true

WINDOW declaration starts a new line

Start a WINDOW declaration on a new line.

true

WINDOW items on separate lines

Put each item in a WINDOW list on its own line.

true

Keywords in lower case

Print SQL keywords such as SELECT and FROM in lower case.

false

Quote all identifiers

Quote every identifier even when the dialect would accept it unquoted.

false

Automatically connect when executing SQL

Connect the SQL editors database without asking if it is not already connected. You can also enable this from the dialog that appears when the option is off.

false

Select the executed SQL in the editor

After Run or Run all, highlight only the statement(s) that were sent to the database. A leftover clause after a semicolon is left unselected.

true

Query row limit

Maximum number of rows shown for a SELECT in the SQL editor and for table preview. A SQL LIMIT above this value is still capped here so a SELECT * does not pull the whole table.

1000

Access token

The Dropbox access token used to authenticate. Generate one for an app in the Dropbox App Console; it grants whatever access that app was given. Accepts variables.

The initial depth to load not lazily

The initial depth to load not lazily. Accepts variables.

0

The maximum file size to load

The maximum file size to load. Accepts variables.

16

Show file explorer panel by default

When enabled, the file explorer panel (project tree) is shown by default when opening the explorer perspective

true

Open help pages in

Choose where documentation opens: the system browser, a tab in the File Explorer perspective, or a dialog on top of the current window.

External browser

Select active file in tree automatically

Automatically select the active tab file in the file explorer tree on the left hand side when it is shown in a tab.

true

Maximum undo operations

The maximum number of undo/redo snapshots kept for pipelines, workflows and table editors. Default is 100. Accepts variables.

100

Validate database connections when saving

When saving a pipeline or workflow, warn if a transform or action references a database connection that is not in the project metadata. Names that still contain a variable such as ${CONNECTION} after resolving the current environment are skipped. Saving is never blocked.

true

Fast formula evaluation

Evaluate the formulas that only use the supported functions and operators without Apache POI, which is many times faster. Formulas using anything else are always evaluated with Apache POI. Clear this to evaluate every formula with Apache POI. A pipeline can also switch it off with the variable HOP_FORMULA_FAST_PATH_ENABLED set to N.

true

Enable the git GUI plugin

Switches the git plugin on or off. With it off the git perspective and the git decorations in the file explorer are hidden, and no repository is opened.

true

Search parent folders for git repository

Look in parent folders for the git repository rather than only in the project folder. Needed where the project sits in a subfolder of a larger repository.

false

Fetch remote changes automatically

Enables background fetching of remote updates every 20 minutes.

false

Ignore position in the visual diff

Do not mark a transform or action as changed when it was only moved.

true

Account key file

The path to a Google Cloud service account JSON key file. Accepts variables.

Scan folders to find last modified data

Scans all files in a folder and uses the most recent modification data as the folder modification data. This may have a performance impact in buckets with lots of files.

false

Max number of attempts

Maximum number of attempts for a single request, including the first one. Accepts variables.

6

Initial retry delay (seconds)

Delay before the first retry, in seconds. Accepts variables.

1

Retry delay multiplier

Retry delay multiplier. Accepts variables.

2.0

Maximum retry delay (seconds)

Ceiling for the retry delay once the multiplier has been applied, in seconds. Accepts variables.

32

Total timeout (minutes)

Deadline for a request including all of its retries, in minutes. Accepts variables.

50

Initial RPC timeout (seconds)

Timeout for the first attempt, in seconds. Raised to the max RPC timeout if that is lower. Accepts variables.

50

RPC Timeout Multiplier

RPC Timeout Multiplier. Accepts variables.

1.0

Max RPC timeout (seconds)

Ceiling for a single attempt timeout, in seconds. Never lower than the initial RPC timeout. Accepts variables.

50

Connect timeout (seconds)

Socket connect timeout, in seconds. Accepts variables.

20

Read timeout (seconds)

Socket read timeout, in seconds. Accepts variables.

20

Retry non-idempotent operations

Also retry writes (create, delete, starting an upload). Google Cloud Storage only retries reads by default, so without this the retry settings above do not apply to writing files. Note that a retried delete can report "not found" when the first attempt already succeeded, and a retried create overwrites.

false

Cache TTL (seconds)

How long to cache folder listing results (in seconds, default 5). If not set, falls back to 10 seconds. Accepts variables.

5

Read block size

How many bytes one download request fetches when a file is read, like 8MB. Leave empty for 8MB. Transforms that fetch ahead, such as Text File Input, download blocks of this size, several at a time, each with one request. Accepts variables.

Path to a Google Drive credentials JSON file

Please note that this is a global configuration option and while you can specify variables that these will be not include project specific settings. Accepts variables.

Path to a tokens folder for credential caching

Pick a safe folder to store these tokens. Accepts variables.

Enable Linter

Enable or disable the Hop Linter globally

true

Lint Automatically While Editing

Re-run lint checks shortly after you change an open pipeline or workflow. When disabled, files are only linted on open, save, or on demand.

true

Include Lint Rules in Pipeline Verify

Add YAML/custom lint findings to the native pipeline verify Problems tab

true

Include Lint Rules in Workflow Verify

Add YAML/custom lint findings to the native workflow verify Problems tab

true

Include Hop Native Checks in Lint Runs

Also run Hops built-in pipeline/workflow verify checks during lint project/file scans

true

Show Lint Indicators on Canvas

Show the lint totals overlay (top-left of the canvas) and the severity badges on transforms/actions in open pipeline and workflow editors

true

Mark Ignored Transforms and Actions

Draw a dashed outline and a small badge on a transform or action whose lint findings have been marked as expected, so the absence of a warning reads as a decision rather than as a check that never ran

true

Configuration File

Path to hop-lint.yml configuration file (leave empty for project-specific). Accepts variables.

Block Git Commits on Lint Failures

When enabled, lint checks run before Explorer git commits and block the commit if issues are found

false

Block Commits on Warnings

When enabled, warnings also block commits. When disabled, only errors block commits

false

Include Metadata in Pre-Commit Checks

Also lint staged metadata files (e.g. metadata/**/*.json) during pre-commit checks

true

Account

The account to use for the Azure VFS. Accepts variables.

Account key

The key to use for the Azure VFS. Accepts variables.

Alternative Local Storage

URL of Azure emulator/local storage. Accepts variables.

Enable the projects plugin

Switches the projects plugin on or off. With it off, Hop GUI drops the project and environment selectors and files are addressed by path alone.

true

Use of a project is mandatory

Refuse to run a pipeline or workflow unless a project is selected. Catches runs against the wrong configuration on a shared installation.

false

Use of an environment is mandatory

Refuse to run a pipeline or workflow unless a lifecycle environment is selected, so every run has explicit environment variables behind it.

false

The default project to use when none is specified

The default project to use when none is specified. Accepts variables.

The default environment to use when none is specified

The name of the default environment to use when none is specified. Accepts variables.

The parent project to propose when creating projects

The project proposed as the parent when a new project is created. A child project inherits its parent's variables and configuration. Accepts variables.

The standard projects folder for new projects

The standard projects folder for new projects. Accepts variables.

The project configuration filename for new projects

The name given to the configuration file of a newly created project, relative to the project folder. Accepts variables.

project-config.json

Clear DB cache when switching project/environment

Empty the database cache when switching project or environment. Keep this on where environments point at different databases that share connection names, so metadata cached for the previous one is not reused.

true

Sort the last used projects alphabetically

List the last used projects alphabetically rather than most recently used first.

false

Minimum characters for content search

Object names are always searched. File and field content is only searched when the query has at least this many characters (default 3). Prevents floods of hits while typing. Accepts variables.

3

Maximum search results

Hard limit on the number of results built for Hop GUI search (default 500). Further matches are not collected so the UI stays responsive. Accepts variables.

500

Maximum matches per text file

Stop scanning a single text file after this many matching lines (default 20). Accepts variables.

20

Maximum text file size for search (MB)

Text files larger than this are skipped for content search (default 1 MB). Use dedicated tools for million-row CSV/JSON files. Accepts variables.

1

Include project text files in content search

When enabled, CSV, JSON, SQL and other project text files are content-searched (subject to size and match limits). Open text files are always eligible. Disable to search only pipelines, workflows, metadata and open files.

true

Search as you type

When enabled, search runs automatically after a short pause while typing. Press Enter to search immediately either way.

true

Search-as-you-type delay (ms)

Milliseconds to wait after the last keystroke before running a live search (default 300). Accepts variables.

300

Show welcome dialog at the startup of the Hop GUI

Show the welcome dialog when Hop GUI starts. The dialog has a Don't show this at startup option of its own that sets the same thing, and the ${HOP_NO_WELCOME_DIALOG} variable suppresses it whatever is set here.

true