Skip to content

Commit 3c8568d

Browse files
nurazon59nurazon59
authored
fix(doc): fix document pnpx to pnpm dlx (#216)
fix(doc): fix document `pnpm` to `pnpm dlx` Co-authored-by: nurazon59 <[email protected]> Sorry, just took a while.
1 parent 6d04cfe commit 3c8568d

File tree

11 files changed

+65
-65
lines changed

11 files changed

+65
-65
lines changed

‎cli/create-start-app/README.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ To maintain compatability with `create-react-app` you can build a new applicatio
1010

1111
| Command | Description |
1212
| ------------------------------------------------------- | ------------------ |
13-
| `pnpx create-start-app@latest my-app` | Create a new app |
14-
| `pnpx create-start-app@latest my-app --framework solid` | Create a Solid app |
13+
| `pnpm dlx create-start-app@latest my-app` | Create a new app |
14+
| `pnpm dlx create-start-app@latest my-app --framework solid` | Create a Solid app |
1515

1616
If you don't specify a project name, the CLI will walk you through an interactive setup process:
1717

1818
```bash
19-
pnpx create-start-app@latest
19+
pnpm dlx create-start-app@latest
2020
```
2121

2222
This will start an interactive CLI that guides you through the setup process, allowing you to choose:
@@ -31,7 +31,7 @@ This will start an interactive CLI that guides you through the setup process, al
3131
You can also use command line flags to specify your preferences directly:
3232

3333
```bash
34-
pnpx create-start-app@latest my-app --tailwind --package-manager pnpm
34+
pnpm dlx create-start-app@latest my-app --tailwind --package-manager pnpm
3535
```
3636

3737
Available options:
@@ -70,35 +70,35 @@ Setting this flag to `eslint` will configure it as your toolchain of choice, add
7070
You can enable add-on selection:
7171

7272
```bash
73-
pnpx create-start-app@latest --add-ons
73+
pnpm dlx create-start-app@latest --add-ons
7474
```
7575

7676
This will prompt you to select the add-ons you want to enable during application creation.
7777

7878
You can enable specific add-ons directly by adding a comma separated list of add-on names to the `--add-ons` flag. For example:
7979

8080
```bash
81-
pnpx create-start-app@latest my-app --add-ons shadcn,tanstack-query
81+
pnpm dlx create-start-app@latest my-app --add-ons shadcn,tanstack-query
8282
```
8383

8484
You can get a list of all available add-ons by running:
8585

8686
```bash
87-
pnpx create-start-app@latest --list-add-ons
87+
pnpm dlx create-start-app@latest --list-add-ons
8888
```
8989

9090
This will get you a list of all available add-ons for Solid.
9191

9292
```bash
93-
pnpx create-start-app@latest --list-add-ons --framework solid
93+
pnpm dlx create-start-app@latest --list-add-ons --framework solid
9494
```
9595

9696
## MCP (Model Context Protocol) Support (experimental)
9797

9898
You can launch the `create-start-app` CLI with the `--mcp` flag to enable MCP support. Use this in your MCP enabled IDE to allow the Agent model to generate TanStack Start applications.
9999

100100
```bash
101-
pnpx create-start-app@latest --mcp
101+
pnpm dlx create-start-app@latest --mcp
102102
```
103103

104104
Here is the JSON configuration for MCP support in many MCP clients.
@@ -107,7 +107,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
107107
{
108108
"mcpServers": {
109109
"create-start-app": {
110-
"command": "pnpx",
110+
"command": "pnpm dlx",
111111
"args": ["create-start-app@latest", "--mcp"]
112112
}
113113
}

‎cli/create-tanstack-app/README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ To maintain compatability with `create-react-app` you can build a new applicatio
1010

1111
| Command | Description |
1212
| --------------------------------------------------------------------------------- | ------------------------------------------------- |
13-
| `pnpx create-tanstack-app@latest my-app` | Create a new app |
14-
| `pnpx create-tanstack-app@latest my-app --template file-router` | Create a new file based app |
15-
| `pnpx create-tanstack-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
16-
| `pnpx create-tanstack-app@latest my-app --tailwind` | Add Tailwind CSS support |
17-
| `pnpx create-tanstack-app@latest my-app --framework solid` | Create a Solid app |
18-
| `pnpx create-tanstack-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
13+
| `pnpm dlx create-tanstack-app@latest my-app` | Create a new app |
14+
| `pnpm dlx create-tanstack-app@latest my-app --template file-router` | Create a new file based app |
15+
| `pnpm dlx create-tanstack-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
16+
| `pnpm dlx create-tanstack-app@latest my-app --tailwind` | Add Tailwind CSS support |
17+
| `pnpm dlx create-tanstack-app@latest my-app --framework solid` | Create a Solid app |
18+
| `pnpm dlx create-tanstack-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
1919

2020
If you don't specify a project name, the CLI will walk you through an interactive setup process:
2121

2222
```bash
23-
pnpx create-tanstack-app@latest
23+
pnpm dlx create-tanstack-app@latest
2424
```
2525

2626
This will start an interactive CLI that guides you through the setup process, allowing you to choose:
@@ -38,7 +38,7 @@ This will start an interactive CLI that guides you through the setup process, al
3838
You can also use command line flags to specify your preferences directly:
3939

4040
```bash
41-
pnpx create-tanstack-app@latest my-app --template file-router --tailwind --package-manager pnpm
41+
pnpm dlx create-tanstack-app@latest my-app --template file-router --tailwind --package-manager pnpm
4242
```
4343

4444
Available options:
@@ -67,15 +67,15 @@ File Based Routing is the default option when using the interactive CLI. The loc
6767
To explicitly choose File Based Routing, use:
6868

6969
```bash
70-
pnpx create-tanstack-app@latest my-app --template file-router
70+
pnpm dlx create-tanstack-app@latest my-app --template file-router
7171
```
7272

7373
### Code Based Routing
7474

7575
If you prefer traditional code-based routing, you can select it in the interactive CLI or specify it by using either the `typescript` or `javascript` template:
7676

7777
```bash
78-
pnpx create-tanstack-app@latest my-app --template typescript
78+
pnpm dlx create-tanstack-app@latest my-app --template typescript
7979
```
8080

8181
## Additional Configuration
@@ -109,27 +109,27 @@ Setting this flag to `eslint` will configure it as your toolchain of choice, add
109109
You can enable add-on selection:
110110

111111
```bash
112-
pnpx create-tanstack-app@latest --add-ons
112+
pnpm dlx create-tanstack-app@latest --add-ons
113113
```
114114

115115
This will prompt you to select the add-ons you want to enable during application creation.
116116

117117
You can enable specific add-ons directly by adding a comma separated list of add-on names to the `--add-ons` flag. For example:
118118

119119
```bash
120-
pnpx create-tanstack-app@latest my-app --add-ons shadcn,tanstack-query
120+
pnpm dlx create-tanstack-app@latest my-app --add-ons shadcn,tanstack-query
121121
```
122122

123123
You can get a list of all available add-ons by running:
124124

125125
```bash
126-
pnpx create-tanstack-app@latest --list-add-ons
126+
pnpm dlx create-tanstack-app@latest --list-add-ons
127127
```
128128

129129
This will display a list of all available add-ons for React that are compatible with the Code Router.
130130

131131
```bash
132-
pnpx create-tanstack-app@latest --list-add-ons --framework solid --template file-router
132+
pnpm dlx create-tanstack-app@latest --list-add-ons --framework solid --template file-router
133133
```
134134

135135
Will get you a list of all available add-ons for Solid that are compatible with the File Router.
@@ -139,7 +139,7 @@ Will get you a list of all available add-ons for Solid that are compatible with
139139
You can launch the `create-tanstack-app` CLI with the `--mcp` flag to enable MCP support. Use this in your MCP enabled IDE to allow the Agent model to generate TanStack Router applications.
140140

141141
```bash
142-
pnpx create-tanstack-app@latest --mcp
142+
pnpm dlx create-tanstack-app@latest --mcp
143143
```
144144

145145
Here is the JSON configuration for MCP support in many MCP clients.
@@ -148,7 +148,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
148148
{
149149
"mcpServers": {
150150
"create-tanstack-app": {
151-
"command": "pnpx",
151+
"command": "pnpm dlx",
152152
"args": ["create-tanstack-app@latest", "--mcp"]
153153
}
154154
}

‎cli/create-tanstack/README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ To maintain compatability with `create-react-app` you can build a new applicatio
1010

1111
| Command | Description |
1212
| ----------------------------------------------------------------------------- | ------------------------------------------------- |
13-
| `pnpx create-tanstack@latest my-app` | Create a new app |
14-
| `pnpx create-tanstack@latest my-app --template file-router` | Create a new file based app |
15-
| `pnpx create-tanstack@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
16-
| `pnpx create-tanstack@latest my-app --tailwind` | Add Tailwind CSS support |
17-
| `pnpx create-tanstack@latest my-app --framework solid` | Create a Solid app |
18-
| `pnpx create-tanstack@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
13+
| `pnpm dlx create-tanstack@latest my-app` | Create a new app |
14+
| `pnpm dlx create-tanstack@latest my-app --template file-router` | Create a new file based app |
15+
| `pnpm dlx create-tanstack@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
16+
| `pnpm dlx create-tanstack@latest my-app --tailwind` | Add Tailwind CSS support |
17+
| `pnpm dlx create-tanstack@latest my-app --framework solid` | Create a Solid app |
18+
| `pnpm dlx create-tanstack@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
1919

2020
If you don't specify a project name, the CLI will walk you through an interactive setup process:
2121

2222
```bash
23-
pnpx create-tanstack@latest
23+
pnpm dlx create-tanstack@latest
2424
```
2525

2626
This will start an interactive CLI that guides you through the setup process, allowing you to choose:
@@ -38,7 +38,7 @@ This will start an interactive CLI that guides you through the setup process, al
3838
You can also use command line flags to specify your preferences directly:
3939

4040
```bash
41-
pnpx create-tanstack@latest my-app --template file-router --tailwind --package-manager pnpm
41+
pnpm dlx create-tanstack@latest my-app --template file-router --tailwind --package-manager pnpm
4242
```
4343

4444
Available options:
@@ -67,15 +67,15 @@ File Based Routing is the default option when using the interactive CLI. The loc
6767
To explicitly choose File Based Routing, use:
6868

6969
```bash
70-
pnpx create-tanstack@latest my-app --template file-router
70+
pnpm dlx create-tanstack@latest my-app --template file-router
7171
```
7272

7373
### Code Based Routing
7474

7575
If you prefer traditional code-based routing, you can select it in the interactive CLI or specify it by using either the `typescript` or `javascript` template:
7676

7777
```bash
78-
pnpx create-tanstack@latest my-app --template typescript
78+
pnpm dlx create-tanstack@latest my-app --template typescript
7979
```
8080

8181
## Additional Configuration
@@ -109,27 +109,27 @@ Setting this flag to `eslint` will configure it as your toolchain of choice, add
109109
You can enable add-on selection:
110110

111111
```bash
112-
pnpx create-tanstack@latest --add-ons
112+
pnpm dlx create-tanstack@latest --add-ons
113113
```
114114

115115
This will prompt you to select the add-ons you want to enable during application creation.
116116

117117
You can enable specific add-ons directly by adding a comma separated list of add-on names to the `--add-ons` flag. For example:
118118

119119
```bash
120-
pnpx create-tanstack@latest my-app --add-ons shadcn,tanstack-query
120+
pnpm dlx create-tanstack@latest my-app --add-ons shadcn,tanstack-query
121121
```
122122

123123
You can get a list of all available add-ons by running:
124124

125125
```bash
126-
pnpx create-tanstack@latest --list-add-ons
126+
pnpm dlx create-tanstack@latest --list-add-ons
127127
```
128128

129129
This will display a list of all available add-ons for React that are compatible with the Code Router.
130130

131131
```bash
132-
pnpx create-tanstack@latest --list-add-ons --framework solid --template file-router
132+
pnpm dlx create-tanstack@latest --list-add-ons --framework solid --template file-router
133133
```
134134

135135
Will get you a list of all available add-ons for Solid that are compatible with the File Router.
@@ -139,7 +139,7 @@ Will get you a list of all available add-ons for Solid that are compatible with
139139
You can launch the `create-tanstack` CLI with the `--mcp` flag to enable MCP support. Use this in your MCP enabled IDE to allow the Agent model to generate TanStack Router applications.
140140

141141
```bash
142-
pnpx create-tanstack@latest --mcp
142+
pnpm dlx create-tanstack@latest --mcp
143143
```
144144

145145
Here is the JSON configuration for MCP support in many MCP clients.
@@ -148,7 +148,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
148148
{
149149
"mcpServers": {
150150
"create-tanstack": {
151-
"command": "pnpx",
151+
"command": "pnpm dlx",
152152
"args": ["create-tanstack@latest", "--mcp"]
153153
}
154154
}

‎cli/create-tsrouter-app/README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ To maintain compatability with `create-react-app` you can build a new applicatio
1010

1111
| Command | Description |
1212
| --------------------------------------------------------------------------------- | ------------------------------------------------- |
13-
| `pnpx create-tsrouter-app@latest my-app` | Create a new app |
14-
| `pnpx create-tsrouter-app@latest my-app --template file-router` | Create a new file based app |
15-
| `pnpx create-tsrouter-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
16-
| `pnpx create-tsrouter-app@latest my-app --tailwind` | Add Tailwind CSS support |
17-
| `pnpx create-tsrouter-app@latest my-app --framework solid` | Create a Solid app |
18-
| `pnpx create-tsrouter-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
13+
| `pnpm dlx create-tsrouter-app@latest my-app` | Create a new app |
14+
| `pnpm dlx create-tsrouter-app@latest my-app --template file-router` | Create a new file based app |
15+
| `pnpm dlx create-tsrouter-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
16+
| `pnpm dlx create-tsrouter-app@latest my-app --tailwind` | Add Tailwind CSS support |
17+
| `pnpm dlx create-tsrouter-app@latest my-app --framework solid` | Create a Solid app |
18+
| `pnpm dlx create-tsrouter-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
1919

2020
If you don't specify a project name, the CLI will walk you through an interactive setup process:
2121

2222
```bash
23-
pnpx create-tsrouter-app@latest
23+
pnpm dlx create-tsrouter-app@latest
2424
```
2525

2626
This will start an interactive CLI that guides you through the setup process, allowing you to choose:
@@ -38,7 +38,7 @@ This will start an interactive CLI that guides you through the setup process, al
3838
You can also use command line flags to specify your preferences directly:
3939

4040
```bash
41-
pnpx create-tsrouter-app@latest my-app --template file-router --tailwind --package-manager pnpm
41+
pnpm dlx create-tsrouter-app@latest my-app --template file-router --tailwind --package-manager pnpm
4242
```
4343

4444
Available options:
@@ -67,15 +67,15 @@ File Based Routing is the default option when using the interactive CLI. The loc
6767
To explicitly choose File Based Routing, use:
6868

6969
```bash
70-
pnpx create-tsrouter-app@latest my-app --template file-router
70+
pnpm dlx create-tsrouter-app@latest my-app --template file-router
7171
```
7272

7373
### Code Based Routing
7474

7575
If you prefer traditional code-based routing, you can select it in the interactive CLI or specify it by using either the `typescript` or `javascript` template:
7676

7777
```bash
78-
pnpx create-tsrouter-app@latest my-app --template typescript
78+
pnpm dlx create-tsrouter-app@latest my-app --template typescript
7979
```
8080

8181
## Additional Configuration
@@ -109,27 +109,27 @@ Setting this flag to `eslint` will configure it as your toolchain of choice, add
109109
You can enable add-on selection:
110110

111111
```bash
112-
pnpx create-tsrouter-app@latest --add-ons
112+
pnpm dlx create-tsrouter-app@latest --add-ons
113113
```
114114

115115
This will prompt you to select the add-ons you want to enable during application creation.
116116

117117
You can enable specific add-ons directly by adding a comma separated list of add-on names to the `--add-ons` flag. For example:
118118

119119
```bash
120-
pnpx create-tsrouter-app@latest my-app --add-ons shadcn,tanstack-query
120+
pnpm dlx create-tsrouter-app@latest my-app --add-ons shadcn,tanstack-query
121121
```
122122

123123
You can get a list of all available add-ons by running:
124124

125125
```bash
126-
pnpx create-tsrouter-app@latest --list-add-ons
126+
pnpm dlx create-tsrouter-app@latest --list-add-ons
127127
```
128128

129129
This will display a list of all available add-ons for React that are compatible with the Code Router.
130130

131131
```bash
132-
pnpx create-tsrouter-app@latest --list-add-ons --framework solid --template file-router
132+
pnpm dlx create-tsrouter-app@latest --list-add-ons --framework solid --template file-router
133133
```
134134

135135
Will get you a list of all available add-ons for Solid that are compatible with the File Router.
@@ -139,7 +139,7 @@ Will get you a list of all available add-ons for Solid that are compatible with
139139
You can launch the `create-tsrouter-app` CLI with the `--mcp` flag to enable MCP support. Use this in your MCP enabled IDE to allow the Agent model to generate TanStack Router applications.
140140

141141
```bash
142-
pnpx create-tsrouter-app@latest --mcp
142+
pnpm dlx create-tsrouter-app@latest --mcp
143143
```
144144

145145
Here is the JSON configuration for MCP support in many MCP clients.
@@ -148,7 +148,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
148148
{
149149
"mcpServers": {
150150
"create-tsrouter-app": {
151-
"command": "pnpx",
151+
"command": "pnpm dlx",
152152
"args": ["create-tsrouter-app@latest", "--mcp"]
153153
}
154154
}

‎cli/ts-create-start/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
107107
{
108108
"mcpServers": {
109109
"create-start-app": {
110-
"command": "pnpx",
110+
"command": "pnpm dlx",
111111
"args": ["create-start-app@latest", "--mcp"]
112112
}
113113
}

‎examples/react-cra/blog-starter/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This project uses [Tailwind CSS](https://tailwindcss.com/) for styling.
3636
Add components using the latest version of [Shadcn](https://ui.shadcn.com/).
3737

3838
```bash
39-
pnpx shadcn@latest add button
39+
pnpm dlx shadcn@latest add button
4040
```
4141

4242

0 commit comments

Comments
 (0)