Wsh-Shell is a lightweight, portable, and fully static shell interpreter written in C, designed for embedded systems. It requires no dynamic memory allocation and is built to run in constrained environments like microcontrollers, either bare-metal or under RTOS (e.g., FreeRTOS).
- Cross-platform, Highly Portable — only one header file to include
- Single State Structure — all shell state contained in a single
WshShell_tinstance - Static Memory Only — no
malloc, no heap; all buffers are statically allocated - Modular Design — ability to disable submodules for memory footprint optimization
- Command-line Editing — supports cursor movement, character deletion, and insert mode
- Command Parsing & Options:
- Supports short (
-h) and long (--help) flags - Supports int, float, string and other option types
- Supports double-quoted strings
- Supports short (
- Escape Sequence Handling:
- Parses VT100/ANSI sequences
- Supports arrow keys, delete, backspace, sound alerts, etc.
- Handles key combinations (Ctrl+C, Ctrl+D, etc.)
- Command History:
- Implemented as a circular buffer
- Efficient with hash-based integrity checks
- Navigable with arrow keys (↑, ↓)
- Autocomplete:
- Tab / double-Tab completion for commands and flags
- Multi-User Support — groups, access rights, and more
- Customizable PS1 Prompt — user-defined templates for prompt appearance
- Await Prompt — await for a specific key press
- Different New Line Support - handle different terminals setup (
\r,\nor\r\n)
- Build options: cortex-m7,
-O1optimization - sizeof(WshShell_t) = 336 bytes
| Config | FLASH, KB | RAM, KB | Comment |
|---|---|---|---|
| All features disabled | 3.29102 | 0.0 | |
+WSH_SHELL_PRINT_SYS/INFO/WARN/ERR |
3.58984 | 0.0 | Not recommended to disable shell messages |
+WSH_SHELL_DEF_COMMAND |
4.61914 | 0.27343 | |
+WSH_SHELL_PRINT_HELP |
4.65234 | 0.27343 | Could be usefull on huge amount of external commands |
+WSH_SHELL_CMD_PRINT_OPT_OVERVIEW |
4.90625 | 0.27343 | Could be usefull on huge amount of external commands |
+WSH_SHELL_INTERACTIVE_MODE |
5.00391 | 0.27343 | |
+WSH_SHELL_HISTORY |
6.16016 | 0.27343 | |
+WSH_SHELL_AUTOCOMPLETE |
6.71094 | 0.27343 | |
+WSH_SHELL_PS1_CUSTOM |
7.18359 | 0.27343 | |
+WSH_SHELL_PROMPT_WAIT |
7.29883 | 0.27343 |
===============================================================================
Language Files Lines Code Comments Blanks
===============================================================================
C 12 1928 1470 52 406
C Header 16 1936 679 1028 229
===============================================================================
Total 28 3864 2149 1080 635
===============================================================================- [email protected] — initial MVP
- [email protected] — improvements, refactoring
- [email protected] — project separation (for submodule usage), main structure, PC/MCU examples
- [email protected] — UX improvements, extra features, documentation
- [email protected] — CI/CD, docs deployment, high-level PC command app
This project is licensed under the MIT License.
You are free to use, modify, and distribute this software in both commercial and non-commercial projects, provided that the original copyright notice and this permission notice are included.
