From 85479ec6ed57ab47e7612cec03ec79806be06c04 Mon Sep 17 00:00:00 2001
From: Malin Freeborn <malinfreeborn@posteo.net>
Date: Fri, 21 Mar 2025 01:51:31 +0100
Subject: [PATCH] note recutils example command

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/README.md b/README.md
index 896948c..5b10eae 100644
--- a/README.md
+++ b/README.md
@@ -15,3 +15,34 @@ These setup files provide the text-only configurations for DMZ.
 - Any maintenance scripts.
 - Configurations should reside in shadow-directories, e.g. a backup `soft-serve`'s `config.yaml` should reside in this repo under `splint.rs/soft-serve/etc/soft/config.yaml`.
 
+# Network Database
+
+I have a half-baked plan to finally make use of plain-text databases, and it's already half-working.
+Try these commands:
+
+Ask what types of _rec_ords it contains:
+
+```sh
+recinf network.rec
+```
+
+```sh
+recsel network.rec --type router
+recsel network.rec --include-descriptors --type lxc
+recsel network.rec -d -t lxc
+recsel network.rec -d -t lxc --expression
+recsel network.rec -t lxc --expression "name ~ 'nginx'"
+recsel network.rec -t lxc --expression "name = 'nginx12'"
+```
+
+If you can select something, you can also set its fields with `recset`.
+
+Use `-f` to set the field, and `-a` to add, or `-s` to set.
+
+
+```sh
+recset network.rec -t lxc --expression "name = 'nginx12'" -f proxies --add soft-serve
+recsel network.rec -t lxc --expression "name = 'nginx11'" -p proxies[0]
+recset network.rec -t lxc --expression "name = 'nginx11'" -f proxies[0] -s wiki9
+```
+