opsidian 0.1.0 → 0.1.24
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 +12 -1
- package/dist/opsidian.mjs +5706 -878
- package/package.json +9 -8
package/README.md
CHANGED
|
@@ -16,6 +16,14 @@ npx opsidian host invite "Personal"
|
|
|
16
16
|
|
|
17
17
|
Scan the code it prints with the Opsidian app, or type the address and code. A name the host has not seen makes a new notebook.
|
|
18
18
|
|
|
19
|
+
## Keep notebooks on GitHub
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
npx opsidian host github import you/notes
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
makes a notebook from a GitHub repository (an Obsidian vault kept with git, say) and invites a device to it. `host github connect "Personal"` keeps an existing notebook in a repository instead. Either way it goes both ways from then on: changes reach GitHub within a minute, and edits made on GitHub come back to every device. Signing in shows a code to enter at github.com/login/device, so it works on a server without a browser. Needs git.
|
|
26
|
+
|
|
19
27
|
## Keep it private
|
|
20
28
|
|
|
21
29
|
The host has no sign-in of its own, so it should only be reachable by your devices. Install [Tailscale](https://tailscale.com) on the host and on each device: the host then listens only on its Tailscale address, and syncs from anywhere. Without Tailscale, a Mac uses your home network; a server refuses to start unless you choose an address with `--address`.
|
|
@@ -27,11 +35,14 @@ The host has no sign-in of its own, so it should only be reachable by your devic
|
|
|
27
35
|
| `host start [--port 4810] [--address IP] [--backup DIR]` | Runs the host in the background, now and after restarts |
|
|
28
36
|
| `host status` | Whether it is running, where, and what it holds |
|
|
29
37
|
| `host invite "Name"` | A single-use invitation to a notebook, valid for 15 minutes |
|
|
30
|
-
| `host devices` / `host
|
|
38
|
+
| `host devices` / `host remove DEVICE` | Every device; stop one syncing, by its name or id |
|
|
31
39
|
| `host notebooks` | Every notebook on the host |
|
|
32
40
|
| `host backup DIR` / `now` / `off` | Back up every night at 3 and once now; back up now; stop |
|
|
33
41
|
| `host backups` / `host restore BACKUP` | The backups there are; put the host back to one |
|
|
34
42
|
| `host logs [-f]` | What the host has been doing |
|
|
43
|
+
| `host github import you/notes` | A new notebook from a GitHub repository, and an invitation |
|
|
44
|
+
| `host github connect "Name" [REPO]` | Keep a notebook in a GitHub repository, both ways |
|
|
45
|
+
| `host github` / `sync` / `disconnect` / `logout` | How each is doing; sync now; stop; forget the sign-in |
|
|
35
46
|
| `host stop` | Stops it, and stops it starting by itself |
|
|
36
47
|
| `host uninstall [--delete-data]` | Removes it; your notebooks stay unless you say otherwise |
|
|
37
48
|
| `host run` | Runs in the terminal instead, for Docker or to watch it |
|