@useorgx/wizard 0.1.48 → 0.1.51

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
@@ -26,8 +26,9 @@ The wizard modifies local tool configuration only. Depending on the command, it
26
26
  ## Commands
27
27
 
28
28
  - `setup` adds OrgX MCP configs, standalone skills/rules, and companion plugins to detected AI tools. When OrgX auth is available in an interactive shell, it guides workspace selection or creation, can create the user's first live OrgX initiative, creates a starter onboarding task under that initiative, and prints a handoff prompt for the configured AI tool of choice. The founder preset preplans plugin installs before it writes standalone skills so plugin-backed hosts do not get duplicate standalone assets in the same run.
29
- - `work-graph profile --from all --publish --public-share` runs AQ from recent AI-work receipts, publishes a redacted profile, and prints the first AQ-lifting repair to execute next.
30
- - `work-graph preview --from all` shows the AQ readout locally without publishing.
29
+ - `work-graph profile --from all --publish --public-share` runs AQ from recent AI-work receipts, publishes a redacted profile, and prints a four-signal operating profile plus the first AQ-lifting repair to execute next.
30
+ - Every profile or preview writes both the full evidence report and a compact, machine-safe `work-graph-agent-brief-*.md` with provenance, the growth edge, and a ready prompt for the smallest verifiable repair.
31
+ - `work-graph preview --from all` shows the same profile story locally without publishing.
31
32
  - `work-graph runtime-event --source codex|claude --summary "..."` lets an agent write public-safe runtime evidence that the next AQ profile can collect.
32
33
  - `surface list` shows supported surfaces and current status.
33
34
  - `surface add <name>` patches a specific surface.
@@ -38,6 +39,7 @@ The wizard modifies local tool configuration only. Depending on the command, it
38
39
  - `plugins remove [target...]` uninstalls the managed Cursor plugin bundle, legacy managed Cursor rules, and managed OrgX companion plugins from Claude Code, Codex, and/or OpenClaw.
39
40
  - `uninstall` removes OrgX-managed tool config, companion plugins, legacy managed Cursor rules, wizard-local auth, and wizard-local setup state. Use `--keep-auth`, `--keep-state`, `--skip-plugins`, or `--skip-surfaces` to preserve specific pieces.
40
41
  - `doctor` verifies local config, hosted MCP reachability, npm registry readiness, current-workspace connectivity, local OpenClaw health, and optionally the remote setup status API. Hosted MCP tools are OAuth-scoped inside the client connector, so the wizard does not preflight them with `oxk_` API keys. It exits non-zero when blocking connectivity issues remain.
42
+ - `doctor --workload <path|-> [--json]` is a separate, account-free path that reads a credential-free workload-shape JSON document from a file or stdin (`-`) and makes exactly one unauthenticated request to the public Workload Doctor. It does not load an API key, run health checks, emit telemetry, or create wizard state. Input is rejected before upload when it is invalid, credential-shaped, or larger than 16 KiB. Production uses `https://useorgx.com`; `--base-url <url>` is an explicit testing/self-hosted override and requires HTTPS except for loopback hosts.
41
43
  - `auth status` shows the resolved OrgX API key source and verifies it against `POST /api/client/sync`.
42
44
  - `auth login [--base-url <url>]` starts browser pairing against OrgX, waits for approval, saves the returned per-user key to the wizard auth store, and bootstraps OpenClaw auth if OpenClaw is detected. Use `--api-key <oxk_...>` for CI or blocked-browser fallback.
43
45
  - `auth set-key <oxk_...> [--base-url <url>]` verifies a per-user OrgX key, saves it to the wizard auth store, and bootstraps OpenClaw auth if OpenClaw is detected.
@@ -54,11 +56,24 @@ The wizard modifies local tool configuration only. Depending on the command, it
54
56
  - `auth set-key <oxk_...>` can be driven with `ORGX_BASE_URL` in CI when the target OrgX API is not production.
55
57
  - The intended verification baseline for changes is `pnpm test`, `pnpm typecheck`, and `pnpm build`.
56
58
 
59
+ ## Anonymous Telemetry
60
+
61
+ The wizard sends anonymous setup and verification outcomes to OrgX so release
62
+ health can be measured across supported CLI and plugin surfaces. Events use a
63
+ random installation identifier and coarse outcome metadata; they do not include
64
+ API keys, prompts, command output, file contents, or workspace paths.
65
+
66
+ The account-free `doctor --workload` path is excluded from wizard telemetry and
67
+ does not create or read the wizard installation identifier.
68
+
69
+ Set `ORGX_TELEMETRY_DISABLED=1` or `ORGX_TELEMETRY_ENABLED=0` to opt out.
70
+
57
71
  ## Auth Notes
58
72
 
59
73
  - The wizard uses per-user `oxk_...` keys for auth verification and local bootstrap. `auth login` now prefers secure browser pairing and falls back to direct key entry with `--api-key`.
60
74
  - When `keytar` is available, the wizard stores the raw API key in the system keychain and keeps only metadata in `auth.json`. If `keytar` is unavailable or disabled, it falls back to file-backed storage in `auth.json`.
61
75
  - `doctor` always checks `https://mcp.useorgx.com/health` and resolves the current workspace through the OrgX API. Hosted MCP tool calls are verified by the configured client connector after its OAuth flow completes, not by the wizard's per-user `oxk_` key.
76
+ - `doctor --workload` does not run those authenticated checks; it only submits the bounded workload shape to `https://useorgx.com/api/v1/doctor/workload` (or the explicit safe `--base-url` override).
62
77
  - `doctor` also checks npm registry reachability for `@useorgx/wizard` and reports whether the package is already published.
63
78
  - Remote setup status is separate: `doctor` checks `/api/setup/status` only when `ORGX_SERVICE_KEY` is present because that endpoint is still service-key-only.
64
79
  - Auth resolution order is `ORGX_API_KEY`, then the wizard auth store, then OpenClaw config.