shmup/colabbd
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update docs for persistence support

Browse source
This commit is contained in:
Jared Miller 2026-01-27 21:32:19 -05:00
parent 9d9234173c
commit 883c4f9b28
Signed by: shmup
GPG key ID: 22B5C6D66A38B06C
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
CLAUDE.md
View file

@ -15,7 +15,6 @@ working:
not yet: not yet:
- cursor/selection sync (awareness protocol stubbed but unused) - cursor/selection sync (awareness protocol stubbed but unused)
- other editor adapters (helix, kakoune, zed) - other editor adapters (helix, kakoune, zed)
- persistence (rooms are ephemeral)
- reconnection handling - reconnection handling
## stack ## stack
@ -28,9 +27,10 @@ not yet:
## running ## running
```bash ```bash
just dev # daemon on :4040 just dev # daemon on :4040
bun test # unit tests COLLABD_DB=path.db just dev # custom db path (default: collabd.db)
just check # biome lint bun test # unit tests
just check # biome lint
``` ```
## vim adapter usage ## vim adapter usage
@ -66,6 +66,7 @@ server -> client:
- src/index.ts - websocket server, room routing - src/index.ts - websocket server, room routing
- src/session.ts - yjs doc per room, peer management - src/session.ts - yjs doc per room, peer management
- src/protocol.ts - message types - src/protocol.ts - message types
- src/db.ts - sqlite persistence, save/load crdt updates
- adapters/vim/bridge.ts - bun process vim spawns - adapters/vim/bridge.ts - bun process vim spawns
- adapters/vim/collab.vim - vim9script plugin - adapters/vim/collab.vim - vim9script plugin
@ -95,7 +96,6 @@ known gaps (not production ready):
- room names guessable via brute force - room names guessable via brute force
- no encryption (deploy behind wss, not ws) - no encryption (deploy behind wss, not ws)
- no audit logging - no audit logging
- no persistence (data lost on daemon restart)
before production: before production:
1. auth layer (jwt tokens or unix socket for local-only) 1. auth layer (jwt tokens or unix socket for local-only)