A minimal, zero-config, BSD licensed, CLI based on linenoise, a readline replacement.
The name comes from "re-cli", or a re-imagination of the traditional CLI.
Command-line interfaces (CLIs) are widely used on Unix systems. The problem is that every one is different. This project creates a standardized CLI binary based on linenoise, which is a minimal, zero-config, BSD licensed, readline replacement.
This project follows on the minimal nature of linenoise.
Recli is based on the typical "words separated by spaces" paradigm.
Strings are allowed, via either
"this is a string", or
'this is a
string'. Other than the quote character, both strings are treated
At its base, Recli simple parses command lines with editing, and then chops the command-line into space-separated words. It does not do anything else with the input unless you tell it to.
Customizable syntax is documented in SYNTAX.markdown. Recli can load a pre-defined syntax from a simple text file. When a syntax has been defined, the only input which will be accepted is input which matches the syntax. All other input will produce a syntax error.
Permissions are documented in PERMISSION.markdown. Recli can load a Cisco IOS-style permissions file. This file contains a list of which commands are allowed and which ones are forbidden. It can be used in combination with the syntax, or by itself.
Customizable help text is documented in HELP.markdown. Recli can load contextual help text, and display it when the user types
help. If no help text is defined, the closest matching syntax is printed.
Recli supports tab completion for syntaxes. Pressing TAB will result in it switching between the various options. The tab completion is based on the Linenoise functionality, and may not match exactly what you expect from readline.
Recli has predefined data types, which are easily extensible. It includes support for INTEGER, IPADDR, STRING, and a number of other common data types. See DATATYPES.markdown.
Partial commands can be entered. When that happens, the prompt changes to indicate that more text is expected. The final part of the command can be entered by itself. This is useful when you need to entry a number of similar, but long commands. Just enter the common prefix once, and then the unique trailing portions.
Configuration files can be placed in a subdirectory. See init/README.markdown
To Do List
Handle multiple permissions files
allow loading of syntaxes / permissions from static buffers instead of files.
if the binary isn't named "recli", look in /etc/recli/$argv0.conf for syntax, etc.
add deamon mode
recli --daemon /path/to/fifo (or TCP socket)
recli --client /path/to/fifo (or TCP socket)
Add TCP mode, so the commands get sent over a TCP connection. We do NOT want to add SSL support. That should be done via "stunnel", maybe via "inetd" mode?
more regression tests for syntaxes and permissions
add a REST layer, so that it can convert CLI commands to REST commands. This allows any web site REST API to be poked via a simple CLI.
Via the following commands
-> get commands <- command blah <- command blah <- done -> get help <- help blah <- help blah <- done -> get permissions <- permission blah <- permission blah <- done -> get prompt <- prompt blah <- done
Once it's boot-strapped, it prints the prompt, and waits for user input. When it wants to run something, it sends it to the master, which responds:
-> run blah blah <- success <- text blah <- text blah <- error blah <- done
Or instead of "success", "fail". A command can potentially produce text on both stdout and stderr, so we need to distinguish the two streams.
The above two features will allow recli to be used as a login shell, while there's a "master" daemon on the same machine.