summaryrefslogtreecommitdiffstats
path: root/docs/USERGUIDE.md
diff options
context:
space:
mode:
authorChristophe Besson <cbesson@gmail.com>2026-10-15 00:56:04 +0200
committerChristophe Besson <cbesson@gmail.com>2026-10-15 00:56:04 +0200
commit6f68bb6c1970e26de1f66c073ea5d7fecd21840d (patch)
tree859c74db5819f1d49046e71a53e12afe5eb4193a /docs/USERGUIDE.md
parent16d92c96bde3a65fc54a93b4662df30cafc831e4 (diff)
downloadmeshbay-6f68bb6c1970e26de1f66c073ea5d7fecd21840d.tar.gz
feat(cli): invitations, join, decline, leave, devices, browser access
join accepts an invitation or redeems a link pasted as sent, then has the node admit a key pair made here, with the invitation's code (a link's code goes only to the node it names; one for a node that is away is kept for the next connection). decline, leave and devices revoke ask first, and refuse without --yes where there is no terminal. devices approve countersigns the one waiting request a code matches, none when several do. browser-access is the application's setting, kept per machine and never enabled from the hub's mirror: on leaves a copy sealed under M on each node, off withdraws it, unset touches nothing. A key pair made for a first contact is now kept. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'docs/USERGUIDE.md')
-rw-r--r--docs/USERGUIDE.md26
1 files changed, 23 insertions, 3 deletions
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md
index 09d264e..d66e757 100644
--- a/docs/USERGUIDE.md
+++ b/docs/USERGUIDE.md
@@ -230,8 +230,8 @@ twice. That window belongs to the application, so nothing displayed in the page
### The command-line client
-`meshbay-cli` reaches your groups' files from a terminal — a server, a script, a
-machine with no desktop. It is a package of its own on Linux (`meshbay-cli`,
+`meshbay-cli` reaches your groups and their files from a terminal — a server,
+a script, a machine with no desktop. It is a package of its own on Linux (`meshbay-cli`,
with a manual page: `man meshbay-cli`), and comes with the desktop
application's full installer on Windows (not with the light one).
@@ -261,7 +261,27 @@ can read, which `login` tells you.
The first time it opens a group, the client may print a linking code instead
of the files: the node holds no copy of your keys (Browser access is off), so
this computer asks to be added as one of your devices. Enter the code in the
-application under *Your devices on this node*; the client goes on by itself.
+application under *Your devices on this node*, or run
+`meshbay-cli devices approve GROUP CODE` on a computer already linked; the
+client goes on by itself.
+
+Joining and leaving work as in the application (§4):
+
+```bash
+meshbay-cli invitations # what you were invited to
+meshbay-cli join Family@bob --code K7P2-9WQX # accept, then give the node its code
+meshbay-cli join 'https://meshbay.org/#/invite?v=1&...' # a link, pasted as sent
+meshbay-cli decline Club@carol
+meshbay-cli leave Club@carol # asks first; --yes in a script
+```
+
+`meshbay-cli devices list GROUP` shows your devices on the node serving a group;
+`devices approve` admits a new one by its code, `devices revoke` retires one.
+
+Like the application, the client keeps your keys to itself: a browser cannot
+open, with your passphrase alone, a group you joined from it. To allow that, as
+*Browser access* does in the application, run `meshbay-cli browser-access on`
+on that computer; `off` takes the copy back. It is that computer's setting.
Managing a node is not the client's job: that is `meshbay-node` (§6).