diff options
Diffstat (limited to 'docs/USERGUIDE.md')
| -rw-r--r-- | docs/USERGUIDE.md | 29 |
1 files changed, 28 insertions, 1 deletions
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md index 93205d3..6035a1e 100644 --- a/docs/USERGUIDE.md +++ b/docs/USERGUIDE.md @@ -248,6 +248,8 @@ meshbay-cli get -R Family/photos/2024 # download, here; -o elsewhere meshbay-cli stream --player vlc 'Family/films/Night Drive.mkv' # play it; Ctrl+C stops meshbay-cli put -R ~/scans Family/documents meshbay-cli rm Family/documents/old-draft.odt # asks first; --yes in a script +meshbay-cli mkdir --parents Family/documents/2026/taxes +meshbay-cli rm -r Family/documents/2019 # a folder and all it holds meshbay-cli logout ``` @@ -259,7 +261,8 @@ run the same `get`. `stream` plays a film or a song without downloading it: it prints an address to open in VLC or mpv (or starts the player with `--player`), which works on this computer only and until you press Ctrl+C or close the player; skipping ahead in the player works. `rm` deletes what you uploaded, from any of your devices; -the node's operator can delete anything. Run `meshbay-cli` with nothing after it for a two-pane +the node's operator can delete anything, and only the operator removes a +folder (`rm -r`, which says how many files go before it asks). Run `meshbay-cli` with nothing after it for a two-pane view: this computer on the left, your groups on the right, F5 to copy the selection across, Delete to delete it from the group (what `rm` may delete). @@ -294,6 +297,30 @@ 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. +Your account, from the client: + +```bash +meshbay-cli account # name, e-mail address, status +meshbay-cli account register -u alice --email alice@example.org +meshbay-cli account passphrase # change it; asks the current one, then the new +meshbay-cli account reset -u alice --email alice@example.org # forgotten: a code by e-mail +meshbay-cli account email new@example.org +meshbay-cli account sign-out-everywhere +meshbay-cli account delete +``` + +`register` prints your recovery key once: keep it apart from your passphrase, +it is what gives your groups back after a `reset`. Changing the passphrase +carries the copy of your keys each node keeps for browsers over to the new one +first; a node out of reach is carried the next time this computer connects to it. + +Tab completes actions, options and the paths in your groups once the shell +knows how. In bash, add `eval "$(meshbay-cli completion bash)"` to `~/.bashrc` +(the Linux packages install it already); in PowerShell, add +`meshbay-cli completion powershell | Out-String | Invoke-Expression` to your +`$PROFILE`. It never asks for anything: on a computer that is not signed in, +it completes actions and options only. + Managing a node is not the client's job: that is `meshbay-node` (§6). --- |