@saptools/cf-inspector 0.8.1 → 0.9.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 CHANGED
@@ -63,6 +63,35 @@ cf-inspector --version
63
63
 
64
64
  ---
65
65
 
66
+ ## Updates
67
+
68
+ Every command first checks npm for a newer `@saptools/cf-inspector` (at most once an hour, one small request
69
+ with a 2-second timeout) and, when one exists, installs that exact version with the package manager
70
+ that owns the running binary and re-runs the command you typed on the new version. Both steps are
71
+ announced on stderr; nothing is printed when the install is already current:
72
+
73
+ ```text
74
+ cf-inspector: updating 0.9.0 -> 0.10.0 ...
75
+ cf-inspector: updated to 0.10.0; re-running the command
76
+ ```
77
+
78
+ If the install cannot complete, one stderr line gives the manual command and the command runs on the
79
+ installed version; that version is not retried for a day. `cf-inspector self-update` forces the check and
80
+ install now; `cf-inspector self-update --check` only reports.
81
+
82
+ | Control | Effect |
83
+ | --- | --- |
84
+ | `SAPTOOLS_AUTO_UPDATE=on\|notify\|off` | `on` (default) installs and re-runs; `notify` prints the manual command once per version; `off` never checks. Applies to every `@saptools` CLI. |
85
+ | `CF_INSPECTOR_AUTO_UPDATE` | same values, this CLI only; wins over the global variable |
86
+ | `SAPTOOLS_UPDATE_INTERVAL_MINUTES` | minutes between checks (default `60`; `0` checks on every run) |
87
+ | `SAPTOOLS_NPM_REGISTRY` | registry to check and install from (default: npm's configured registry, then npmjs) |
88
+ | `SAPTOOLS_UPDATE_DEBUG=1` | explain on stderr why nothing happened |
89
+
90
+ The updater switches itself off in CI (`CI` set), under `NODE_ENV=test` or `NO_UPDATE_NOTIFIER`, when
91
+ the binary runs from a source checkout, an `npm link` or an `npx` cache, and inside the re-run itself.
92
+ It never writes to stdout, never asks for input, never uses `sudo`, and never moves onto a prerelease.
93
+ Its state lives in `~/.saptools/updates/`.
94
+
66
95
  ## 🚀 Quick Start
67
96
 
68
97
  ### Cloud Foundry app (auto-tunnel)