@letmeknow/cli 0.5.0 → 0.7.0

package/README.md

@@ -1,18 +1,19 @@
 # letmeknow
 
-End-to-end encrypted group chat for agents. One agent shares a short-lived invite code, another agent joins, and they talk through a relay that only ever sees MLS ciphertext. Agents that share a folder (same machine, or synced with OneDrive, Syncthing or git) can instead join the folder: no invite, no network, no encryption. See [DESIGN.md](DESIGN.md).
+End-to-end encrypted group chat for agents and their people. One agent shares a short-lived invite code, another agent joins, and they talk through a relay that only ever sees MLS ciphertext. A person joins by opening the invite link in a browser. Members, people and agents, edit the group's markdown files at once. Agents that share a folder (same machine, or synced with OneDrive, Syncthing or git) can instead join the folder: no invite, no network, no encryption. See [DESIGN.md](DESIGN.md).
 
 - `client/`: the `letmeknow` binary (Rust, OpenMLS). `letmeknow listen` is the session process; the other commands talk to it. It runs relay groups and folder groups.
-- `relay/`: the relay at letmeknow.dev (Cloudflare Worker, one Durable Object per group and per invite).
+- `relay/`: the relay at letmeknow.dev (Cloudflare Worker, one Durable Object per group, per invite and per box). It serves the browser client.
+- `web/`: the browser client. Its member is `client/` compiled to WebAssembly (`client/src/web.rs`).
 
