Skip to content

Commit 9ccd0eb

Browse files
committed
docs: simplify how to run the wizard in development
Document running it against a project with '--cwd' directly, rather than explaining the default of setting up this repository and working up to the flag from there. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01W1qhuuZQZnA1FB1fBSxrqx
1 parent 689c9d9 commit 9ccd0eb

1 file changed

Lines changed: 4 additions & 20 deletions

File tree

README.md

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -120,35 +120,19 @@ $ npm install
120120
$ npm run test:watch
121121
```
122122

123-
Run the wizard locally with
123+
Run the wizard locally against a project with
124124

125125
```
126-
$ npm run wizard
126+
$ npm run wizard -- --cwd <project>
127127
```
128128

129129
This runs the development CLI in `src/bin/cli.ts`,
130130
which simply calls the wizard with the arguments given.
131131
That file exists for local development only:
132132
it is excluded from the build and from the published package.
133133

134-
Because the wizard sets up whichever project it is run in,
135-
`npm run wizard` sets up this repository itself,
136-
which is rarely what you want.
137-
Run it against a scratch project instead with
138-
139-
```
140-
$ npm run wizard -- --cwd /tmp/scratch
141-
```
142-
143-
`--cwd` is a development convenience of that CLI, not an argument of the
144-
wizard: it becomes the `cwd` option.
145-
Every other argument is forwarded to the wizard untouched, so
146-
147-
```
148-
$ npm run wizard -- --help
149-
```
150-
151-
reaches the wizard as `--help`.
134+
`--cwd` is an option of that CLI, which becomes the wizard's `cwd`.
135+
Every other argument is forwarded to the wizard untouched.
152136

153137
### Source layout
154138

0 commit comments

Comments
 (0)