#event-store #lmdb #queue #cli

bin+lib xs-lib

xs-lib is a command-line tool (xs) and a Rust library (xs_lib) for recording and retrieving sequential streams of payloads. It uses Lightning Memory-Mapped Database (LMDB) for local data storage.

3 releases (breaking)

0.4.0 Jun 1, 2023
0.3.0 May 25, 2023
0.2.0 May 24, 2023

#661 in Embedded development

40 downloads per month

MIT license

19KB
416 lines

xs

This is a command-line tool (xs) and a Rust library (xs_lib) for recording and retrieving sequential streams of payloads. It uses Lightning Memory-Mapped Database (LMDB) for efficient and reliable local embedded storage.

Installation

cargo install xs-lib

Usage

xs is easy to use. Here's an example of recording and retrieving a sequential stream of payloads:

# Record a payload
% echo "hello world" | xs ./s put

# Retrieve the payloads
% xs ./s cat
{"id":"039KW46V39SC3LYMJSMHJJJRH","data":"hello world"}

IDs are SCRU128s.

Command-Line Interface

Here are the available commands for xs:

Usage: xs <PATH> <COMMAND>

Commands:
  put    Insert a payload into the store from stdin, with optional follow
  get    Fetch a specific payload by ID
  cat    Stream payloads from store with optional last_id and follow
  call   Send request to topic, wait for response, print output
  serve  Listen for requests, execute command, write output back
  help   Print this message or the help of the given subcommand(s)

Arguments:
  <PATH>

Options:
  -h, --help     Print help
  -V, --version  Print version

License

xs is released under the MIT License. See the LICENSE file for more details.

Contributing

Contributions to xs are welcome!

Dependencies

~4–17MB
~196K SLoC