@@ -120,13 +120,24 @@ endpoint or stored login.
120120| ` SIM_CREDENTIALS_FILE ` | Relocate only the credentials file |
121121| ` SIM_TIMEOUT_SECONDS ` | Per-request timeout; ` 0 ` waits indefinitely. Defaults to ` 3600 ` , above every timeout the server itself applies |
122122| ` SIM_DEBUG ` | Trace each request's method, URL, status and duration to stderr |
123- | ` SIM_NO_UPDATE_CHECK ` | Turn off update checks |
123+ | ` SIM_NO_UPDATE_CHECK ` | Turn off update checks and notices |
124124
125- ## Update notices
125+ ## Updates
126126
127- The CLI checks for a newer release at most once per day on eligible interactive
128- invocations. Notices go to stderr and show an upgrade command for the package
129- manager that installed Sim.
127+ The CLI checks for a newer stable release at most once per day on eligible
128+ interactive invocations. It prints an optional notice to stderr and continues
129+ your command. Installation only happens when you run ` sim update ` .
130+
131+ Run ` sim update ` to update immediately, including in CI and when automatic checks
132+ are disabled. It requires a global installation and verifies that the package
133+ manager targets the running copy before installing. Supported managers are npm,
134+ pnpm, Bun, and Yarn Classic. For custom installations, select the manager with
135+ ` sim update --package-manager bun ` . Project-local and temporary package-runner
136+ copies must be updated through their package manager.
137+
138+ Manual updates preserve the stable, staging, or dev release channel. Installation
139+ failures stop with an error; concurrent update attempts are refused. Installer
140+ output goes to stderr and does not mix with JSON output on stdout.
130141
131142Checks are skipped in CI, when stderr is redirected, under ` npm exec ` or ` npx ` ,
132143from a repository checkout, and for prerelease versions. Set
@@ -141,7 +152,9 @@ malformed non-empty values disable the check. Redirects are not followed.
141152The daily cache is ` ~/.sim/update-check.json ` , or under ` SIM_CONFIG_DIR ` .
142153` SIM_CONFIG_FILE ` and ` SIM_CREDENTIALS_FILE ` do not relocate it. If the cache
143154cannot be written, eligible invocations may check again. Concurrent commands
144- can also each check. Requests have a one-second deadline.
155+ can also each check. Registry checks have a one-second deadline; package-manager
156+ installation has a five-minute deadline. Registry-check failures suppress the
157+ check, while installer failures are reported.
145158
146159Node's ` fetch ` uses ` HTTP(S)_PROXY ` when opted in with ` NODE_USE_ENV_PROXY=1 `
147160(Node 22.21+ or 24.0+) or ` --use-env-proxy ` (Node 22.21+ or 24.5+).
0 commit comments