@sentrial/sdk 0.5.0 → 0.6.0

package/README.md

@@ -79,6 +79,32 @@ sentrial evaluate <experiment-id> --min-score 80
 > `SENTRIAL_API_KEY`, or `sentrial login`) carries that scope, or the CI gate
 > will fail with a 403.
 
+### Guided setup and delivery checks
+
+Setup and Doctor require `@sentrial/sdk` 0.6.0 or later. Start in your agent project:
+
+```bash
+npx -p @sentrial/sdk@0.6.0 sentrial setup --dry-run --json
+npx -p @sentrial/sdk@0.6.0 sentrial setup
+# Coding agents / CI: set SENTRIAL_API_KEY privately first.
+npx -p @sentrial/sdk@0.6.0 sentrial setup --yes --non-interactive --json
+npx -p @sentrial/sdk@0.6.0 sentrial doctor --workspace <organization-uuid> --json
+npx -p @sentrial/sdk@0.6.0 sentrial doctor --session <session-uuid> --json
+```
+
+Setup verifies workspace read access, inspects installed dependencies and creates an integration
+example while preserving existing files. A prompted key is hidden and is not saved. It does not
+execute the example or call a model. Keep the key in your agent runtime, adapt the example to your
+agent, run it, then use Doctor to inspect its session ID. Python-only projects can use
+`python -m sentrial.cli setup` from Python SDK 0.8.0 without Node.
+
+Doctor's `ready_for_instrumentation` result verifies read access, not delivery. `trace_verified`
+means this completed trace's source-numbered events were read back without reported gaps or
+inspection warnings. It does not establish business success, application-wide coverage or signal
+accuracy. Session listing needs `sessions:read`; delivery readback also needs `events:read` and
+an API deployment supporting `/api/v1/sessions/<id>/health`. Both reads share one bounded
+`--timeout-ms` deadline (100–30000 ms). Redirects are refused; reports omit trace content and keys.
+
 ## Quick Start (30 seconds)
 
 ### Option 1: Auto-Wrap LLM Clients (Recommended)