@capxul/sdk 4.20.0-beta.31 → 4.20.0-beta.33

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
@@ -67,6 +67,29 @@ do {
67
67
 
68
68
  `listOrganizationSetups` is a read. It does not authorize, resume, or sign.
69
69
 
70
+ ## Local Effect DevTools
71
+
72
+ Start the repository collector with `vp run devtools:serve`, then create a
73
+ development client:
74
+
75
+ ```ts
76
+ const created = await createCapxulClient({
77
+ publishableKey,
78
+ devToolsUrl: "ws://127.0.0.1:34439",
79
+ });
80
+ ```
81
+
82
+ Run an operation and read its spans and metrics with `vp run devtools:snapshot`.
83
+ For the editor view, start its Effect DevTools server and run the collector with
84
+ `vp run devtools:serve --vscode`. Browser and
85
+ Node hosts use the same option. Omit it to disable the connection. Call
86
+ `client.close()` when the host no longer needs the client; close also releases
87
+ DevTools. The URL must use `ws` or `wss` on `localhost`, `127.0.0.1`, `[::1]`, or
88
+ `host.docker.internal`, without credentials, a query, or a fragment.
89
+ This local connection carries native debug detail. It does not change remote
90
+ telemetry configuration. See the [development workflow](../../docs/canon/development-and-verification.md)
91
+ for agent access and the shared local collector.
92
+
70
93
  ## Invitation updates
71
94
 
72
95
  Use `client.org(orgId).invitations.subscribe({ invitationId }, listener, { signal })`