Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/noahp/nocli
Command-line interpreter for embedded systems
https://github.com/noahp/nocli
Last synced: 2 months ago
JSON representation
Command-line interpreter for embedded systems
- Host: GitHub
- URL: https://github.com/noahp/nocli
- Owner: noahp
- Created: 2016-12-23T17:04:46.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T16:33:43.000Z (about 2 years ago)
- Last Synced: 2024-08-03T18:16:47.229Z (6 months ago)
- Language: C
- Homepage:
- Size: 84 KB
- Stars: 3
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- AwesomeInterpreter - nocli
README
# no-cli
[](https://github.com/noahp/nocli)
[](https://travis-ci.org/noahp/nocli)
[](https://codecov.io/gh/noahp/nocli)
[](http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1256.pdf)
Cheesy command line interpreter designed for tiny memory-constrained systems.
Minimal dependencies: just string.h.
## Features
- low footprint; the library is \~**600 bytes** `.text` (\~**335 bytes** under
minimal configuration), and uses a (configurable) 128 byte buffer (`.bss`) and
24 byte (`.data`) context structure.
```bash
❯ arm-none-eabi-gcc -DNOCLI_RUNTIME_ECHO_CONTROL=0 -mcpu=cortex-m4 -mfpu=fpv4-sp-d16 -mfloat-abi=hard -Os -Itest -c nocli.c -o nocli.o
❯ arm-none-eabi-size nocli.o
text data bss dec hex filename
562 0 0 562 232 nocli.o
```
- incremental parsing of input stream
- static memory usage
- supports doubly- and singly- quoted args (can be disabled to save ~100 bytes)
- 100% test coverage
- fuzz tested via LibFuzzer
Possible future features, if I need them:
- UNIMPLEMENTED optional tab completion or history?
## Usage
### Example
See [`test/example.c`](test/example.c) for an example that runs on host.
You can try the example by building it and running it:
```bash
# build
❯ make -f test/Makefile
Compiling nocli.c
Compiling test/example.c
Linking build/example/example
# run
❯ ./build/example/example
nocli$ help
?
help
count-args print number of args passed
change-prompt set prompt to new string
nocli$ count-args 1 2 3
Arg count: 3
nocli$
```
### Integration
API is documented in [`nocli.h`](nocli.h). There's only two functions used:
1. initialize the library: `void Nocli_Init(struct Nocli *nocli);`
> this includes a callback for outputting data and the table of commands.
2. pass any amount of data: `void Nocli_Feed(struct Nocli *nocli, const char *input, size_t length);`
> commands are executed within this function, so be sure to call it in a safe context
## libfuzzer crashes
Run libfuzzer with `make -f test/Makefile fuzz`; it will run continuously until
a crash occurs (`AddressSanitizer` and `UndefinedBehaviorSanitizer` are enabled
on the fuzz build)
Crashes that libfuzzer finds are saved in [test/corpus](test/corpus), which are
run through the library in ci to catch regressions.
## License
WTFPL (http://www.wtfpl.net/) or public domain, whichever you prefer.
---
## Alternatives!
This library conflates two operations:
- line editing
- command line argument parsing
There are a LOT of alternatives. Here's some commonly used ones:
### Line editing
- readline
- linenoise
### Argument parsing
- getopt
- argp
- argparse3