You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-33Lines changed: 33 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,39 +21,6 @@ Currently the wizard can be used for **React, NextJS, Svelte and React Native**
21
21
projects. If you have other integrations you would like the wizard to support,
22
22
please open a [GitHub issue](https://github.com/posthog/wizard/issues)!
23
23
24
-
## Testing Locally
25
-
26
-
To test your local changes to the wizard in a different project:
27
-
28
-
1.**Build the wizard:**
29
-
Navigate to the root directory of this wizard project and build it:
30
-
```bash
31
-
pnpm build
32
-
```
33
-
This compiles the TypeScript code and prepares the `dist` directory. Run this command any time you make changes to the wizard's source code.
34
-
35
-
2. **Make the wizard available to other projects:**
36
-
In the wizard's project directory, run:
37
-
```bash
38
-
pnpm link --global
39
-
```
40
-
This command makes your local version of the wizard available system-wide. You generally only need to do this once, or if you've unlinked it or made changes to `package.json` that affect the package's global registration.
41
-
42
-
4. **Run the Wizard:**
43
-
Now, from the root directory of your test project, you can run the wizard using its command:
44
-
```bash
45
-
wizard [options]
46
-
```
47
-
For example:
48
-
```bash
49
-
wizard --integration nextjs
50
-
```
51
-
or simply:
52
-
```bash
53
-
wizard
54
-
```
55
-
The wizard will execute using your local code. Changes made in the wizard's source directory (and rebuilt with `pnpm build`) will be reflected immediately.
56
-
57
24
# Options
58
25
59
26
The following CLI arguments are available:
@@ -112,6 +79,39 @@ This also allows us to pick up the bill on behalf of our customers.
112
79
113
80
When we make improvements to this process, these are available instantly to all users of the wizard, no training delays or other ambiguity.
114
81
82
+
## Testing locally
83
+
84
+
To test your local changes to the wizard in a different project:
85
+
86
+
1.**Build the wizard:**
87
+
Navigate to the root directory of this wizard project and build it:
88
+
```bash
89
+
pnpm build
90
+
```
91
+
This compiles the TypeScript code and prepares the `dist` directory. Run this command any time you make changes to the wizard's source code.
92
+
93
+
2. **Make the wizard available to other projects:**
94
+
In the wizard's project directory, run:
95
+
```bash
96
+
pnpm link --global
97
+
```
98
+
This command makes your local version of the wizard available system-wide. You generally only need to do this once, or if you've unlinked it or made changes to `package.json` that affect the package's global registration.
99
+
100
+
4. **Run the wizard:**
101
+
Now, from the root directory of your test project, you can run the wizard using its command:
102
+
```bash
103
+
wizard [options]
104
+
```
105
+
For example:
106
+
```bash
107
+
wizard --integration nextjs
108
+
```
109
+
or simply:
110
+
```bash
111
+
wizard
112
+
```
113
+
The wizard will execute using your local code. Changes made in the wizard's source directory (and rebuilt with `pnpm build`) will be reflected immediately.
114
+
115
115
## Publishing your tool
116
116
117
117
To make your version of a tool usable with a one-line `npx` command:
0 commit comments