xedoc-cli 0.1.18 → 0.1.20
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 +42 -0
- package/bin/xedoc.mjs +578 -50
- package/build/server/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -33,6 +33,48 @@ Common CLI options:
|
|
|
33
33
|
- `--shared-chat-home <path>` changes where shared Codex chat sessions are stored.
|
|
34
34
|
- `--skip-setup` skips SQLite schema setup.
|
|
35
35
|
|
|
36
|
+
To run xedoc in the background, install the package in a stable location and
|
|
37
|
+
install the service:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install -g xedoc-cli
|
|
41
|
+
xedoc service install --port 6354 --workspace-root ~
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
The default service driver is OS-native:
|
|
45
|
+
|
|
46
|
+
- Linux: user systemd unit at `~/.config/systemd/user/xedoc.service`
|
|
47
|
+
- macOS: launchd agent at `~/Library/LaunchAgents/xedoc.plist`
|
|
48
|
+
- Windows: Task Scheduler task named `xedoc`
|
|
49
|
+
|
|
50
|
+
Inspect the service with the native tool for your OS:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
systemctl --user status xedoc
|
|
54
|
+
journalctl --user -u xedoc -f
|
|
55
|
+
launchctl print gui/$(id -u)/xedoc
|
|
56
|
+
schtasks /Query /TN xedoc
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
On Linux, if the service should start before you log in, enable user lingering
|
|
60
|
+
with `loginctl enable-linger "$USER"`.
|
|
61
|
+
|
|
62
|
+
`forever` is also available as an explicit fallback:
|
|
63
|
+
|
|
64
|
+
```bash
|
|
65
|
+
npm install -g forever
|
|
66
|
+
xedoc service install --service-driver forever
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
The `forever` driver keeps xedoc alive in the current user session, but it does
|
|
70
|
+
not install OS boot integration by itself.
|
|
71
|
+
|
|
72
|
+
To remove the background service:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
xedoc service uninstall
|
|
76
|
+
```
|
|
77
|
+
|
|
36
78
|
For repository development:
|
|
37
79
|
|
|
38
80
|
```bash
|