syndicate_utils/README.md

# 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…>`.

## preserve_process_environment

This utility serializes it's process environment to Preserves and prints it to stdout.
It can be used to feed the environment variables of a nested child of the Syndicate server back to the server. For example, to retreive the environmental variables that a desktop manager passed on to its children.
Initial http_protocol utility 2022-06-09 01:25:45 +00:00			`# Syndicate utils`

Initail json_translator 2022-06-09 05:28:26 +00:00			`## json_translator`

			Wrapper that executes a command, parses its JSON output, and asserts a Preserves conversion in an `<output …>` record.
Initial msg utility This can replace xdg-open. 2022-06-09 17:24:02 +00:00
Initial json_socket_translator utility 2022-06-09 18:15:13 +00:00			`## json_socket_translator`

Add <connected "…"> assertion to json_socket_translator 2023-05-16 09:51:56 +00:00			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>`.
Initial msg utility This can replace xdg-open. 2022-06-09 17:24:02 +00:00
			`## msg`

			A utility that sends a message to $SYNDICATE_SOCK in the form `<ARGV…>`.
Add preserve_process_environment 2023-05-18 16:48:50 +00:00
			`## preserve_process_environment`

			`This utility serializes it's process environment to Preserves and prints it to stdout.`
			`It can be used to feed the environment variables of a nested child of the Syndicate server back to the server. For example, to retreive the environmental variables that a desktop manager passed on to its children.`