Skip to content

Commit 5278320

Browse files
committed
Update docs
1 parent 706cb49 commit 5278320

1 file changed

Lines changed: 30 additions & 4 deletions

File tree

docs/user-manual/modules/ROOT/pages/camel-jbang.adoc

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1233,6 +1233,7 @@ Supported plugins:
12331233
NAME COMMAND DEPENDENCY DESCRIPTION
12341234
kubernetes kubernetes org.apache.camel:camel-jbang-plugin-kubernetes Run Camel applications on Kubernetes
12351235
generate generate org.apache.camel:camel-jbang-plugin-generate Generate code such as DTOs
1236+
diagram diagram org.apache.camel:camel-jbang-plugin-diagram Visualize Camel routes using Hawtio
12361237
----
12371238

12381239
In case you want to enable a plugin and its functionality, you can add it as follows:
@@ -2486,14 +2487,23 @@ from doing JVM process communication to the running Camel integration.
24862487

24872488
=== Visualizing routes with diagram
24882489

2489-
The `camel diagram` command uses Hawtio to visualize Camel routes. You can run route files in the background and open Hawtio in a browser:
2490+
The `camel diagram` command uses Hawtio to visualize Camel routes.
2491+
2492+
NOTE: The diagram command is a plugin that must be installed first:
2493+
2494+
[source,bash]
2495+
----
2496+
camel plugin add diagram
2497+
----
2498+
2499+
Once installed, you can run route files in the background and open Hawtio in a browser:
24902500

24912501
[source,bash]
24922502
----
24932503
camel diagram routes.yaml
24942504
----
24952505

2496-
To attach to an existing integration:
2506+
To attach to an existing integration that is already running:
24972507

24982508
[source,bash]
24992509
----
@@ -2502,15 +2512,31 @@ camel diagram --name my-integration
25022512

25032513
By default Camel JBang stops the background integration when you exit Hawtio; use `--keep-running` to leave it running.
25042514

2505-
You can export a PNG snapshot using Playwright (requires a Chromium browser binary and executable path configured):
2515+
You can export a PNG snapshot using Playwright (requires a Chromium-based browser):
25062516

25072517
[source,bash]
25082518
----
25092519
camel diagram routes.yaml --output=routes.png --playwright-browser-path=/path/to/chrome
25102520
----
25112521

2522+
On macOS with Google Chrome installed, the command looks like:
2523+
2524+
[source,bash]
2525+
----
2526+
camel diagram routes.yaml --output=routes.png --playwright-browser-path="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
2527+
----
2528+
2529+
On Linux with Chromium:
2530+
2531+
[source,bash]
2532+
----
2533+
camel diagram routes.yaml --output=routes.png --playwright-browser-path=/usr/bin/chromium-browser
2534+
----
2535+
25122536
When using `--output`, Hawtio runs headless and the PNG is captured automatically.
2513-
NOTE: PNG export currently supports Chromium only. Use `PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH` or `--playwright-browser-path`.
2537+
2538+
NOTE: PNG export currently supports Chromium-based browsers only (Google Chrome, Chromium, Microsoft Edge).
2539+
The `--playwright-browser-path` option (or the `PLAYWRIGHT_CHROMIUM_EXECUTABLE_PATH` environment variable) must point to the browser executable.
25142540

25152541
=== Scripting from terminal using pipes
25162542

0 commit comments

Comments
 (0)