script: Add tab completion for flags and arguments #57
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
629cd66 to
714c023
Compare
joamaki
approved these changes
Jul 25, 2025
714c023 to
485c985
Compare
derailed
approved these changes
Jul 29, 2025
There was a problem hiding this comment.
@dylandreimerink Very cool!! a few suggestions feel free to ignore...
|
|
||
| state.suggestions = nil | ||
| for _, suggestion := range argsCB(engineState, nil, "") { | ||
| state.suggestions = append(state.suggestions, line[:state.pos]+suggestion) |
There was a problem hiding this comment.
I think it might be a good idea to actually add behavior on the autocompletestate. Perhaps this would allow us to make sure adequate bound checks are in placed in a central location.
Not to mention we can test the various inputs.
Speaking of which might be great to add some tests here to ensure we produce the correct suggestions under various conditions.
There was a problem hiding this comment.
Yes. Agreed that would be a good idea. I will as this in a followup PR to ensure we don't regress this on accident.
This commit adds tab completion for the shell. When in the REPL the <tab> key can be used to give suggestions. When typing the initial command it will suggest commands starting with the typed characters. Repeated presses of the <tab> key will cycle through the suggestions. When pressing <tab> while in an argument or flag value, a callback on the command is called if it exists. This callback can return a slice of values to suggest. For arguments, all arguments up and including the current argument are passed to the callback. For flags, the flag name and value typed so far are passed to the callback. To accommodate the "remote shell" used by Cilium, a hidden flag is now implicitly added to all commands `--autocomplete`. When a command is called with this flag the engine will intercept the command and return a line separated list of suggestions instead of executing the command. For example: `test --autocomplete='arg1 --flag1=val1 ar'` will be interpreted the same as `test arg1 --flag1=val1 ar` would on the REPL and the output will be a list of suggestions: ``` > test --autocomplete='arg1 --flag1=val1 ar' test arg1 --flag1=val1 argument2 test arg1 --flag1=val1 arg2 test arg1 --flag1=val1 args2 ``` The `help` command also has a hidden flag `-a` which if passed will simply list all available commands without additional help text. ``` > help -a cat cd chmod ``` This should allow the remote shell in Cilium to provide tab completion in the same way as the REPL. Signed-off-by: Dylan Reimerink <dylan.reimerink@isovalent.com>
485c985 to
d159142
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit adds tab completion for the shell. When in the REPL the key can be used to give suggestions. When typing the initial command it will suggest commands starting with the typed characters. Repeated presses of the key will cycle through the suggestions.
When pressing while in an argument or flag value, a callback on the command is called if it exists. This callback can return a slice of values to suggest. For arguments, all arguments up and including the current argument are passed to the callback. For flags, the flag name and value typed so far are passed to the callback.
To accommodate the "remote shell" used by Cilium, a hidden flag is now implicitly added to all commands
--autocomplete. When a command is called with this flag the engine will intercept the command and return a line separated list of suggestions instead of executing the command. For example:test --autocomplete='arg1 --flag1=val1 ar'will be interpreted the same astest arg1 --flag1=val1 arwould on the REPL and the output will be a list of suggestions:The
helpcommand also has a hidden flag-awhich if passed will simply list all available commands without additional help text.This should allow the remote shell in Cilium to provide tab completion in the same way as the REPL.
Fixes: #54