remosidian 0.1.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.
- package/README.md +65 -0
- package/dist/remosidian.mjs +28678 -0
- package/package.json +27 -0
package/README.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# remosidian
|
|
2
|
+
|
|
3
|
+
Remote, read/write access to your Obsidian vault over WebSocket — from any device, on any
|
|
4
|
+
network. Pair once with a QR code, then read, write, search, and subscribe to changes from
|
|
5
|
+
phones, tablets, or other machines.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm i -g remosidian
|
|
11
|
+
# or
|
|
12
|
+
cd ~/Documents/MyVault
|
|
13
|
+
npx remosidian
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
User-facing commands should prefer the unscoped `remosidian` package.
|
|
17
|
+
|
|
18
|
+
## Quick start
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
# 1. Create ~/.remosidian/config.json interactively
|
|
22
|
+
remosidian init
|
|
23
|
+
|
|
24
|
+
# 2. Start the daemon in the foreground
|
|
25
|
+
remosidian start
|
|
26
|
+
|
|
27
|
+
# 3. (from another terminal) inspect the running daemon
|
|
28
|
+
remosidian status
|
|
29
|
+
|
|
30
|
+
# Or just point it at a vault directly, no config file needed:
|
|
31
|
+
cd ~/Documents/MyVault
|
|
32
|
+
remosidian
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
When the daemon starts it prints a pairing QR code. Scan it from a Remosidian-aware client
|
|
36
|
+
(e.g. the LifeOS mobile app) within 5 minutes to authorize the device. The pair token is
|
|
37
|
+
stored in `~/.remosidian/pairings.json` and reused on subsequent connections.
|
|
38
|
+
|
|
39
|
+
## Commands
|
|
40
|
+
|
|
41
|
+
| Command | Purpose |
|
|
42
|
+
| --------------------------- | --------------------------------------------------- |
|
|
43
|
+
| `remosidian` | Run the current directory as a vault. |
|
|
44
|
+
| `remosidian start` | Run the daemon in the foreground (Ctrl+C to stop). |
|
|
45
|
+
| `remosidian pair` | Open a fresh pairing window and print a QR code. |
|
|
46
|
+
| `remosidian status` | Print the running daemon's health snapshot. |
|
|
47
|
+
| `remosidian reset-pairings` | Revoke every paired device (local request only). |
|
|
48
|
+
| `remosidian init` | Generate `~/.remosidian/config.json` interactively. |
|
|
49
|
+
| `remosidian --version` | Print the installed version. |
|
|
50
|
+
|
|
51
|
+
## Data directory
|
|
52
|
+
|
|
53
|
+
By default, Remosidian stores identity, pairings, and the QR PNG under `~/.remosidian/`.
|
|
54
|
+
Override with `--data-dir <path>` or the `REMOSIDIAN_HOME` environment variable.
|
|
55
|
+
|
|
56
|
+
## Protocol
|
|
57
|
+
|
|
58
|
+
WebSocket + JSON messages defined in [`@lifeos/remosidian-protocol`](https://www.npmjs.com/package/@lifeos/remosidian-protocol).
|
|
59
|
+
Operations: `vault.list`, `vault.read`, `vault.resolveLink`, `vault.backlinks`,
|
|
60
|
+
`vault.search`, `vault.recent`, `vault.subscribe`, `vault.unsubscribe`. Server pushes
|
|
61
|
+
`vault.changed` events to subscribed clients.
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
MIT — see the LICENSE file in the repository root.
|