summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/MESHBAY_DESIGN.md15
-rw-r--r--docs/USERGUIDE.md1
2 files changed, 13 insertions, 3 deletions
diff --git a/docs/MESHBAY_DESIGN.md b/docs/MESHBAY_DESIGN.md
index b579b7b..18c155e 100644
--- a/docs/MESHBAY_DESIGN.md
+++ b/docs/MESHBAY_DESIGN.md
@@ -3012,7 +3012,8 @@ MSE string) fed to a source buffer, with the node holding one slot per viewer.
`meshbay-cli` (`packages/meshbay-cli`) is a member's groups and files from a
terminal: `login`, `logout`, `groups`, `invitations`, `join`, `decline`,
-`leave`, `ls`, `get`, `put`, `rm`, `devices`, `trust`, `browser-access`, and with no
+`leave`, `ls`, `search`, `get`, `put`, `rm`, `devices`, `trust`, `browser-access`,
+and with no
argument an interactive two-pane view (Textual) over the same library. It is not an
operator tool — a node is administered through `meshbay-node` and its loopback
API (§6.7) — and it does not stream, play or chat: those belong to an engine
@@ -3042,6 +3043,14 @@ code goes to the node the link names and to no other. `leave`, like
`decline` and `devices revoke`, asks first on a terminal and refuses without
`--yes` where there is none.
+**Search** (`search`) dials every group through the pool and matches each
+index on the client, on the Search page's fields (name, folder, title, artist,
+album), every word required. A group with `search_listed` off in its sealed ack
+is skipped before its index is asked for (§9.11). A file several groups hold is
+one result, keyed by its content hash, and listed from the reader's own node
+first; the others are kept as places. Like Files, and unlike the media views, it
+groups nothing into units.
+
**Deleting** (`rm`) is `file_delete` signed with the machine's key on the node
(§5.4): the node accepts the uploading account's devices and the operator's.
The client checks the same rule against the index first (`uploader_id`, and the
@@ -4587,8 +4596,8 @@ operator CLI and loopback control API, the desktop client through its identity
and download stages, account recovery, the Windows port through packaging, and
the Android client — the shell, native keys, downloads and uploads, casting,
and notifications while it is closed, fetched or pushed (§11.3) — and the
-command-line client: groups, joining and leaving them, listing, downloads and
-uploads with resume, deleting, device linking and approval, browser access, and an
+command-line client: groups, joining and leaving them, listing, search across
+groups, downloads and uploads with resume, deleting, device linking and approval, browser access, and an
interactive two-pane view (§8.6).
The packages install: a machine has been taken from the built artefacts to a
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md
index 5eced69..1fcf0ff 100644
--- a/docs/USERGUIDE.md
+++ b/docs/USERGUIDE.md
@@ -239,6 +239,7 @@ application's full installer on Windows (not with the light one).
meshbay-cli login -u alice # asks for the passphrase
meshbay-cli groups # your groups, their node, your role
meshbay-cli ls -l Family/photos # a group, a folder of it
+meshbay-cli search beach 2024 # every group at once; paths get takes
meshbay-cli get -R Family/photos/2024 # download, here; -o elsewhere
meshbay-cli put -R ~/scans Family/documents
meshbay-cli rm Family/documents/old-draft.odt # asks first; --yes in a script