LwSHELL latest-develop documentation

Welcome to the documentation for version latest-develop.

LwSHELL is a lightweight, platform independent, command line shell for embedded systems.

_images/logo.svg

Download library Getting started Open Github Donate

Features

  • Written in C (C11), compatible with stdint.h data types

  • Lightweight command-line shell for embedded systems

  • Platform independent and very easy to port

  • No dynamic (heap) memory allocation, with runtime command registration up to a compile-time configurable limit

  • Optional static, ROM-based command tables as an alternative to runtime registration, to save RAM

  • Supports quoted arguments to allow spaces inside a single parameter

  • Basic line editing with backspace and delete key support

  • Optional listcmd command to list all registered commands

  • Optional output callback to send shell responses back to the application

  • Multiple independent shell instances through _ex API functions

  • Helper macros to parse arguments as int, long or double

  • Highly configurable

  • Simple help-text with cmd -h option

  • User friendly MIT license

Requirements

  • C compiler

  • Less than 5kB of non-volatile memory

Contribute

Fresh contributions are always welcome. Simple instructions to proceed:

  1. Fork Github repository

  2. Respect C style & coding rules used by the library

  3. Create a pull request to develop branch with new features or bug fixes

Alternatively you may:

  1. Report a bug

  2. Ask for a feature request

License

MIT License

Copyright (c) 2026 Tilen MAJERLE

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.