caveat-cli 0.19.13 → 0.20.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
@@ -146,6 +146,15 @@ are `ack <cursor>`, `resolve <fingerprint>`, `reopen <fingerprint>`, and
146
146
  boolean `true` keeps collection disabled. Runtime state lives under Caveat's
147
147
  own state directory, independently of the knowledge index and host hook files.
148
148
 
149
+ Nothing is sent anywhere by default and the package contains no destination.
150
+ To report to a collector you operate, also set
151
+ `"runtimeErrorReportCredentialFile"` to the absolute path of the credential
152
+ file it issued (`url`, `key_id`, `secret`; readable only by you). Reports are
153
+ HMAC-signed, carry only the fixed error records, and are acknowledged locally
154
+ only after a signed receipt. Use `caveat runtime-errors report --json` to send
155
+ now and `caveat runtime-errors report-status --json` to see the last outcome.
156
+ See the repository README for the wire format and retry intervals.
157
+
149
158
  ## Requirements
150
159
 
151
160
  - Node 22.5+ (for built-in `node:sqlite`)