Skip to content

apps/nsh: Add support to command line editing on NSH #3657

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
acassis merged 5 commits into from
Jul 24, 2026
+1,099 −119
Merged

apps/nsh: Add support to command line editing on NSH #3657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
494ae78
readline: Don't assert on a zero-length RL_WRITE
acassis Jul 19, 2026
27dba82
system/readline: Add support for line movements and editing
acassis Jul 15, 2026
6818ec4
readline: remove 5x duplicated in redraw code
acassis Jul 22, 2026
5779652
readline: Make prompt-caching available
Jul 22, 2026
bf00f51
readline: Improve robustness of editing and escape-sequence handling
acassis Jul 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
7 changes: 4 additions & 3 deletions include/system/readline.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,9 @@ extern "C"
*
* If a prompt string is used by the application, then the application
* must provide the prompt string to readline() by calling this function.
* This is needed only for tab completion in cases where is it necessary
* to reprint the prompt string.
* This is needed for tab completion, and for line editing's full-line
* redraws (Home, End, history recall, ...), in cases where it is
* necessary to reprint the prompt string.
*
* Input Parameters:
* prompt - The prompt string. This function may then be
Expand All @@ -108,7 +109,7 @@ extern "C"
*
****************************************************************************/

#ifdef CONFIG_READLINE_TABCOMPLETION
#if defined(CONFIG_READLINE_TABCOMPLETION) || defined(CONFIG_READLINE_EDIT)
FAR const char *readline_prompt(FAR const char *prompt);
#else
# define readline_prompt(p)
Expand Down
6 changes: 6 additions & 0 deletions nshlib/nsh_session.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,12 @@ int nsh_session(FAR struct console_stdio_s *pstate,

write(OUTFD(pstate), nsh_prompt(), strlen(nsh_prompt()));

#if defined(CONFIG_READLINE_TABCOMPLETION) || defined(CONFIG_READLINE_EDIT)
/* Set the prompt so readline can redraw it for editing features */

readline_prompt(nsh_prompt());
#endif

/* readline() normally returns the number of characters read, but
* will return EOF on end of file or if an error occurs. EOF
* will cause the session to terminate.
Expand Down
27 changes: 27 additions & 0 deletions system/readline/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,22 @@ config READLINE_MAX_EXTCMDS

endif # READLINE_TABCOMPLETION

config READLINE_EDIT
bool "Command line editing"
default y if !DEFAULT_SMALL
Comment thread
acassis marked this conversation as resolved.
---help---
Build in support for full command-line editing using cursor keys,
Home/End, Delete. Requires a VT100/ANSI-compatible terminal.

config READLINE_EDIT_EMACS
bool "Emacs-style control keys"
default n
depends on READLINE_EDIT
---help---
Enable emacs-style control key bindings:
Ctrl+A Home, Ctrl+E End, Ctrl+K kill-to-end,
Ctrl+U kill-to-start, Ctrl+Left/Right word movement.

config READLINE_CMD_HISTORY
bool "Command line history"
default n
Expand Down Expand Up @@ -96,6 +112,17 @@ config READLINE_CMD_HISTORY_LEN
will be READLINE_CMD_HISTORY_LINELEN x READLINE_CMD_HISTORY_LEN.
Default: 16

config READLINE_EDIT_EMACS_REVERSE_SEARCH
bool "Reverse incremental search (Ctrl+R)"
default y
depends on READLINE_EDIT_EMACS
---help---
Enable bash-style Ctrl+R reverse incremental search through the
command history. Typing narrows the search to the most recent
matching command; Ctrl+R again searches further back; Enter
submits the match; Ctrl+G/Ctrl+C cancels back to the line being
edited before Ctrl+R was pressed.

endif # READLINE_CMD_HISTORY
endif # READLINE_ECHO
endif # SYSTEM_READLINE
Loading
Loading