aboutsummaryrefslogtreecommitdiffstats
path: root/docs/guides/federation/writing-and-reading.md
diff options
context:
space:
mode:
authortv <tv@krebsco.de>2026-11-19 21:00:40 +0000
committertv <tv@krebsco.de>2026-11-19 22:10:36 +0100
commitedb4443510d7c8e4957e953093a25f9e7876493e (patch)
treeed78864d7a71345c4af4da1e32ca7bbb4c2c20ed /docs/guides/federation/writing-and-reading.md
parent59cc0283117be6b4195afbe857d702e7f8ddba6e (diff)
continuum-party get: what counts, as JSON, a path at a time
What counts is kept by place, each place's value whole: `values` showed it so, a place a line, and `--json` as one object keyed by places. An application holds it as one tree. `get [PATH]` reads it so (tree, at): each place's value at its path, the maps on its way made, so that `get home/tv` is one object of everything under it, and `get home/tv/hosts/laptop/ip6` reaches into a place's value, a list's items by their index. Where a place lies under another's value, the deeper place is the later word there (merge). Nothing at a path is an error. `-r` writes a string as it is, as jq -r does; other values as JSON. Bash completes it with places and the paths on their way.
Diffstat (limited to 'docs/guides/federation/writing-and-reading.md')
-rw-r--r--docs/guides/federation/writing-and-reading.md29
1 files changed, 26 insertions, 3 deletions
diff --git a/docs/guides/federation/writing-and-reading.md b/docs/guides/federation/writing-and-reading.md
index abd5221..c6b27ba 100644
--- a/docs/guides/federation/writing-and-reading.md
+++ b/docs/guides/federation/writing-and-reading.md
@@ -94,11 +94,34 @@ Votes and proposals aren't signed again: their version is behind.
## Reading
-The client shows the values that count, each with who writes there, all or under a
-place (`--json` as one object, by place):
+The client reads what counts as JSON, as an application holds it: a place's value, or
+what lies under a path as one object, the places under it and the values within theirs,
+a list's items by their index; `-r` writes a string as it is, as `jq -r` does:
```sh
-continuum-party --node http://lass:secret@localhost:3000 values home/tv
+continuum-party get home/tv/motd -r
+# hello
+continuum-party get home/tv
+# {
+# "hosts": {
+# "laptop": {
+# "ip6": "42:0:a46e::1"
+# }
+# },
+# "motd": "hello"
+# }
+continuum-party get home/tv/hosts/laptop/ip6 -r
+# 42:0:a46e::1
+```
+
+Where a place lies under another's value (`home/tv/hosts` holding an object, and
+`home/tv/hosts/laptop` a place of its own), the deeper place is the later word there.
+Nothing counting at a path is an error. `values` shows the places themselves, each with
+who writes there (`--json` as one object, by place):
+
+```sh
+continuum-party values home/tv
+# home/tv/hosts/laptop {"ip6":"42:0:a46e::1"} (tv)
# home/tv/motd "hello" (tv)
```