A command line interpreter and script engine for embedded systems.

xelp is an interactive command line interpreter, script engine, and single-key menu system for embedded C projects. It compiles to under 5 KB with all features enabled and runs on targets from 8-bit microcontrollers to 64-bit hosts with code sizes from under 1 KB to ~5 KB. Register your own C functions as commands and call them from the prompt or from scripts stored in ROM. No OS, no dynamic memory, no standard library dependencies.

Features

• Pure C (C89 compliant), optional C++ extern "C" support
• Compiled sizes: under 1 KB to ~5 KB depending on features enabled
• No malloc, no globals — all state in an instance struct
• Bring your own functions — register any C function as a CLI command with a one-line table entry, callable interactively or from scripts
• Multiple independent instances on different serial ports, BLE, USB CDC
• Char-at-a-time parsing — feed from UART, ISR, or any byte stream
• Command history — UP/DOWN arrow recall of previous commands (optional, XELP_ENABLE_HISTORY)
• Built-in tokenizer with quoted strings, escape sequences, # comments
• Scriptable — run multi-command const strings from ROM or RAM
• Zero dependencies (no stdio.h, string.h, etc.)

CLI in action

Every command above is a plain C function registered with a one-line table entry:

XELPCLIFuncMapEntry commands[] = {
    { &cmd_echo,   "echo",   "echo args back"              },
    { &cmd_led,    "led",    "led <0|1>"                   },
    { &cmd_divmod, "divmod", "divmod <a> <b> R1=a/b R2=a%b" },
    XELP_FUNC_ENTRY_LAST
};

Modes

Quick start

Add three files to your project: xelp.c, xelp.h, xelpcfg.h. Then:

#include "xelp.h"

void uart_putc(char c) { UART_TX = c; }

XELPRESULT cmd_hello(XELP *ths, const char *args, int len) {
    XelpOut(ths, "Hello!\n", 0);
    return XELP_S_OK;
}

XELPCLIFuncMapEntry commands[] = {
    { &cmd_hello, "hello", "say hello" },
    XELP_FUNC_ENTRY_LAST
};

XELP cli;

void main(void) {
    XelpInit(&cli, "My Device v1.0");
    XELP_SET_FN_OUT(cli, &uart_putc);
    XELP_SET_FN_CLI(cli, commands);

    for (;;) {
        if (uart_rx_ready())
            XelpParseKey(&cli, uart_getc());
    }
}

Compiled sizes

Compiled .text section sizes with -Os. Three configurations: KEY (single-key dispatch only), CLI (typical interactive use), FULL (all features). Even the largest full build is under 7 KB.

x86-64 GCC row is measured directly; others from cross-compilation via tools/Dockerfile.crossbuild.

Building and testing

make validate     # tests + build all examples (the everyday check)
make tests        # unit tests + coverage only
make examples     # build all examples (no interactive launch)
make example      # build and run the posix ncurses demo (interactive)
make coverage     # tests + coverage summary
make fuzz         # fuzz testing with libFuzzer (requires clang)
make clean-all    # remove all build artifacts

47 test units, 598 test cases, 100% line coverage of xelp.c.

Documentation

• Tutorial — step-by-step introduction
• Examples — annotated code for various platforms
• API Reference — all public functions and macros
• Configuration Guide — compile-time options in xelpcfg.h
• Porting Guide — how to bring up xelp on a new platform
• Release History
• Contributing

License

BSD 2-Clause — see LICENSE.txt. © 2005–2026 M. A. Chatterjee