@dorokuma/herdsman 0.13.2 → 0.13.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 +4 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -31,6 +31,8 @@ herdsman help
|
|
|
31
31
|
|
|
32
32
|
### Install from source
|
|
33
33
|
|
|
34
|
+
This path is for local development only; it is not a production install channel.
|
|
35
|
+
|
|
34
36
|
Source builds also require pnpm >= 11.9.0.
|
|
35
37
|
|
|
36
38
|
```bash
|
|
@@ -46,7 +48,7 @@ herdsman help
|
|
|
46
48
|
|
|
47
49
|
Herdsman agent commands and Pi notifications require the daemon. The daemon watches all running Herdr sessions reported by `herdr session list --json`, rescans them every 60 seconds, and does not index stopped Herdr sessions. Runtime files live in `~/.herdsman` by default. Set `HERDSMAN_HOME` to use another directory.
|
|
48
50
|
|
|
49
|
-
On the production host the daemon is managed by the systemd unit `herdsman.service`, which keeps it running: use `systemctl restart herdsman.service` to restart it. There are no CLI start/stop/restart commands. `herdsman daemon status` reports the daemon state in either case.
|
|
51
|
+
On the production host the package is installed from the npm registry (`npm install --global @dorokuma/herdsman@<version>`), and the daemon is managed by the systemd unit `herdsman.service`, which keeps it running: use `systemctl restart herdsman.service` to restart it. Install it with the same Node.js toolchain the unit uses, and prefix the command with that toolchain's `bin` on `PATH`, e.g. `PATH="$HOME/.nvm/versions/node/v22.23.1/bin:$PATH" npm install --global @dorokuma/herdsman@<version>`, so the global prefix matches the unit's (the production unit pins nvm v22.23.1). On a host that mixes `nvm` and `mise`, omitting the prefix can install into a different global prefix. There are no CLI start/stop/restart commands. `herdsman daemon status` reports the daemon state in either case.
|
|
50
52
|
|
|
51
53
|
For development or verification, run the entrypoint in the foreground with an explicit temporary data directory, so the production data directory is not used as scratch space:
|
|
52
54
|
|
|
@@ -128,7 +130,7 @@ Set `filter_upstream_errors: false` to restore waking on every outcome. `HERDSMA
|
|
|
128
130
|
Install the optional plugin from the GitHub release tag:
|
|
129
131
|
|
|
130
132
|
```bash
|
|
131
|
-
herdr plugin install dorokuma/herdsman/packages/herdsman-herdr-plugin --ref v0.13.
|
|
133
|
+
herdr plugin install dorokuma/herdsman/packages/herdsman-herdr-plugin --ref v0.13.3 --yes
|
|
132
134
|
```
|
|
133
135
|
|
|
134
136
|
Use the release tag that matches the installed Herdsman CLI version.
|