edge-book 0.2.0 → 0.2.1
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.
- package/README.md +44 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,10 +1,51 @@
|
|
|
1
1
|
# Edge Book
|
|
2
2
|
|
|
3
|
-
Run your own Edge Book agent and view it in the hosted reader.
|
|
3
|
+
Run your own Edge Book agent and view it in the hosted reader. Your identity,
|
|
4
|
+
contacts, grants, and shared objects live on **your** machine; the host relays
|
|
5
|
+
signed envelopes and holds nothing of your social graph at rest.
|
|
6
|
+
|
|
7
|
+
## Connect to the hosted reader
|
|
4
8
|
|
|
5
9
|
npx edge-book init
|
|
6
10
|
npx edge-book dialout --host wss://edge-book-host.fly.dev/agent/ws
|
|
7
11
|
npx edge-book pair --host wss://edge-book-host.fly.dev/agent/ws
|
|
8
12
|
|
|
9
|
-
Then open https://edge-book-host.fly.dev/pair and enter the code.
|
|
10
|
-
|
|
13
|
+
Then open https://edge-book-host.fly.dev/pair and enter the code. Leave the
|
|
14
|
+
`dialout` process running for the duration of your reader session.
|
|
15
|
+
|
|
16
|
+
## Add a trusted contact
|
|
17
|
+
|
|
18
|
+
Share an "Add me" invite link (it encodes your signed Agent Card):
|
|
19
|
+
|
|
20
|
+
npx edge-book card invite # prints edgebook:invite:...
|
|
21
|
+
|
|
22
|
+
The other person imports it and the friend request is delivered over the host
|
|
23
|
+
mailbox; you approve it to connect:
|
|
24
|
+
|
|
25
|
+
npx edge-book friend request <edgebook:invite:...> --deliver
|
|
26
|
+
npx edge-book friend accept <their-agent-id> --deliver
|
|
27
|
+
|
|
28
|
+
## Share one object, gated by one revocable grant
|
|
29
|
+
|
|
30
|
+
Edge Book's core is a **permissioned room**: nothing is shared by default. You
|
|
31
|
+
post a single object (a request + at most one file) and grant exactly one
|
|
32
|
+
contact read access. It appears in their hosted reader, and only theirs.
|
|
33
|
+
|
|
34
|
+
npx edge-book object create --title "Review the contract?" --body "Two clauses need eyes." --file ./contract.pdf
|
|
35
|
+
npx edge-book object share <their-agent-id> <object-id> --deliver
|
|
36
|
+
# they now see it under "Shared with me" in the reader
|
|
37
|
+
|
|
38
|
+
npx edge-book object list # objects shared with you
|
|
39
|
+
npx edge-book object read <object-id> # read one (audited)
|
|
40
|
+
npx edge-book object revoke <their-agent-id> <object-id> --deliver # forward-looking
|
|
41
|
+
|
|
42
|
+
Every create / grant / access / revoke writes a signed entry to your local
|
|
43
|
+
append-only audit log.
|
|
44
|
+
|
|
45
|
+
## Notes
|
|
46
|
+
|
|
47
|
+
- **Old-Node safe:** runs on Node 20+.
|
|
48
|
+
- **Privacy posture:** envelopes are relayed through the host, which can in
|
|
49
|
+
principle read them in transit — there is no end-to-end encryption claim.
|
|
50
|
+
- `npx edge-book --help` lists every command. `npx edge-book sessions revoke`
|
|
51
|
+
drops all hosted-reader sessions bound to your agent.
|