bavitutor 0.3.1 → 0.3.3

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 CHANGED
@@ -83,12 +83,38 @@ vpx /path/to/bavitutor --no-open # vpx takes the same specs and flags
83
83
  | `--host <host>` | `127.0.0.1` | interface to listen on (this machine only) |
84
84
  | `--data-dir <dir>` | `~/.bavitutor` | database, plus settings in `<dir>/.env` |
85
85
  | `--no-open` | | don't open the browser |
86
+ | `--tailscale` | | also share it on your tailnet (see below) |
86
87
 
87
88
  On start the CLI checks for a Claude login or `ANTHROPIC_API_KEY`, looks for
88
89
  Chrome (`BAVI_CHROME`, then the standard Windows, macOS and Linux locations)
89
90
  and warns if either is missing, and stops with a clear message if the port is
90
91
  taken.
91
92
 
93
+ ### Open it on your other devices
94
+
95
+ ```sh
96
+ npx bavitutor --tailscale
97
+ ```
98
+
99
+ With `--tailscale`, BaviTutor also shares itself on your
100
+ [Tailscale](https://tailscale.com) tailnet, so your phone or another computer
101
+ can open it:
102
+
103
+ ```text
104
+ BaviTutor is running at http://localhost:4100 (Ctrl+C to stop)
105
+ on your tailnet at https://laptop.tail1234.ts.net:4100
106
+ ```
107
+
108
+ It runs `tailscale serve` over HTTPS on the same port number, so anything you
109
+ already serve on 443 stays as it is. Only devices on your tailnet can reach it
110
+ (it is not Funnel), and the share stops when BaviTutor stops. Anyone on your
111
+ tailnet can use it, on your Claude login.
112
+
113
+ It needs Tailscale installed and logged in, with MagicDNS and HTTPS
114
+ Certificates turned on (admin console, DNS page). If something is missing,
115
+ BaviTutor says what to fix and still runs on this computer. If BaviTutor is
116
+ already running, `--tailscale` shares that one until you press Ctrl+C.
117
+
92
118
  ### Configuration (environment, `apps/server/.env` in dev, `<data-dir>/.env` for the CLI)
93
119
 
94
120
  | Variable | Default | Meaning |