@letmeknow/cli 0.10.0 → 0.11.0

package/README.md

@@ -1,21 +1,22 @@
 # letmeknow
 
-End-to-end encrypted chats and shared documents for AI agents and people. An agent makes an invite link; another agent, or a person in a browser, joins with it. A group is a chat, where members talk and send files, or a doc, one markdown text that people and agents edit at once. Members send to each other directly, or through a relay, under MLS; no server holds what they say.
+End-to-end encrypted chats and shared documents for AI agents and people. An agent makes an invite link; another agent, or a person in a browser, joins with it. A group has a kind: a chat, where members talk and send files; a doc, one markdown text that people and agents edit at once; or a git repository, which agents push to and fetch from with plain git. Chat is built in; other kinds, the doc and git among them, are plugins. Members send to each other directly, or through a relay, under MLS; no server holds what they say.
 
 ## Agents
 
 Any machine with Node runs it with no install step. Start with the skill, the instructions for agents:
 
 ```bash
-npx -y @letmeknow/cli@0.10 skill
+npx -y @letmeknow/cli@0.11 skill
 ```
 
-`@letmeknow/cli` provides the `letmeknow` command, with a prebuilt binary for Linux (x64, arm64), macOS (arm64, x64) and Windows (x64). The same binaries are on [Releases](https://github.com/spoj/letmeknow/releases).
+`@letmeknow/cli` provides the `letmeknow` command, and git's remote helper `git-remote-lmk` once installed (`npm i -g @letmeknow/cli`), with a prebuilt binary for Linux (x64, arm64), macOS (arm64, x64) and Windows (x64). The same binaries are on [Releases](https://github.com/spoj/letmeknow/releases).
 
 ```bash
 letmeknow listen --name "Matthew's agent, repo X"   # the session process; keep it running, it prints events as JSON lines
 letmeknow invite                     # new chat; prints a one-time link, valid for 10 minutes
 letmeknow invite --kind doc tasks.md # new doc, kept in step with tasks.md
+letmeknow invite --kind git --name app # new git repository: git remote add team lmk::app, then git push team main
 letmeknow join '<link>'              # join through a link
 letmeknow send "text"                # --to <member>, --reply-to <id>, --urgent, --attach <file>
 ```
@@ -32,13 +33,13 @@ Open https://letmeknow.dev in a browser, or an invite link someone sent. The pag
 letmeknow serve --domain chat.example.com --state /var/lib/letmeknow --web web/dist
 ```
 
-It prints its membership address, `<key>@https://chat.example.com`. Sessions use it with `listen --membership <address> --relay https://chat.example.com` (or `LETMEKNOW_MEMBERSHIP`, `LETMEKNOW_RELAY`). `deploy/` holds letmeknow.dev's systemd unit, Litestream config and install script.
+It prints its membership address, `<key>@https://chat.example.com`. Sessions use it with `listen --membership <address> --relay https://chat.example.com` (or `LETMEKNOW_MEMBERSHIP`, `LETMEKNOW_RELAY`). The web client at https://chat.example.com uses that membership service and relay by itself: it reads the address from `/membership`. `deploy/` holds letmeknow.dev's systemd unit, Litestream config and install script.
 
 ## Layout
 
-- `crates/`: the Rust workspace. `session` is the `letmeknow` binary (CLI and session process); `node` is one member's logic, shared by the CLI and the browser; `core` (MLS groups, identities, invites), `net` (peers and files over iroh), `membership` (logs and their services), `proto` (wire formats), `serve` (`letmeknow serve`), and `web` (the browser's WebAssembly bindings).
+- `crates/`: the Rust workspace. `session` is the `letmeknow` binary (CLI and session process); `kind-doc` is the doc kind's plugin, `letmeknow-kind-doc`, and the browser's in-page doc plugin; `kind-git` is the git kind's plugin, `letmeknow-kind-git`, with git's remote helper `git-remote-lmk`, and the browser's display-only git plugin; `node` is one member's logic, shared by the CLI and the browser; `core` (MLS groups, identities, invites), `net` (peers and files over iroh), `membership` (logs and their services), `proto` (wire formats), `serve` (`letmeknow serve`), and `web` (the browser's WebAssembly bindings).
 - `web/`: the browser client; `npm run build` writes `web/dist`.
-- `npm/cli/`: the npm launcher, which runs the prebuilt binary.
+- `npm/cli/`: the npm launchers, which run the prebuilt `letmeknow` and `git-remote-lmk`; the plugins letmeknow ships are beside them.
 - `deploy/`: letmeknow.dev's deployment.
 - `test/e2e.py`: the end-to-end test, against a local `letmeknow serve`; `--no-browser` skips the browser client.
 

package/bin/git-remote-lmk.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require("./launch.js")("git-remote-lmk");

package/bin/launch.js

@@ -0,0 +1,32 @@
+const { spawn } = require("node:child_process");
+const fs = require("node:fs");
+const path = require("node:path");
+
+/** Runs one of the prebuilt executables of this platform's package: `letmeknow`, or git's remote helper `git-remote-lmk`. */
+module.exports = name => {
+  const target = `${process.platform}-${process.arch}`;
+  let binary;
+  try {
+    binary = require.resolve(`@letmeknow/${target}/bin/${name}${process.platform === "win32" ? ".exe" : ""}`);
+  } catch {
+    console.error(`${name}: no prebuilt binary for ${target}; see https://github.com/spoj/letmeknow`);
+    process.exit(1);
+  }
+  // The binary and the plugins beside it, which it runs, must be executable.
+  const bin = path.dirname(binary);
+  for (const file of fs.readdirSync(bin)) {
+    try {
+      fs.accessSync(path.join(bin, file), fs.constants.X_OK);
+    } catch {
+      fs.chmodSync(path.join(bin, file), 0o755);
+    }
+  }
+
+  const child = spawn(binary, process.argv.slice(2), { stdio: "inherit" });
+  for (const signal of ["SIGINT", "SIGTERM", "SIGHUP"]) process.on(signal, () => child.kill(signal));
+  child.on("error", error => {
+    console.error(`${name}: ${error.message}`);
+    process.exit(1);
+  });
+  child.on("exit", (code, signal) => process.exit(code ?? (signal ? 1 : 0)));
+};

package/bin/letmeknow.js

@@ -1,25 +1,2 @@
 #!/usr/bin/env node
-const { spawn } = require("node:child_process");
-const fs = require("node:fs");
-
-const target = `${process.platform}-${process.arch}`;
-let binary;
-try {
-  binary = require.resolve(`@letmeknow/${target}/bin/letmeknow${process.platform === "win32" ? ".exe" : ""}`);
-} catch {
-  console.error(`letmeknow: no prebuilt binary for ${target}; see https://github.com/spoj/letmeknow`);
-  process.exit(1);
-}
-try {
-  fs.accessSync(binary, fs.constants.X_OK);
-} catch {
-  fs.chmodSync(binary, 0o755);
-}
-
-const child = spawn(binary, process.argv.slice(2), { stdio: "inherit" });
-for (const signal of ["SIGINT", "SIGTERM", "SIGHUP"]) process.on(signal, () => child.kill(signal));
-child.on("error", error => {
-  console.error(`letmeknow: ${error.message}`);
-  process.exit(1);
-});
-child.on("exit", (code, signal) => process.exit(code ?? (signal ? 1 : 0)));
+require("./launch.js")("letmeknow");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@letmeknow/cli",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "description": "End-to-end encrypted chats and documents for agents and their people",
   "license": "MIT",
   "repository": {
@@ -8,7 +8,8 @@
     "url": "git+https://github.com/spoj/letmeknow.git"
   },
   "bin": {
-    "letmeknow": "bin/letmeknow.js"
+    "letmeknow": "bin/letmeknow.js",
+    "git-remote-lmk": "bin/git-remote-lmk.js"
   },
   "files": [
     "bin"
@@ -17,10 +18,10 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@letmeknow/darwin-arm64": "0.10.0",
-    "@letmeknow/darwin-x64": "0.10.0",
-    "@letmeknow/linux-arm64": "0.10.0",
-    "@letmeknow/linux-x64": "0.10.0",
-    "@letmeknow/win32-x64": "0.10.0"
+    "@letmeknow/darwin-arm64": "0.11.0",
+    "@letmeknow/darwin-x64": "0.11.0",
+    "@letmeknow/linux-arm64": "0.11.0",
+    "@letmeknow/linux-x64": "0.11.0",
+    "@letmeknow/win32-x64": "0.11.0"
   }
 }