@posthog/wizard 2.10.4 → 2.12.0

package/README.md

@@ -2,11 +2,14 @@
   <img alt="posthoglogo" src="https://user-images.githubusercontent.com/65415371/205059737-c8a4f836-4889-4654-902e-f302b187b6a0.png">
 </p>
 
-> **⚠️ Experimental:** This wizard is still in an experimental phase. If you
+
 > have any feedback, please drop an email to **[wizard@posthog.com](mailto:wizard@posthog.com)**.
 
 <h1>PostHog wizard ✨</h1>
-<h4>The PostHog wizard helps you quickly add PostHog to your project using AI.</h4>
+
+The PostHog wizard helps you quickly add PostHog to your project using AI.
+
+![Wizard clip](https://res.cloudinary.com/dmukukwp6/image/upload/q_auto,f_auto/pasted_image_2026_05_01_T19_53_26_002_Z_398f697f5c.png)
 
 # Usage
 
@@ -16,10 +19,11 @@ To use the wizard, you can run it directly using:
 npx @posthog/wizard
 ```
 
-Currently the wizard can be used for **React, NextJS, Svelte, Astro and React
-Native** projects. If you have other integrations you would like the wizard to
+Currently the wizard can be used for over 16 frameworks for frontend, backend, and mobile applications. If you have other integrations you would like the wizard to
 support, please open a [GitHub issue](https://github.com/posthog/wizard/issues)!
 
+Visit our [docs](https://posthog.com/docs/ai-engineering/ai-wizard) to learn more. 
+
 ## MCP Commands
 
 The wizard also includes commands for managing PostHog MCP (Model Context
@@ -44,6 +48,46 @@ npx @posthog/wizard revenue
 Requires PostHog and Stripe SDKs already installed. Supports `--ci` with the
 same flags as the main wizard.
 
+## Headless signup + install (agents / CI)
+
+For a fully non-interactive first-run (no existing PostHog account, no TTY,
+no browser), combine `--ci --signup --email`. The wizard provisions a new
+account, uses the returned personal API key to run the normal CI install,
+and wires PostHog into the project at `--install-dir`:
+
+```bash
+npx @posthog/wizard --ci --signup \
+  --email you@example.com \
+  --install-dir .
+```
+
+Optional flags: `--name "Your Name"`, `--region eu` (default `us`),
+`--integration nextjs` (else auto-detected).
+
+### Provision only
+
+If you just want credentials — for tests, pre-flight checks, or wiring up
+PostHog yourself — use the `provision` subcommand, which emits a structured
+`ProvisioningResult` and does nothing else:
+
+```bash
+# Human-readable (when stdout is a TTY)
+npx @posthog/wizard provision --email user@example.com --region us
+
+# Machine-readable — auto when stdout is piped, or force with --json
+npx @posthog/wizard provision --email user@example.com --region eu --json
+```
+
+Success prints the full `ProvisioningResult` (`projectApiKey`, `host`,
+`projectId`, `accountId`, `accessToken`, `refreshToken`, and
+`personalApiKey` if present). Failure exits 1; in `--json` mode the error
+is emitted to stderr as `{"error":"...","code":"..."}`, with `code` set to
+`email_exists` when the address is already registered.
+
+> ⚠️ **Output contains live credentials.** Pipe it into a secrets store —
+> do not let it be captured by shared CI logs. Mask the step output or
+> redirect stdout to a file your job reads and discards.
+
 # Options
 
 The following CLI arguments are available:
@@ -62,9 +106,6 @@ The following CLI arguments are available:
 | `--ci`            | Enable CI mode for non-interactive execution                     | boolean | `false` |                                                      | `POSTHOG_WIZARD_CI`            |
 | `--api-key`       | PostHog personal API key (phx_xxx) for authentication            | string  |         |                                                      | `POSTHOG_WIZARD_API_KEY`       |
 
-> Note: A large amount of the scaffolding for this came from the amazing Sentry
-> wizard, which you can find [here](https://github.com/getsentry/sentry-wizard)
-> 💖
 
 # CI Mode