@posthog/wizard 0.2.8 → 0.2.9
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 +15 -18
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
<img alt="posthoglogo" src="https://user-images.githubusercontent.com/65415371/205059737-c8a4f836-4889-4654-902e-f302b187b6a0.png">
|
|
3
3
|
</p>
|
|
4
4
|
|
|
5
|
-
> **⚠️ Experimental:** This wizard is still in an experimental phase.
|
|
6
|
-
> have any feedback, please drop an email to **joshua** [at] **posthog** [dot] **com**.
|
|
5
|
+
> **⚠️ Experimental:** This wizard is still in an experimental phase.
|
|
6
|
+
> If you have any feedback, please drop an email to **joshua** [at] **posthog** [dot] **com**.
|
|
7
7
|
|
|
8
8
|
<h1>PostHog Wizard</h1>
|
|
9
9
|
<h4>The PostHog Wizard helps you quickly add PostHog to your project.</h4>
|
|
@@ -16,24 +16,21 @@ To use the wizard, you can run it directly using:
|
|
|
16
16
|
npx @posthog/wizard
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Currently the wizard can be used for Next.js only. If you have other platforms
|
|
20
|
-
you would like the wizard to support, please open a
|
|
21
|
-
[GitHub issue](https://github.com/posthog/wizard/issues)!
|
|
19
|
+
Currently the wizard can be used for Next.js only. If you have other platforms you would like the wizard to support, please open a [GitHub issue](https://github.com/posthog/wizard/issues)!
|
|
22
20
|
|
|
23
21
|
# Options
|
|
24
22
|
|
|
25
23
|
The following CLI arguments are available:
|
|
26
24
|
|
|
27
|
-
| Option | Description
|
|
28
|
-
| ----------------- |
|
|
29
|
-
| `--help` | Show help
|
|
30
|
-
| `--version` | Show version number
|
|
31
|
-
| `--debug` | Enable verbose logging
|
|
32
|
-
| `--integration` | Choose the integration to setup
|
|
33
|
-
| `--force-install` | Force install the SDK NPM package (use with caution!)
|
|
34
|
-
| `--install-dir` | Relative path to install in
|
|
35
|
-
| `--region` | PostHog region to use
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
> wizard, which you can find [here](https://github.com/getsentry/sentry-wizard)
|
|
39
|
-
> 💖
|
|
25
|
+
| Option | Description | Type | Default | Choices | Environment Variable |
|
|
26
|
+
| ----------------- | -------------------------------------------------------------------------- | ------- | ------------------------------- | -------------------- | ---------------------------- |
|
|
27
|
+
| `--help` | Show help | boolean | | | |
|
|
28
|
+
| `--version` | Show version number | boolean | | | |
|
|
29
|
+
| `--debug` | Enable verbose logging | boolean | `false` | | `POSTHOG_WIZARD_DEBUG` |
|
|
30
|
+
| `--integration` | Choose the integration to setup | choices | Select integration during setup | "nextjs" | `POSTHOG_WIZARD_INTEGRATION` |
|
|
31
|
+
| `--force-install` | Force install the SDK NPM package (use with caution!) | boolean | `false` | | |
|
|
32
|
+
| `--install-dir` | Relative path to install in | string | `.` | | `POSTHOG_WIZARD_INSTALL_DIR` |
|
|
33
|
+
| `--region` | PostHog region to use | choices | | "us", "eu", "custom" | `POSTHOG_WIZARD_REGION` |
|
|
34
|
+
| `--default` | Select the default option for all questions automatically (where possible) | boolean | `false` | | `POSTHOG_WIZARD_DEFAULT` |
|
|
35
|
+
|
|
36
|
+
> 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) 💖
|
package/package.json
CHANGED