syndicate_utils/README.md

16 lines
633 B
Markdown

# Syndicate utils
## json_translator
Wrapper that executes a command, parses its JSON output, and asserts a Preserves conversion in an `<output …>` record.
## json_socket_translator
Utility to communicate with sockets that send and receive lines of JSON using `<sen-json …>` and `<recv-json …>` messages. Compatible with [mpv](https://mpv.io/), see [mpv.config-example.pr](./mpv.config-example.pr).
Do not send messages immediately to the dataspace passed `json_socket_translator`, wait until it asserts `<connected @socketPath string>`.
## msg
A utility that sends a message to $SYNDICATE_SOCK in the form `<ARGV…>`.