This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new 7b7eb2339405 chore: camel-jbang - document every setting in one table
(#27566)
7b7eb2339405 is described below
commit 7b7eb2339405a5ee2d992825b817822fb541e1aa
Author: Claus Ibsen <[email protected]>
AuthorDate: Thu Oct 8 15:16:29 2026 +0200
chore: camel-jbang - document every setting in one table (#27566)
The Settings page listed only some of the camel.tui.* keys. It now has one
table with the setting, key, description and default for every row of the
F2 Settings dialog, including Log Pin, Rate per, Validate on Save, Route
Tree, the proxy and the AI rows that were missing.
Signed-off-by: Claus Ibsen <[email protected]>
Co-authored-by: Claude Opus 5.5 (1M context) <[email protected]>
---
.../ROOT/pages/camel-jbang-tui-settings.adoc | 139 ++++++++++++++++-----
.../ROOT/pages/camel-jbang-tui-source-editor.adoc | 2 +-
2 files changed, 111 insertions(+), 30 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-settings.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-settings.adoc
index d81a407428d7..526f99653d19 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-settings.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-settings.adoc
@@ -34,7 +34,7 @@ Press *F2* to open the actions menu with quick access to
common operations:
| Reset Stats | Reset all statistics and metrics for the selected integration.
| Stop All | Stop running integrations and/or infrastructure services.
| Screen... | Take a screenshot (SVG, text, or ANSI art), record the session
as a `.tape` file, show keystrokes, or add a caption, for demos.
-| Settings... | Change the theme, the starting tab, and the default
run-from-folder.
+| Settings... | Change the TUI preferences: theme, tabs, panels, editor, proxy
and AI (see <<_settings,Settings>>).
| AI & MCP... | AI Prompt, Setup AI and AI Log (see
xref:camel-jbang-tui-ai.adoc[AI]), and MCP Info and MCP Log: the MCP server of
the session and the calls agents made to it. Called AI... when the MCP server
is off.
| Shell (F6) | Open the embedded Camel CLI shell.
| Quit | Quit the TUI, with the same confirmation as pressing *q*. The last
entry of the menu, so quitting is one menu away on tabs and in input fields
where *q* is taken by something else. Integrations started from the TUI keep
running after it quits (until the terminal closes); when some do, the
confirmation says how many, and *s* stops them and quits.
@@ -132,34 +132,115 @@ image::jbang/camel-tui-theme-latte.png[The Overview in
the Catppuccin Latte them
== Settings
-Open the *F2* actions menu and choose *Settings...* to change TUI preferences
in one place:
-
-* *Theme* -- cycle through 21 available themes (applied immediately on save).
-* *Starting Tab* -- the tab shown when the TUI launches; any tab (primary or
under *More*) can be
- chosen. Defaults to *Overview*.
-* *Select Tab* -- the tab to switch to when selecting an integration from the
Overview tab.
- Defaults to *Log*.
-* *Confirm* -- whether destructive actions (quit, stop, restart, stop/start
routes) show a
- confirmation dialog before executing. Defaults to *on*. Kill (*X*) always
confirms regardless
- of this setting.
-* *Default Folder* -- the folder pre-filled in *Run from Folder*. The most
recently used folder
- still takes precedence; this default is used only when there is no
remembered folder.
-* *Panel Position* -- where the shell (*F6*) and AI (*F8*) panels open:
*bottom* (default) or
- *top*.
-* *Panel Space* -- whether those panels push the tab content aside (*move*,
default) or are drawn
- on top of it (*overlay*), so the tab keeps its full height underneath.
-* *AI Overview* -- the xref:camel-jbang-tui-ai.adoc#_ai_project_overview[AI
project overview]: *manual* (default, only with
- `/overview`), *auto* (also when the AI panel opens and the project summary
is missing or out of
- date), or *off* (no `/overview`, and no AI-assisted descriptions in the
tabs).
-
-Use *↑*/*↓* to move between rows, *Space* (or *←*/*→*) to cycle the theme and
tab settings, type to
-edit the default folder, *Enter* to save, and *Esc* to cancel.
-
-Settings are stored under `camel.tui.*` keys (`camel.tui.theme`,
`camel.tui.startTab`,
-`camel.tui.selectTab`, `camel.tui.confirmActions`, `camel.tui.defaultFolder`,
-`camel.tui.panelPosition`, `camel.tui.panelSpace`,
-`camel.tui.shell.history`, `camel.tui.ai.provider`, `camel.tui.ai.model`,
`camel.tui.ai.url`,
-`camel.tui.ai.tools`, `camel.tui.ai.overview`, `camel.tui.ai.promptHistory`)
in the Camel CLI configuration file. Each key is read from and
+Open the *F2* actions menu and choose *Settings...* to change TUI preferences
in one place.
+Use *↑*/*↓* to move between rows, *Space* (or *←*/*→*) to cycle a choice, type
to edit a text
+field, *Enter* to save, and *Esc* to cancel.
+
+Each row is stored under a `camel.tui.*` key in the Camel CLI configuration
file, so the same
+setting can also be written there by hand:
+
+[cols="2,3,6,2",options="header"]
+|===
+| Setting | Key | Description | Default
+
+| Theme | `camel.tui.theme`
+| The color theme; cycle through the 21 <<_theme,themes>>. Applied immediately
on save.
+| `dark`
+
+| Starting Tab | `camel.tui.startTab`
+| The tab shown when the TUI launches. Any tab (primary or under *More*) can
be chosen.
+| Overview
+
+| Select Tab | `camel.tui.selectTab`
+| The tab to switch to when selecting an integration from the Overview tab.
+| Log
+
+| Log Pin | `camel.tui.logPin`
+| Pin the log at the bottom of the other tabs at startup, at `25`, `50` or
`75` percent of the
+ height, or `off`. *Ctrl+L* pins and resizes the log at runtime.
+| `off`
+
+| Rate per | `camel.tui.ratePer`
+| Show message rates per `seconds` or per `minutes`.
+| `seconds`
+
+| Panel Position | `camel.tui.panelPosition`
+| Where the shell (*F6*) and AI (*F8*) panels open: `bottom` or `top`.
+| `bottom`
+
+| Panel Space | `camel.tui.panelSpace`
+| Whether those panels push the tab content aside (`move`) or are drawn on top
of it (`overlay`),
+ so the tab keeps its full height underneath.
+| `move`
+
+| Confirm Actions | `camel.tui.confirmActions`
+| Whether destructive actions (quit, stop, restart, stop/start routes) show a
confirmation dialog
+ first. Kill (*X*) always confirms regardless of this setting.
+| `true`
+
+| Validate on Save | `camel.tui.validateOnSave`
+| Whether the xref:camel-jbang-tui-source-editor.adoc[source editor] checks a
file when it is saved
+ (a YAML or XML route, or a properties file, with problems is not saved; Java
problems are only reported).
+| `true`
+
+| Route Tree | `camel.tui.routeTree`
+| Whether the source editor shows the route tree when it opens (*Ctrl+T* shows
or hides it).
+| `false`
+
+| Default Folder | `camel.tui.defaultFolder`
+| The folder pre-filled in *Run from Folder*. The most recently used folder
still takes
+ precedence; this default is used only when there is no remembered folder.
+|
+
+| Proxy Host | `camel.tui.proxyHost`
+| HTTP proxy for the TUI's own lookups, such as the
+ xref:camel-jbang-tui-observe.adoc#_cve_audit[CVE Audit] queries to OSV.dev.
When empty, the JVM
+ default proxy settings are used.
+|
+
+| Proxy Port | `camel.tui.proxyPort`
+| Port of the proxy host.
+| `8080`
+
+| Shell History | `camel.tui.shell.history`
+| How many commands the embedded shell remembers (see <<_input_history,Input
history>>).
+| `100`
+
+| AI Provider | `camel.tui.ai.provider`
+| The xref:camel-jbang-tui-ai.adoc[AI panel] provider: `ollama`, `openai`,
`anthropic`, `gemini`,
+ `watsonx`, an xref:camel-jbang-tui-ai-agents.adoc[ACP coding agent]
(`acp:claude`, `acp:codex`,
+ `acp:bob`, `acp:qwen`, `acp:opencode`, `acp:dsh`, `acp:custom`), or `auto`
to detect one.
+| `auto`
+
+| AI Model | `camel.tui.ai.model`
+| The model to use. When empty, the provider's default is picked.
+|
+
+| AI Base URL | `camel.tui.ai.url`
+| The provider's base URL. When empty, the provider's default is used.
+|
+
+| AI Tools | `camel.tui.ai.tools`
+| Which tools are sent to the model: `core` (troubleshooting only), `full`
(all tools), or
+ `auto` (core for a local model, full otherwise).
+| `auto`
+
+| AI Overview | `camel.tui.ai.overview`
+| The xref:camel-jbang-tui-ai.adoc#_ai_project_overview[AI project overview]:
`manual` (only with
+ `/overview`), `auto` (also when the AI panel opens and the project summary
is missing or out of
+ date), or `off` (no `/overview`, and no AI-assisted descriptions in the
tabs).
+| `manual`
+
+| AI History | `camel.tui.ai.promptHistory`
+| How many AI prompts are remembered (see <<_input_history,Input history>>).
+| `100`
+
+| ACP Command | `camel.tui.ai.acp.command`
+| The command line that starts the coding agent when the provider is
`acp:custom`.
+|
+|===
+
+Each key is read from and
written back to the file where it currently lives: a key present in the local
`./camel-cli.properties` is treated as a project-level override and stays
local, while every
other key defaults to the global `~/.camel-cli.properties`. This means a
project can
diff --git
a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-source-editor.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-source-editor.adoc
index 413520965549..a3e82c2fcede 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-source-editor.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-source-editor.adoc
@@ -83,7 +83,7 @@ image::jbang/camel-tui-source-save-blocked.png[A YAML file
with a problem is not
A Java file is saved anyway and its problems are reported: it is the
application's code, and a check cannot know
everything a Java route computes at runtime.
-The checks can be turned off in the Settings (*F2* > Settings).
+The checks can be turned off in the Settings (*F2* > Settings > *Validate on
Save*, or `camel.tui.validateOnSave=false`).
== Quick Fixes
