Skip to content

Commit 169e083

Browse files
committed
more readme update
1 parent 081a572 commit 169e083

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ below it:
2525
| `peergos-cbor` | A byte-exact CBOR codec whose map ordering and integer encoding match the Java client bit-for-bit (required for content-addressing and signatures). |
2626
| `peergos-multiformats` | CIDv1 / multihash / multibase encoding and the base58/base32 alphabets Peergos uses. |
2727
| `peergos-core` | The network layer: the content-addressed block store client, mutable pointers (signed CAS), the CHAMP hash-array-mapped-trie, the buffered-write network decorator, and direct-to-S3 block access. |
28-
| `peergos-fs` | The cryptree filesystem: files and directories, capabilities, sharing and revocation, social features, publishing, upload transactions, and the ergonomic `FileWrapper` / `UserContext` handles. |
28+
| `peergos-fs` | The cryptree filesystem: files and directories, capabilities, sharing and revocation, social features, email, publishing, upload transactions, and the ergonomic `FileWrapper` / `UserContext` handles. |
29+
| `peergos-sync` | Bidirectional local ↔ remote directory sync, mirroring the Java `DirectorySync`: content-hashed state diffing, batched transfers, and optional deletion propagation. |
30+
| `peergos-cli` | The interactive `peergos-shell` — a login (or secret-link) session with remote and local working directories and the same command set as the Java shell. |
31+
| `peergos-mock-server` | An in-process Peergos server used to drive the end-to-end tests without a live backend. |
2932

3033
## What it does
3134

@@ -38,6 +41,12 @@ below it:
3841
- **Secret links** — create and resolve password-protected shareable links.
3942
- **Social** — follow requests, friends/followers groups, a social feed with posts,
4043
comments and media, and per-user profiles.
44+
- **Email** — an end-to-end encrypted email bridge: encrypt, outbox, inbox and sent
45+
folders over the Peergos email protocol.
46+
- **Sync** — bidirectional local ↔ remote directory sync with content-hashed change
47+
detection, batched transfers, and optional deletion propagation.
48+
- **Interactive shell**`peergos-shell`, a login or secret-link session with paired
49+
remote/local working directories and the same commands as the Java CLI.
4150
- **Publishing** — make files public and serve a website through the Peergos gateway.
4251
- **Efficient reads** — the server-side `champ/get` lookup returns a whole tree path
4352
in one round-trip, and every returned block is re-hashed and re-resolved locally so
@@ -88,6 +97,25 @@ cargo run -p peergos-fs --example resume_upload -- http://localhost:7777/
8897
There are runnable examples for most features — sharing, revocation, secret links,
8998
social/feed, publishing, the buffered network, upload transactions, and more.
9099

100+
### Interactive shell
101+
102+
`peergos-shell` mirrors the Java `peergos.server.cli`: a login (or secret-link)
103+
session with a remote and a local working directory, and commands such as
104+
`ls`/`lls`, `get`/`put`, `mkdir`, `rm`, `cd`/`lcd`, `pwd`/`lpwd`, `space`, `follow`,
105+
`share_read`, `share_write`, `link`, and `passwd`, with command history and line
106+
editing.
107+
108+
```sh
109+
# log in and drop into the shell
110+
cargo run -p peergos-cli -- --server http://localhost:7777/ --username alice
111+
112+
# cache the session to ~/.peergos-shell/session.cbor so later runs skip login
113+
cargo run -p peergos-cli -- --username alice --stay-logged-in
114+
115+
# open the shell over a set of secret links, each mounted at its true path
116+
cargo run -p peergos-cli -- --links LINK1,LINK2
117+
```
118+
91119
## Using it as a library
92120

93121
`UserContext` is the top-level handle; `FileWrapper` is an ergonomic file/directory

0 commit comments

Comments
 (0)