Skip to content

CAMEL-23226: Enhance Shell with rich prompt, banner, and auto-suggestions #22170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gnodet wants to merge 8 commits into
base: main
Choose a base branch
from
+113 −101
Open

CAMEL-23226: Enhance Shell with rich prompt, banner, and auto-suggestions #22170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
5099fe3
CAMEL-23226: Migrate Shell to JLine 4 Shell API
gnodet Mar 21, 2026
3a51764
CAMEL-23226: Add POSIX, interactive, and script commands to JBang shell
gnodet Mar 21, 2026
7f17fa1
CAMEL-23226: Enhance Shell with alias persistence and init script sup…
gnodet Mar 21, 2026
3437d39
CAMEL-23226: Enhance Shell with rich prompt, banner, and auto-suggest…
gnodet Mar 21, 2026
43c312b
CAMEL-23226: Bump JLine to 4.0.8 for picocli argument completion
gnodet Mar 23, 2026
9afa834
CAMEL-23226: Restore help colors and completion styling in Shell
gnodet Mar 23, 2026
8e8df80
CAMEL-23226: Use CommandTailTipWidgets for unified autosuggestion and…
gnodet Mar 23, 2026
209e971
CAMEL-23226: Bump JLine to 4.0.9
gnodet Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions dsl/camel-jbang/camel-jbang-core/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,13 @@
<version>${picocli-version}</version>
</dependency>
<dependency>
<groupId>info.picocli</groupId>
<artifactId>picocli-shell-jline3</artifactId>
<version>${picocli-version}</version>
<groupId>org.jline</groupId>
<artifactId>jline</artifactId>
<version>${jline-version}</version>
</dependency>
<dependency>
<groupId>org.jline</groupId>
<artifactId>jline</artifactId>
<artifactId>jline-picocli</artifactId>
<version>${jline-version}</version>
</dependency>
<dependency>
Expand Down
204 changes: 108 additions & 96 deletions ...-jbang/camel-jbang-core/src/main/java/org/apache/camel/dsl/jbang/core/commands/Shell.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,127 +16,139 @@
*/
package org.apache.camel.dsl.jbang.core.commands;

import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.function.Supplier;

import org.apache.camel.dsl.jbang.core.common.EnvironmentHelper;
import org.apache.camel.dsl.jbang.core.common.VersionHelper;
import org.apache.camel.util.HomeHelper;
import org.jline.builtins.ClasspathResourceUtil;
import org.jline.builtins.ConfigurationPath;
import org.jline.console.SystemRegistry;
import org.jline.console.impl.Builtins;
import org.jline.console.impl.SystemRegistryImpl;
import org.jline.keymap.KeyMap;
import org.jline.reader.Binding;
import org.jline.reader.EndOfFileException;
import org.jline.builtins.InteractiveCommandGroup;
import org.jline.builtins.PosixCommandGroup;
import org.jline.picocli.PicocliCommandRegistry;
import org.jline.reader.LineReader;
import org.jline.reader.LineReaderBuilder;
import org.jline.reader.MaskingCallback;
import org.jline.reader.Parser;
import org.jline.reader.Reference;
import org.jline.reader.UserInterruptException;
import org.jline.reader.impl.DefaultHighlighter;
import org.jline.reader.impl.DefaultParser;
import org.jline.terminal.Terminal;
import org.jline.terminal.TerminalBuilder;
import org.jline.shell.ShellBuilder;
import org.jline.shell.impl.DefaultAliasManager;
import org.jline.shell.widget.CommandTailTipWidgets;
import org.jline.utils.AttributedStringBuilder;
import org.jline.utils.AttributedStyle;
import org.jline.utils.InfoCmp;
import org.jline.widget.TailTipWidgets;
import picocli.CommandLine;
import picocli.shell.jline3.PicocliCommands;

