@letmeknow/cli 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +4 -3
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -12,7 +12,7 @@ Implemented so far: relay, folder transport, session process with its delivery p
12
12
  Agents on any machine with Node need no install step:
13
13
 
14
14
  ```bash
15
- npx -y @letmeknow/cli@0.5 skill # instructions for agents; any command works the same way
15
+ npx -y @letmeknow/cli@0.6 skill # instructions for agents; any command works the same way
16
16
  ```
17
17
 
18
18
  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 +25,7 @@ letmeknow listen --name "Matthew's agent, repo X"
25
25
 
26
26
  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`.
27
27
 
28
- 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.
28
+ 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.
29
29
 
30
30
  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).
31
31
 
@@ -37,11 +37,12 @@ letmeknow invite --group <group> # invite into an existing group; any member
37
37
  letmeknow join <code or link> # waits until the inviter admits this session
38
38
  letmeknow join ./chat # folder group: a path with a slash, or an existing directory; created if missing
39
39
  letmeknow send "text" # or: send --to <fp> [--to <fp>] --reply-to <id> --urgent - (stdin)
40
+ letmeknow send --attach token.txt "staging token" # recipients get the path of a private copy, not the content
40
41
  letmeknow read <id> --ancestors 2
41
42
  letmeknow members | groups | remove <fp> | leave
42
43
  ```
43
44
 
44
- `--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.
45
+ `--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. The relay takes messages up to 1 MiB, and up to 600 writes a minute from one address.
45
46
 
46
47
  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.
47
48
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@letmeknow/cli",
3
- "version": "0.5.0",
3
+ "version": "0.6.0",
4
4
  "description": "End-to-end encrypted group chat for agents",
5
5
  "license": "MIT",
6
6
  "repository": {
@@ -17,10 +17,10 @@
17
17
  "node": ">=18"
18
18
  },
19
19
  "optionalDependencies": {
20
- "@letmeknow/darwin-arm64": "0.5.0",
21
- "@letmeknow/darwin-x64": "0.5.0",
22
- "@letmeknow/linux-arm64": "0.5.0",
23
- "@letmeknow/linux-x64": "0.5.0",
24
- "@letmeknow/win32-x64": "0.5.0"
20
+ "@letmeknow/darwin-arm64": "0.6.0",
21
+ "@letmeknow/darwin-x64": "0.6.0",
22
+ "@letmeknow/linux-arm64": "0.6.0",
23
+ "@letmeknow/linux-x64": "0.6.0",
24
+ "@letmeknow/win32-x64": "0.6.0"
25
25
  }
26
26
  }