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 5675d9b80a1e chore: camel-jbang - docs page for screenshots and demo
recordings (#27664)
5675d9b80a1e is described below
commit 5675d9b80a1ebd9002723a0c2aefc4c16da402db
Author: Claus Ibsen <[email protected]>
AuthorDate: Sat Oct 10 16:40:06 2026 +0200
chore: camel-jbang - docs page for screenshots and demo recordings (#27664)
Signed-off-by: Claus Ibsen <[email protected]>
Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
---
docs/user-manual/modules/ROOT/nav.adoc | 1 +
.../ROOT/pages/camel-jbang-tui-ai-agents.adoc | 2 +-
.../ROOT/pages/camel-jbang-tui-recording.adoc | 240 +++++++++++++++++++++
.../ROOT/pages/camel-jbang-tui-settings.adoc | 193 +----------------
.../modules/ROOT/pages/camel-jbang-tui.adoc | 11 +-
5 files changed, 254 insertions(+), 193 deletions(-)
diff --git a/docs/user-manual/modules/ROOT/nav.adoc
b/docs/user-manual/modules/ROOT/nav.adoc
index adf612736113..43aea8e36e04 100644
--- a/docs/user-manual/modules/ROOT/nav.adoc
+++ b/docs/user-manual/modules/ROOT/nav.adoc
@@ -35,6 +35,7 @@
**** xref:camel-jbang-tui-local-models.adoc[Camel TUI Local Models]
**** xref:camel-jbang-tui-ai-agents.adoc[Camel TUI and AI Agents]
**** xref:camel-jbang-tui-settings.adoc[Camel TUI Actions, Settings and Themes]
+**** xref:camel-jbang-tui-recording.adoc[Camel TUI Screenshots and Demo
Recordings]
*** xref:camel-jbang-mcp.adoc[Camel MCP Server]
*** xref:camel-jbang-configuration.adoc[Configuration]
*** xref:camel-jbang-tips.adoc[Tips and Recipes]
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-ai-agents.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-ai-agents.adoc
index 8e95e6e420f7..f599e0bf20c6 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-ai-agents.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-ai-agents.adoc
@@ -184,7 +184,7 @@ by purpose:
arrows, underlines, text labels), show captions with typewriter animation
* *Present* -- take screenshots, record tape sessions, control demo pacing. To
record a demo as a GIF,
an agent can also write a `.tape` file using the same commands and play it
with `camel tui --record`, see
- xref:camel-jbang-tui-settings.adoc#_scripted_recording[Scripted Recording]
+ xref:camel-jbang-tui-recording.adoc#_scripted_recording[Scripted Recording]
== Editing source files from an AI agent
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-recording.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-recording.adoc
new file mode 100644
index 000000000000..39cd6942897a
--- /dev/null
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui-recording.adoc
@@ -0,0 +1,240 @@
+= Camel TUI Screenshots and Demo Recordings
+
+The TUI can show itself: take a screenshot of the screen, explain it with
captions while you present, and record a
+session as an animated GIF for documentation, a blog post or a pull request. A
recording is scripted as a `.tape`
+file that the TUI plays, so it is repeatable, and an AI agent can write and
run it as well as you can.
+
+See xref:camel-jbang-tui.adoc[Camel TUI] for getting started and the other
pages.
+
+== Key Features
+
+* <<_screenshots,*Screenshots*>> -- save the screen as SVG, plain text and
ANSI art
+* <<_presenting,*Presenting*>> -- captions, highlights and the keys you press,
on the screen
+* <<_live_recording,*Live recording*>> -- record what you do as a `.tape` file
+* <<_scripted_recording,*Scripted recording*>> -- play a `.tape` in the TUI
and record it, with commands for
+ captions, highlights and tabs
+* <<_converting_to_gif,*Converting to GIF*>> -- turn the recording into an
animated GIF
+
+== Screenshots
+
+Press *Shift+F5*, or open the *F2* actions menu and choose *Take Screenshot*.
The screen is saved in the current
+directory in three formats, named `camel-tui-screenshot-<timestamp>`:
+
+[cols="1,4",options="header"]
+|===
+| File | Use it for
+
+| `.svg`
+| Documentation and web pages: the screen with its colors and fonts, sharp at
any size. Convert it to PNG with a
+browser or a tool such as `rsvg-convert` where SVG is not accepted.
+
+| `.txt`
+| Plain text, for an issue, a chat or an AI agent to read.
+
+| `.ans`
+| The text with its colors as ANSI escape codes, which `cat` shows in a
terminal.
+|===
+
+A message at the bottom of the screen names the saved file. A tape takes a
screenshot with the `Screenshot`
+command, and an AI agent with the `tui_action` tool (`screenshot`).
+
+== Presenting
+
+The *F2* actions menu has what helps when you show the TUI to others, in a
meeting or a screen share:
+
+* *Caption...* -- shows a message in the middle of the screen with a
typewriter animation, to say what comes next
+* *Show Keystrokes* -- shows each key you press at the bottom of the screen,
so viewers can follow along
+* *Settings...* -- switches the theme, such as a light theme for a projector
+
+An AI agent connected over MCP can present too: it shows captions
(`tui_show_caption`), highlights what it talks
+about (`tui_locate` and `tui_draw_shape`), and switches tabs (`tui_navigate`).
See
+xref:camel-jbang-tui-ai-agents.adoc[Camel TUI and AI Agents].
+
+== Live Recording
+
+Use the *F2* actions menu and select *Start Tape Recording* to start recording
your session
+as a `.tape` file. Select *Stop Tape Recording* to stop. The tape captures
your keystrokes
+with timing, producing a script that can be played back with `--record` (see
below), edited,
+or converted to an animated GIF.
+
+An AI agent connected over MCP records a tape of what it does with
`tui_tape_start` and `tui_tape_stop`.
+
+== Scripted Recording
+
+Use the `--record` flag to play a `.tape` file in the TUI and record what
happens on screen:
+
+[source,bash]
+----
+camel tui orders --record=demo.tape
+----
+
+The `.cast` file is written next to the tape, with the `.tape` suffix replaced
by `.cast`.
+Recording is headless: the TUI is driven entirely by the tape rather than by
your terminal,
+so no keyboard input is read and nothing is drawn on screen. The integrations
are the ones
+running on your machine, as with a plain `camel tui`, so start them before
recording, and
+name the integration to select it from the start (`orders` above).
+
+The tape is played by the TUI itself: the keys go to the TUI as if typed, and
on top of the
+VHS commands there are commands for the TUI, such as showing a caption,
highlighting text on the
+screen, or switching tab by name. When the tape ends, the TUI quits and the
recording is saved.
+Problems in the tape, such as an unknown command or a `Wait` that timed out,
are printed as
+`Tape: ...` warnings, and the rest of the tape still plays.
+
+The recorded terminal is 200x50 by default, which is wider than a
documentation page can
+display. Use `--record-size` to record at a size that fits, and `--record-fps`
or
+`--record-duration` to control the capture rate and the cut-off:
+
+[source,bash]
+----
+camel tui orders --record=demo.tape --record-size=120x32
--record-duration=60000
+----
+
+`--record-duration` is in milliseconds and stops the recording even when the
tape is still
+playing, so give a long tape enough time.
+
+`--record` cannot be combined with `--web`. Recording drives a headless TUI
from the tape, and
+the recording configuration applies to the whole process, so every browser
session would be
+recorded into the same `.cast` file. Camel rejects the combination with an
error instead.
+
+=== Tape commands
+
+A tape has one command per line. Lines starting with `#` are comments.
Durations are written
+as `500ms`, `2s` or `1.5s`; a bare number is seconds. Text is in double
quotes, where `\n` is
+a new line and `\"` a quote. Most commands take a timing as `Command@duration`.
+
+[cols="2,5",options="header"]
+|===
+| Command | Description
+
+| `Enter`, `Tab`, `Escape`, `Backspace`, `Delete`, `Insert`, `Space`, `Up`,
`Down`, `Left`, `Right`, `Home`, `End`, `PageUp`, `PageDown`, `F1` .. `F12`
+| Presses the key. A count repeats it (`Down 3`), and `@` sets the gap between
the presses
+(`Down@300ms 3`, default 50ms).
+
+| `Ctrl+<key>`, `Alt+<key>`, `Shift+<key>`
+| Presses the key with the modifiers, which can be combined (`Ctrl+Shift+Up`).
The key is a
+key name or a single character: `Ctrl+t`, `Shift+F8`, `Shift+Tab`.
+
+| `Type "text"`
+| Types the text, one character at a time, 50ms apart. `Type@100ms "text"`
types slower.
+A `\n` in the text presses *Enter*, and `\t` presses *Tab*. A single letter
+key such as `q` is typed with `Type "q"`.
+
+| `Sleep <duration>`
+| Pauses the tape, so the viewer can read the screen.
+
+| `Wait /regex/`
+| Waits until a line on the screen matches the regular expression, up to 15
seconds
+(`Wait@30s /orders/` waits longer). `Wait+Screen /regex/` matches the whole
screen, with the
+lines separated by new lines, instead of each line. Use a `Wait` after a key
that starts something
+slow, rather than guessing a `Sleep`.
+
+| `Screenshot`
+| Saves a screenshot of the screen, as the *F2* actions menu does.
+
+| `Source other.tape`
+| Plays the commands of another tape, relative to this one. Useful for a
common opening.
+
+| `Caption "text"`
+| Shows a caption on the screen with a typewriter animation, which stays until
a key is pressed.
+`Caption@4s "text"` closes it after 4 seconds, and then keys go to the TUI
while it shows.
+Use `\n` to break lines.
+
+| `Highlight "text"`
+| Highlights the first place on the screen showing the text, such as a key in
the footer or a
+node in the diagram. `Highlight@3s "text"` removes it after 3 seconds. Several
highlights can be on
+the screen at the same time.
+
+| `ClearDrawing`
+| Removes the highlights.
+
+| `Tab "name"`
+| Switches to the tab, such as `Tab "Log"` or `Tab "Diagram"`, without
pressing its number key.
+`Tab` alone, or with a count such as `Tab 2`, presses the *Tab* key.
+
+| `Integration "name"`
+| Selects the integration by its name or PID.
+
+| `Action "name"`
+| Runs an entry of the *F2* actions menu by its name, such as
`show-keystrokes`, `reset-stats`
+or `next-theme`, or by its menu label.
+
+| `Theme "name"`
+| Switches the theme, such as `Theme "dracula"`.
+|===
+
+The `Set`, `Output` and `Require` commands of VHS are skipped: the recording
takes its size and
+file from the `--record` options. `Hide` and `Show` are not supported, as
everything the TUI
+shows is recorded.
+
+=== Writing a tape
+
+The tape below opens the Diagram tab of the `orders` integration, explains the
screen with
+captions and a highlight, and asks the AI panel a question. Every step that
depends on the TUI
+being ready waits for it on the screen first, so the tape plays the same on a
slow machine:
+
+[source,text]
+----
+# wait for the integration to be discovered
+Wait@30s /orders/
+Caption@3s "The Camel TUI tape player"
+Sleep 3s
+
+Tab "Diagram"
+Wait /Topology/
+Sleep 1s
+Highlight@3s "orders"
+Caption@3s "Highlight finds text on the screen"
+Sleep 3s
+
+# the AI panel
+F8
+Wait /Ask a question/
+Type@80ms "hello"
+Sleep 1500ms
+F8
+Sleep 1s
+----
+
+Recorded with `camel tui orders --record=demo.tape --record-size=120x32` and
converted with `agg`, it plays as:
+
+image::jbang/camel-tui-tape-player.gif[The example tape played: captions, a
highlight on the Diagram tab, and a question typed in the AI panel]
+
+A few tips for a tape that reads well:
+
+* Start with a `Wait` for something the first screen shows, as the TUI needs a
moment to find the
+ running integrations.
+* After each `Caption@<n>s`, `Sleep` for as long, or the next keys play while
the caption is still
+ being typed.
+* Pair a `Highlight` with a `Caption` that says what the viewer looks at, and
highlight a key
+ in the footer before pressing it, such as `Highlight@2s "Shift+F8"` followed
by `Shift+F8`.
+* Use `Action "show-keystrokes"` at the start to show each key press at the
bottom of the screen.
+* Record at the size the page shows, such as `--record-size=120x32`, so text
is not scaled down.
+
+TIP: Give each demo its own theme, so the GIFs on a page do not all look the
same. `--theme` sets the
+theme for that run only and leaves your saved theme as it is, as in
+`camel tui orders --theme=tokyo-night --record=demo.tape`, and a `Theme
"nord"` line in the tape switches
+it during the recording. Light themes such as `catppuccin-latte` stand out
between dark ones. See
+xref:camel-jbang-tui-settings.adoc#_theme[Theme] for the list.
+
+TIP: An AI agent can write and run the tape itself: the commands for the TUI
are the same as the
+xref:camel-jbang-tui-ai-agents.adoc[MCP tools] of the TUI (`tui_show_caption`,
`tui_locate` with
+`tui_draw_shape`, `tui_navigate`, `tui_action` and `tui_set_theme`), and
`tui_get_screen` tells what
+text to `Wait` for. Run the tape, read the `Tape:` warnings, fix the tape, and
run it again.
+
+== Converting to GIF
+
+Convert the `.cast` recording with https://github.com/asciinema/agg[agg]:
+
+[source,bash]
+----
+agg demo.cast demo.gif
+agg --speed 1.5 --font-size 14 --last-frame-duration 3 demo.cast demo.gif
+----
+
+The `--speed` option plays the recording faster, and `--idle-time-limit` caps
every pause at that many
+seconds (5 by default), so raise it when a pause is there for the viewer to
read a caption.
+
+A tape that only uses VHS commands can also be turned into a GIF with
+https://github.com/charmbracelet/vhs[VHS] directly (`vhs demo.tape`), which
runs the TUI in a
+terminal of its own. The commands for the TUI, such as `Caption`, `Highlight`
and `Tab`, work
+with `--record` only.
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 d97bfa93f559..cdb90df1c9db 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
@@ -1,8 +1,8 @@
= Camel TUI Actions, Settings and Themes
The TUI is configured from inside: the actions menu (*F2*) holds what is not
tied to one tab, the settings are kept in
-`~/.camel-cli.properties`, and the themes change the whole look. This page
also covers the embedded shell, opening the
-TUI in a browser, and recording demos.
+`~/.camel-cli.properties`, and the themes change the whole look. This page
also covers the embedded shell and opening the
+TUI in a browser.
See xref:camel-jbang-tui.adoc[Camel TUI] for getting started and the other
pages.
@@ -13,7 +13,7 @@ See xref:camel-jbang-tui.adoc[Camel TUI] for getting started
and the other pages
* <<_theme,*Themes*>> -- dark and light themes
* <<_settings,*Settings*>> -- start tab, rate units, validation, AI provider
and more
* <<_web_browser_access,*Web browser access*>> -- the TUI in a browser tab
-* <<_recording_demos,*Recording demos*>> -- record a session as a tape and
convert it to a GIF
+* xref:camel-jbang-tui-recording.adoc[*Screenshots and demo recordings*] --
take screenshots, and record a session as a tape and convert it to a GIF
== Actions Menu (F2)
@@ -284,188 +284,5 @@ same as if you'd run `camel tui` again in a new terminal.
== Recording Demos
-The TUI can record its sessions for demos and documentation. A session is
scripted as a `.tape`
-file, in the format of https://github.com/charmbracelet/vhs[VHS], which the
TUI plays and records
-to an https://asciinema.org/[Asciinema] `.cast` file. The `.cast` file then
converts to an
-animated GIF.
-
-=== Live Recording
-
-Use the *F2* actions menu and select *Start Tape Recording* to start recording
your session
-as a `.tape` file. Select *Stop Tape Recording* to stop. The tape captures
your keystrokes
-with timing, producing a script that can be played back with `--record` (see
below), edited,
-or converted to an animated GIF.
-
-=== Scripted Recording
-
-Use the `--record` flag to play a `.tape` file in the TUI and record what
happens on screen:
-
-[source,bash]
-----
-camel tui orders --record=demo.tape
-----
-
-The `.cast` file is written next to the tape, with the `.tape` suffix replaced
by `.cast`.
-Recording is headless: the TUI is driven entirely by the tape rather than by
your terminal,
-so no keyboard input is read and nothing is drawn on screen. The integrations
are the ones
-running on your machine, as with a plain `camel tui`, so start them before
recording, and
-name the integration to select it from the start (`orders` above).
-
-The tape is played by the TUI itself: the keys go to the TUI as if typed, and
on top of the
-VHS commands there are commands for the TUI, such as showing a caption,
highlighting text on the
-screen, or switching tab by name. When the tape ends, the TUI quits and the
recording is saved.
-Problems in the tape, such as an unknown command or a `Wait` that timed out,
are printed as
-`Tape: ...` warnings, and the rest of the tape still plays.
-
-The recorded terminal is 200x50 by default, which is wider than a
documentation page can
-display. Use `--record-size` to record at a size that fits, and `--record-fps`
or
-`--record-duration` to control the capture rate and the cut-off:
-
-[source,bash]
-----
-camel tui orders --record=demo.tape --record-size=120x32
--record-duration=60000
-----
-
-`--record-duration` is in milliseconds and stops the recording even when the
tape is still
-playing, so give a long tape enough time.
-
-`--record` cannot be combined with `--web`. Recording drives a headless TUI
from the tape, and
-the recording configuration applies to the whole process, so every browser
session would be
-recorded into the same `.cast` file. Camel rejects the combination with an
error instead.
-
-==== Tape commands
-
-A tape has one command per line. Lines starting with `#` are comments.
Durations are written
-as `500ms`, `2s` or `1.5s`; a bare number is seconds. Text is in double
quotes, where `\n` is
-a new line and `\"` a quote. Most commands take a timing as `Command@duration`.
-
-[cols="2,5",options="header"]
-|===
-| Command | Description
-
-| `Enter`, `Tab`, `Escape`, `Backspace`, `Delete`, `Insert`, `Space`, `Up`,
`Down`, `Left`, `Right`, `Home`, `End`, `PageUp`, `PageDown`, `F1` .. `F12`
-| Presses the key. A count repeats it (`Down 3`), and `@` sets the gap between
the presses
-(`Down@300ms 3`, default 50ms).
-
-| `Ctrl+<key>`, `Alt+<key>`, `Shift+<key>`
-| Presses the key with the modifiers, which can be combined (`Ctrl+Shift+Up`).
The key is a
-key name or a single character: `Ctrl+t`, `Shift+F8`, `Shift+Tab`.
-
-| `Type "text"`
-| Types the text, one character at a time, 50ms apart. `Type@100ms "text"`
types slower.
-A `\n` in the text presses *Enter*, and `\t` presses *Tab*. A single letter
-key such as `q` is typed with `Type "q"`.
-
-| `Sleep <duration>`
-| Pauses the tape, so the viewer can read the screen.
-
-| `Wait /regex/`
-| Waits until a line on the screen matches the regular expression, up to 15
seconds
-(`Wait@30s /orders/` waits longer). `Wait+Screen /regex/` matches the whole
screen, with the
-lines separated by new lines, instead of each line. Use a `Wait` after a key
that starts something
-slow, rather than guessing a `Sleep`.
-
-| `Screenshot`
-| Saves a screenshot of the screen, as the *F2* actions menu does.
-
-| `Source other.tape`
-| Plays the commands of another tape, relative to this one. Useful for a
common opening.
-
-| `Caption "text"`
-| Shows a caption on the screen with a typewriter animation, which stays until
a key is pressed.
-`Caption@4s "text"` closes it after 4 seconds, and then keys go to the TUI
while it shows.
-Use `\n` to break lines.
-
-| `Highlight "text"`
-| Highlights the first place on the screen showing the text, such as a key in
the footer or a
-node in the diagram. `Highlight@3s "text"` removes it after 3 seconds. Several
highlights can be on
-the screen at the same time.
-
-| `ClearDrawing`
-| Removes the highlights.
-
-| `Tab "name"`
-| Switches to the tab, such as `Tab "Log"` or `Tab "Diagram"`, without
pressing its number key.
-`Tab` alone, or with a count such as `Tab 2`, presses the *Tab* key.
-
-| `Integration "name"`
-| Selects the integration by its name or PID.
-
-| `Action "name"`
-| Runs an entry of the *F2* actions menu by its name, such as
`show-keystrokes`, `reset-stats`
-or `next-theme`, or by its menu label.
-
-| `Theme "name"`
-| Switches the theme, such as `Theme "dracula"`.
-|===
-
-The `Set`, `Output` and `Require` commands of VHS are skipped: the recording
takes its size and
-file from the `--record` options. `Hide` and `Show` are not supported, as
everything the TUI
-shows is recorded.
-
-==== Writing a tape
-
-The tape below opens the Diagram tab of the `orders` integration, explains the
screen with
-captions and a highlight, and asks the AI panel a question. Every step that
depends on the TUI
-being ready waits for it on the screen first, so the tape plays the same on a
slow machine:
-
-[source,text]
-----
-# wait for the integration to be discovered
-Wait@30s /orders/
-Caption@3s "The Camel TUI tape player"
-Sleep 3s
-
-Tab "Diagram"
-Wait /Topology/
-Sleep 1s
-Highlight@3s "orders"
-Caption@3s "Highlight finds text on the screen"
-Sleep 3s
-
-# the AI panel
-F8
-Wait /Ask a question/
-Type@80ms "hello"
-Sleep 1500ms
-F8
-Sleep 1s
-----
-
-Recorded with `camel tui orders --record=demo.tape --record-size=120x32` and
converted with `agg`, it plays as:
-
-image::jbang/camel-tui-tape-player.gif[The example tape played: captions, a
highlight on the Diagram tab, and a question typed in the AI panel]
-
-A few tips for a tape that reads well:
-
-* Start with a `Wait` for something the first screen shows, as the TUI needs a
moment to find the
- running integrations.
-* After each `Caption@<n>s`, `Sleep` for as long, or the next keys play while
the caption is still
- being typed.
-* Pair a `Highlight` with a `Caption` that says what the viewer looks at, and
highlight a key
- in the footer before pressing it, such as `Highlight@2s "Shift+F8"` followed
by `Shift+F8`.
-* Use `Action "show-keystrokes"` at the start to show each key press at the
bottom of the screen.
-* Record at the size the page shows, such as `--record-size=120x32`, so text
is not scaled down.
-
-TIP: An AI agent can write and run the tape itself: the commands for the TUI
are the same as the
-xref:camel-jbang-tui-ai-agents.adoc[MCP tools] of the TUI (`tui_show_caption`,
`tui_locate` with
-`tui_draw_shape`, `tui_navigate`, `tui_action` and `tui_set_theme`), and
`tui_get_screen` tells what
-text to `Wait` for. Run the tape, read the `Tape:` warnings, fix the tape, and
run it again.
-
-=== Converting to GIF
-
-Convert the `.cast` recording with https://github.com/asciinema/agg[agg]:
-
-[source,bash]
-----
-agg demo.cast demo.gif
-agg --speed 1.5 --font-size 14 --last-frame-duration 3 demo.cast demo.gif
-----
-
-The `--speed` option plays the recording faster, and `--idle-time-limit` caps
every pause at that many
-seconds (5 by default), so raise it when a pause is there for the viewer to
read a caption.
-
-A tape that only uses VHS commands can also be turned into a GIF with
-https://github.com/charmbracelet/vhs[VHS] directly (`vhs demo.tape`), which
runs the TUI in a
-terminal of its own. The commands for the TUI, such as `Caption`, `Highlight`
and `Tab`, work
-with `--record` only.
+Screenshots, captions for a live demo, and recording a demo as an animated GIF
have a page of their own:
+xref:camel-jbang-tui-recording.adoc[Camel TUI Screenshots and Demo Recordings].
diff --git a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui.adoc
b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui.adoc
index cc9122bcc532..c54fdd8f2b3b 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-jbang-tui.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-jbang-tui.adoc
@@ -33,8 +33,9 @@ image::jbang/camel-tui-overview.png[TUI Overview showing
multiple routes]
deep dives into Kafka, SQL, memory leaks, JFR and CVEs.
* *Ask the AI* -- the xref:camel-jbang-tui-ai.adoc[AI panel] (*F8*) with a
hosted or a local model, and
xref:camel-jbang-tui-ai-agents.adoc[AI coding agents] that see and drive the
TUI over MCP and ACP.
-* *Make it yours* -- xref:camel-jbang-tui-settings.adoc[themes, settings], the
embedded shell, browser access and demo
- recording.
+* *Make it yours* -- xref:camel-jbang-tui-settings.adoc[themes, settings], the
embedded shell and browser access.
+* *Show it* -- xref:camel-jbang-tui-recording.adoc[screenshots, captions and
demo recordings] as animated GIFs,
+ scripted as a tape that you or an AI agent writes.
== Getting Started
@@ -118,7 +119,9 @@ probe, CVE audit, Kafka, SQL, memory leaks, JFR, catalog
models, what a question costs, the Ollama tab
| xref:camel-jbang-tui-ai-agents.adoc[AI Agents] | MCP and ACP: what an AI
agent can see and do, edits you confirm
| xref:camel-jbang-tui-settings.adoc[Actions, Settings and Themes] | The
actions menu, embedded shell, themes, settings,
-browser access, recording demos
+browser access
+| xref:camel-jbang-tui-recording.adoc[Screenshots and Demo Recordings] |
Screenshots, presenting, recording a demo from
+a tape and converting it to a GIF
|===
== Keyboard Shortcuts
@@ -182,7 +185,7 @@ See the
xref:camel-jbang-tui-source-editor.adoc#_keyboard_shortcuts[keyboard sho
|
| `--record`
-| Play a `.tape` file in the TUI and record it to an Asciinema `.cast` file.
See xref:camel-jbang-tui-settings.adoc#_scripted_recording[Scripted Recording]
for the tape commands.
+| Play a `.tape` file in the TUI and record it to an Asciinema `.cast` file.
See xref:camel-jbang-tui-recording.adoc#_scripted_recording[Scripted Recording]
for the tape commands.
|
| `--record-size`