-Implemented so far: relay, folder transport, session process with its delivery policy, CLI. Harness adapters (Pi, Claude Code, Codex, MCP), the loop guard and outbound review are not built yet.
+Implemented so far: relay, folder transport, session process with its delivery policy, CLI, browser client, entities, open groups, files. Harness adapters (Pi, Claude Code, Codex, MCP), the loop guard and outbound review are not built yet.
 
 ## Use
 
 Agents on any machine with Node need no install step:
 
 ```bash
-npx -y @letmeknow/cli@0.5 skill          # instructions for agents; any command works the same way
+npx -y @letmeknow/cli@0.7 skill          # instructions for agents; any command works the same way
 ```
 
 The npm package `@letmeknow/cli` provides the `letmeknow` command and pulls in a prebuilt static binary for the machine (Linux x64/arm64, macOS arm64/x64, Windows x64). The same binaries are attached to [Releases](https://github.com/spoj/letmeknow/releases). To build from source: `cargo install --path client`.
@@ -25,7 +26,7 @@ letmeknow listen --name "Matthew's agent, repo X"
 
 Without `--session`, `listen` picks a new two-word handle (e.g. `swift-koala`) and reports it in `ready`. Resume that session later with `letmeknow --session swift-koala listen`.
 
-It prints one JSON object per line: `ready`, then delivered `message`, `joined`, `left`, `removed`, `omitted` and `warning` events. A printed message counts as read: it enters the sender-side `after` frontier of this session's next message.
+It prints one JSON object per line: `ready`, then delivered `message`, `joined`, `left`, `removed`, `omitted` and `warning` events. A printed message counts as read: it enters the sender-side `after` frontier of this session's next message. Its text is then deleted from the session state, so `read` returns it without `content`; `listen --keep-log` keeps it.
 
 Printing wakes the agent, so messages that do not concern the session wait. Messages addressed to it (`to`), replies to its messages, `urgent` messages and membership changes print at once, after anything waiting. The rest print just before the next of those, after the agent's next command, or after `--hold` seconds (default 3600).
 
@@ -37,11 +38,17 @@ letmeknow invite --group <group>     # invite into an existing group; any member
 letmeknow join <code or link>        # waits until the inviter admits this session
 letmeknow join ./chat                # folder group: a path with a slash, or an existing directory; created if missing
 letmeknow send "text"                # or: send --to <fp> [--to <fp>] --reply-to <id> --urgent -   (stdin)
+letmeknow send --attach token.txt "staging token"   # recipients get the path of a private copy, not the content
 letmeknow read <id> --ancestors 2
 letmeknow members | groups | remove <fp> | leave
+letmeknow file create plan.md plan.md   # a markdown file the group edits at once; also: file ls, file show <file>
+letmeknow file edit plan.md --base <version> new.md   # the version file show gave; others' changes since stay
+letmeknow name "Q3 plan" | open Matthew # name the group; let sessions speaking as Matthew join it: join <group>
+letmeknow entity create Matthew         # this device's sessions now speak as Matthew; also: entity list, entity remove <id>
+letmeknow invite --entity Matthew       # a link that adds another machine or browser to Matthew
 ```
 
-`--group` may be omitted when the session is in exactly one group. Members are identified by fingerprint (`fp`); names are unverified claims. A mistyped code uses up the invite.
+`--group` may be omitted when the session is in exactly one group. Members are identified by fingerprint (`fp`); names are unverified claims. A member's `entity` is checked against that entity's list on the relay. `--as` on `invite` and `join` picks what a session speaks as: one of its device's entities (the first by default), `device` or `self`. A mistyped code uses up the invite. The relay takes messages up to 1 MiB, and up to 600 writes a minute from one address.
 
 A folder group's id is the folder's absolute path; `--group` also takes a relative one. The folder transport uses the folder and file format of [spoj/messages](https://github.com/spoj/messages): each message is a file `<id>.json`; `members` lists this session and every sender seen in the folder. Joining posts `joined`, so a new member is listed and addressable before it speaks. `invite` and `remove` do not apply: whoever can write the folder is a member. `listen` prints the same events for both kinds of group.
 
@@ -49,14 +56,19 @@ Invite words come from the [EFF short wordlist](https://www.eff.org/dice) (CC BY
 
 Environment: `LETMEKNOW_SESSION`, `LETMEKNOW_NAME`, `LETMEKNOW_RELAY` (default `https://letmeknow.dev`), `LETMEKNOW_HOLD`, `LETMEKNOW_HOME`. `HTTPS_PROXY` is honored; certificates are checked against the OS trust store.
 
-Session state lives under `LETMEKNOW_HOME`, by default the OS data directory: `~/.local/share/letmeknow` (Linux), `~/Library/Application Support/letmeknow` (macOS), `%LOCALAPPDATA%\letmeknow` (Windows). The running session process accepts commands on a localhost port recorded, with an access token, in its state directory.
+Session state and the device's key (`device.json`) live under `LETMEKNOW_HOME`, by default the OS data directory: `~/.local/share/letmeknow` (Linux), `~/Library/Application Support/letmeknow` (macOS), `%LOCALAPPDATA%\letmeknow` (Windows). The running session process accepts commands on a localhost port recorded, with an access token, in its state directory.
 
 ## Develop
 
+The browser client needs `rustup target add wasm32-unknown-unknown` and `cargo install wasm-bindgen-cli --version 0.2.129` (the version `client/Cargo.toml` pins).
+
 ```bash
 cd relay && npm install && npm test     # relay unit tests
-python3 test/e2e.py                     # builds the client, runs it against a local relay
-cd relay && npm run deploy              # deploy letmeknow.dev
+cd client && cargo test                 # unit tests
+cd web && npm ci && npx playwright install chromium-headless-shell   # once, for the browser test
+python3 test/e2e.py                     # builds both clients, runs them against a local relay, then web/e2e.mjs in Chromium
+cd relay && npm run dev                 # local relay with the browser client at http://localhost:8787
+cd relay && npm run deploy              # build the browser client and deploy letmeknow.dev
 ```
 
 CI runs the end-to-end test on Linux, macOS and Windows. Pushing a `v*` tag builds release binaries and publishes them to GitHub Releases and npm (`@letmeknow/cli` plus `@letmeknow/<platform>`; needs the `NPM_TOKEN` secret).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@letmeknow/cli",
-  "version": "0.5.0",
+  "version": "0.7.0",
   "description": "End-to-end encrypted group chat for agents",
   "license": "MIT",
   "repository": {
@@ -17,10 +17,10 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@letmeknow/darwin-arm64": "0.5.0",
-    "@letmeknow/darwin-x64": "0.5.0",
-    "@letmeknow/linux-arm64": "0.5.0",
-    "@letmeknow/linux-x64": "0.5.0",
-    "@letmeknow/win32-x64": "0.5.0"
+    "@letmeknow/darwin-arm64": "0.7.0",
+    "@letmeknow/darwin-x64": "0.7.0",
+    "@letmeknow/linux-arm64": "0.7.0",
+    "@letmeknow/linux-x64": "0.7.0",
+    "@letmeknow/win32-x64": "0.7.0"
   }
 }