Skip to content

CLI improvements #26138

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

Merged
merged 2 commits into from
Jul 7, 2025
Merged

CLI improvements #26138

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb5a7f3
Add more completions to the CLI
wendigo Jul 7, 2025
ce9f6b6
Add binding to move through the multiline history in the cli
wendigo Jul 7, 2025
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
18 changes: 14 additions & 4 deletions client/trino-cli/src/main/java/io/trino/cli/Completion.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,25 @@ private Completion() {}

public static Completer commandCompleter()
{
// This is not an exhaustive list of commands, but it covers the most common ones.
return new AggregateCompleter(buildArgumentCompleter("ALTER", asList("SCHEMA", "TABLE")),
buildArgumentCompleter("CREATE", asList("SCHEMA", "TABLE")),
buildArgumentCompleter("DESCRIBE"),
buildArgumentCompleter("DROP", asList("SCHEMA", "TABLE")),
buildArgumentCompleter("CREATE", asList("CATALOG", "SCHEMA", "TABLE", "VIEW", "MATERIALIZED VIEW", "FUNCTION", "BRANCH", "ROLE")),
buildArgumentCompleter("DESCRIBE", asList("INPUT", "OUTPUT")),
buildArgumentCompleter("DROP", asList("CATALOG", "SCHEMA", "TABLE", "VIEW", "MATERIALIZED VIEW", "FUNCTION", "BRANCH", "ROLE")),
buildArgumentCompleter("EXPLAIN"),
buildArgumentCompleter("HELP"),
buildArgumentCompleter("QUIT"),
buildArgumentCompleter("SELECT"),
buildArgumentCompleter("SHOW", asList("CATALOGS", "COLUMNS", "FUNCTIONS", "SCHEMAS", "SESSION", "TABLES")),
buildArgumentCompleter("MERGE"),
buildArgumentCompleter("TRUNCATE TABLE"),
buildArgumentCompleter("SET SESSION"),
buildArgumentCompleter("RESET SESSION"),
buildArgumentCompleter("RESET SESSION"),
buildArgumentCompleter("GRANT"),
buildArgumentCompleter("REVOKE"),
buildArgumentCompleter("DENY"),
buildArgumentCompleter("COMMENT ON", asList("TABLE", "VIEW", "COLUMN")),
buildArgumentCompleter("SHOW", asList("CATALOGS", "COLUMNS", "FUNCTIONS", "SCHEMAS", "SESSION", "TABLES", "STATS", "GRANT")),
buildArgumentCompleter("USE"));
}

Expand Down
13 changes: 12 additions & 1 deletion client/trino-cli/src/main/java/io/trino/cli/InputReader.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,13 @@
package io.trino.cli;

import com.google.common.io.Closer;
import org.jline.keymap.KeyMap;
import org.jline.reader.Binding;
import org.jline.reader.Completer;
import org.jline.reader.History;
import org.jline.reader.LineReader;
import org.jline.reader.LineReaderBuilder;
import org.jline.reader.Reference;
import org.jline.reader.impl.completer.AggregateCompleter;
import org.jline.terminal.Terminal;
import org.jline.utils.AttributedString;
Expand Down Expand Up @@ -58,7 +61,7 @@ public InputReader(ClientOptions.EditingMode editingMode, Optional<Path> history
historyFile.ifPresent(path -> builder.variable(HISTORY_FILE, path));
reader = builder.build();

reader.getKeyMaps().put(MAIN, reader.getKeyMaps().get(editingMode.getKeyMap()));
reader.getKeyMaps().put(MAIN, configureKeyMap(reader, editingMode));
reader.unsetOpt(HISTORY_TIMESTAMPED);
if (!disableAutoSuggestion) {
AutosuggestionWidgets autosuggestionWidgets = new AutosuggestionWidgets(reader);
Expand Down Expand Up @@ -95,4 +98,12 @@ private static String colored(String value)
{
return new AttributedString(value, DEFAULT.foreground(BRIGHT)).toAnsi();
}

private static KeyMap<Binding> configureKeyMap(LineReader reader, ClientOptions.EditingMode editingMode)
{
KeyMap<Binding> bindingKeyMap = reader.getKeyMaps().get(editingMode.getKeyMap());
bindingKeyMap.bind(new Reference(LineReader.UP_HISTORY), "\u001b[1;3A"); // alt + up
bindingKeyMap.bind(new Reference(LineReader.DOWN_HISTORY), "\u001b[1;3B"); // alt + down
return bindingKeyMap;
}
}