@CommandLine.Command(name = "shell",
description = "Interactive Camel JBang shell.",
footer = "Press Ctrl-C to exit.")
public class Shell extends CamelCommand {

// Camel orange color (packed RGB)
private static final int CAMEL_ORANGE = 0xF69123;

// Help colors: title=bold blue, command=38, args=italic, options=yellow, description=dark gray
private static final String HELP_COLORS = "ti=1;34:co=38:ar=3:op=33:de=90";

public Shell(CamelJBangMain main) {
super(main);
}

@Override
public Integer doCall() throws Exception {
Supplier<Path> workDir = () -> Paths.get(System.getProperty("user.dir"));
// set up JLine built-in commands
Path appConfig = ClasspathResourceUtil.getResourcePath("/nano/jnanorc", getClass()).getParent();
Builtins builtins = new Builtins(workDir, new ConfigurationPath(appConfig, workDir.get()), null) {
@Override
public String name() {
return "built-in";
}
};

PicocliCommands.PicocliCommandsFactory factory = new PicocliCommands.PicocliCommandsFactory();
PicocliCommands commands = new PicocliCommands(CamelJBangMain.getCommandLine());
commands.name("Camel");

try (Terminal terminal = TerminalBuilder.builder().build()) {
Parser parser = new DefaultParser();
SystemRegistry systemRegistry = new SystemRegistryImpl(parser, terminal, workDir, null);
systemRegistry.setCommandRegistries(builtins, commands);
systemRegistry.register("help", commands);

String history = Paths.get(HomeHelper.resolveHomeDir(), ".camel-jbang-history").toString();
LineReader reader = LineReaderBuilder.builder()
.terminal(terminal)
.completer(systemRegistry.completer())
.parser(parser)
.highlighter(new ReplHighlighter())
.variable(LineReader.LIST_MAX, 50) // max tab completion candidates
.variable(LineReader.HISTORY_FILE, history)
.variable(LineReader.OTHERS_GROUP_NAME, "Others")
.variable(LineReader.COMPLETION_STYLE_GROUP, "fg:blue,bold")
.variable("HELP_COLORS", "ti=1;34:co=38:ar=3:op=33:de=90")
.option(LineReader.Option.GROUP_PERSIST, true)
.build();
builtins.setLineReader(reader);
factory.setTerminal(terminal);
TailTipWidgets widgets
= new TailTipWidgets(reader, systemRegistry::commandDescription, 5, TailTipWidgets.TipType.COMPLETER);
widgets.enable();
KeyMap<Binding> keyMap = reader.getKeyMaps().get("main");
keyMap.bind(new Reference("tailtip-toggle"), KeyMap.alt("s"));
String prompt = "camel> ";
String rightPrompt = null;

// start the shell and process input until the user quits with Ctrl-C or Ctrl-D
String line;
boolean run = true;
TerminalBuilder.setTerminalOverride(terminal);
while (run) {
try {
systemRegistry.cleanUp();
line = reader.readLine(prompt, rightPrompt, (MaskingCallback) null, null);
systemRegistry.execute(line);
} catch (UserInterruptException e) {
// ctrl + c is pressed so exit
run = false;
} catch (EndOfFileException e) {
// ctrl + d is pressed so exit
run = false;
} catch (Exception e) {
systemRegistry.trace(e);
}
}
} finally {
TerminalBuilder.setTerminalOverride(null);
PicocliCommandRegistry registry = new PicocliCommandRegistry(CamelJBangMain.getCommandLine());

String homeDir = HomeHelper.resolveHomeDir();
Path history = Paths.get(homeDir, ".camel-jbang-history");

// Alias persistence: aliases are stored in ~/.camel-jbang-aliases
Path aliasFile = Paths.get(homeDir, ".camel-jbang-aliases");
DefaultAliasManager aliasManager = new DefaultAliasManager(aliasFile);

// Init script: if ~/.camel-jbang-init exists, it will be executed on shell startup
Path initScript = Paths.get(homeDir, ".camel-jbang-init");

String camelVersion = VersionHelper.extractCamelVersion();
boolean colorEnabled = EnvironmentHelper.isColorEnabled();

// org.jline.shell.Shell is used via FQCN to avoid clash with this class name
ShellBuilder builder = org.jline.shell.Shell.builder()
.prompt(() -> buildPrompt(camelVersion, colorEnabled))
.rightPrompt(() -> buildRightPrompt(colorEnabled))
.groups(registry, new PosixCommandGroup(), new InteractiveCommandGroup())
.historyFile(history)
.historyCommands(true)
.helpCommands(true)
.variableCommands(true)
.commandHighlighter(true)
.aliasManager(aliasManager)
.onReaderReady((reader, dispatcher) -> {
// CommandTailTipWidgets provides both fish-style autosuggestion
// and command description tooltips below the cursor line
new CommandTailTipWidgets(reader, dispatcher, 5).enable();
})
.variable(LineReader.LIST_MAX, 50)
.variable(LineReader.OTHERS_GROUP_NAME, "Others")
.variable(LineReader.COMPLETION_STYLE_GROUP, "fg:blue,bold")
.variable("HELP_COLORS", HELP_COLORS)
.option(LineReader.Option.GROUP_PERSIST, true);

if (Files.exists(initScript)) {
builder.initScript(initScript.toFile());
}

try (org.jline.shell.Shell shell = builder.build()) {
printBanner(shell, camelVersion, colorEnabled);
shell.run();
}
return 0;
}

private static class ReplHighlighter extends DefaultHighlighter {
@Override
protected void commandStyle(LineReader reader, AttributedStringBuilder sb, boolean enable) {
if (enable) {
if (reader.getTerminal().getNumericCapability(InfoCmp.Capability.max_colors) >= 256) {
sb.style(AttributedStyle.DEFAULT.bold().foreground(69));
} else {
sb.style(AttributedStyle.DEFAULT.foreground(AttributedStyle.CYAN));
}
} else {
sb.style(AttributedStyle.DEFAULT.boldOff().foregroundOff());
private static String buildPrompt(String camelVersion, boolean colorEnabled) {
if (!colorEnabled) {
return camelVersion != null ? "camel " + camelVersion + "> " : "camel> ";
}
AttributedStringBuilder sb = new AttributedStringBuilder();
sb.append("camel", AttributedStyle.DEFAULT.bold().foregroundRgb(CAMEL_ORANGE));
if (camelVersion != null) {
sb.append(" ");
sb.append(camelVersion, AttributedStyle.DEFAULT.foreground(AttributedStyle.GREEN));
}
sb.append("> ", AttributedStyle.DEFAULT);
return sb.toAnsi();
}

private static String buildRightPrompt(boolean colorEnabled) {
String cwd = System.getProperty("user.dir");
String home = System.getProperty("user.home");
if (cwd != null && home != null && cwd.startsWith(home)) {
cwd = "~" + cwd.substring(home.length());
}
if (cwd == null) {
return null;
}
if (!colorEnabled) {
return cwd;
}
return new AttributedStringBuilder()
.append(cwd, AttributedStyle.DEFAULT.faint())
.toAnsi();
}

private static void printBanner(org.jline.shell.Shell shell, String camelVersion, boolean colorEnabled) {
var writer = shell.terminal().writer();
if (colorEnabled) {
AttributedStringBuilder sb = new AttributedStringBuilder();
sb.append("Apache Camel", AttributedStyle.DEFAULT.bold().foregroundRgb(CAMEL_ORANGE));
sb.append(" JBang Shell", AttributedStyle.DEFAULT.bold());
if (camelVersion != null) {
sb.append(" v" + camelVersion, AttributedStyle.DEFAULT.foreground(AttributedStyle.GREEN));
}
writer.println(sb.toAnsi(shell.terminal()));
} else {
String banner = "Apache Camel JBang Shell";
if (camelVersion != null) {
banner += " v" + camelVersion;
}
writer.println(banner);
}
writer.println("Type 'help' for available commands, 'exit' to quit.");
writer.println();
writer.flush();
}
}
2 changes: 1 addition & 1 deletion parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -327,7 +327,7 @@
<jgroups-raft-leveldbjni-version>1.8</jgroups-raft-leveldbjni-version>
<jgroups-raft-mapdb-version>1.0.8</jgroups-raft-mapdb-version>
<jira-rest-client-api-version>6.0.2</jira-rest-client-api-version>
<jline-version>4.0.7</jline-version>
<jline-version>4.0.9</jline-version>
<libthrift-version>0.22.0</libthrift-version>
<jodatime2-version>2.14.1</jodatime2-version>
<jolokia-version>2.5.1</jolokia-version>
Expand Down
Loading