Skip to content

fix(doc): fix document pnpx to pnpm dlx #216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(doc): fix document pnpx to pnpm dlx #216

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions cli/create-start-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ To maintain compatability with `create-react-app` you can build a new applicatio

| Command | Description |
| ------------------------------------------------------- | ------------------ |
| `pnpx create-start-app@latest my-app` | Create a new app |
| `pnpx create-start-app@latest my-app --framework solid` | Create a Solid app |
| `pnpm dlx create-start-app@latest my-app` | Create a new app |
| `pnpm dlx create-start-app@latest my-app --framework solid` | Create a Solid app |

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

```bash
pnpx create-start-app@latest
pnpm dlx create-start-app@latest
```

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

```bash
pnpx create-start-app@latest my-app --tailwind --package-manager pnpm
pnpm dlx create-start-app@latest my-app --tailwind --package-manager pnpm
```

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

```bash
pnpx create-start-app@latest --add-ons
pnpm dlx create-start-app@latest --add-ons
```

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

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

```bash
pnpx create-start-app@latest my-app --add-ons shadcn,tanstack-query
pnpm dlx create-start-app@latest my-app --add-ons shadcn,tanstack-query
```

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

```bash
pnpx create-start-app@latest --list-add-ons
pnpm dlx create-start-app@latest --list-add-ons
```

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

```bash
pnpx create-start-app@latest --list-add-ons --framework solid
pnpm dlx create-start-app@latest --list-add-ons --framework solid
```

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

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.

```bash
pnpx create-start-app@latest --mcp
pnpm dlx create-start-app@latest --mcp
```

Here is the JSON configuration for MCP support in many MCP clients.
Expand All @@ -107,7 +107,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
{
"mcpServers": {
"create-start-app": {
"command": "pnpx",
"command": "pnpm dlx",
"args": ["create-start-app@latest", "--mcp"]
}
}
Expand Down
32 changes: 16 additions & 16 deletions cli/create-tanstack-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ To maintain compatability with `create-react-app` you can build a new applicatio

| Command | Description |
| --------------------------------------------------------------------------------- | ------------------------------------------------- |
| `pnpx create-tanstack-app@latest my-app` | Create a new app |
| `pnpx create-tanstack-app@latest my-app --template file-router` | Create a new file based app |
| `pnpx create-tanstack-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
| `pnpx create-tanstack-app@latest my-app --tailwind` | Add Tailwind CSS support |
| `pnpx create-tanstack-app@latest my-app --framework solid` | Create a Solid app |
| `pnpx create-tanstack-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
| `pnpm dlx create-tanstack-app@latest my-app` | Create a new app |
| `pnpm dlx create-tanstack-app@latest my-app --template file-router` | Create a new file based app |
| `pnpm dlx create-tanstack-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
| `pnpm dlx create-tanstack-app@latest my-app --tailwind` | Add Tailwind CSS support |
| `pnpm dlx create-tanstack-app@latest my-app --framework solid` | Create a Solid app |
| `pnpm dlx create-tanstack-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |

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

```bash
pnpx create-tanstack-app@latest
pnpm dlx create-tanstack-app@latest
```

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

```bash
pnpx create-tanstack-app@latest my-app --template file-router --tailwind --package-manager pnpm
pnpm dlx create-tanstack-app@latest my-app --template file-router --tailwind --package-manager pnpm
```

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

```bash
pnpx create-tanstack-app@latest my-app --template file-router
pnpm dlx create-tanstack-app@latest my-app --template file-router
```

### Code Based Routing

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:

```bash
pnpx create-tanstack-app@latest my-app --template typescript
pnpm dlx create-tanstack-app@latest my-app --template typescript
```

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

```bash
pnpx create-tanstack-app@latest --add-ons
pnpm dlx create-tanstack-app@latest --add-ons
```

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

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

```bash
pnpx create-tanstack-app@latest my-app --add-ons shadcn,tanstack-query
pnpm dlx create-tanstack-app@latest my-app --add-ons shadcn,tanstack-query
```

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

```bash
pnpx create-tanstack-app@latest --list-add-ons
pnpm dlx create-tanstack-app@latest --list-add-ons
```

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

```bash
pnpx create-tanstack-app@latest --list-add-ons --framework solid --template file-router
pnpm dlx create-tanstack-app@latest --list-add-ons --framework solid --template file-router
```

Will get you a list of all available add-ons for Solid that are compatible with the File Router.
Expand All @@ -139,7 +139,7 @@ Will get you a list of all available add-ons for Solid that are compatible with
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.

```bash
pnpx create-tanstack-app@latest --mcp
pnpm dlx create-tanstack-app@latest --mcp
```

Here is the JSON configuration for MCP support in many MCP clients.
Expand All @@ -148,7 +148,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
{
"mcpServers": {
"create-tanstack-app": {
"command": "pnpx",
"command": "pnpm dlx",
"args": ["create-tanstack-app@latest", "--mcp"]
}
}
Expand Down
32 changes: 16 additions & 16 deletions cli/create-tanstack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ To maintain compatability with `create-react-app` you can build a new applicatio

| Command | Description |
| ----------------------------------------------------------------------------- | ------------------------------------------------- |
| `pnpx create-tanstack@latest my-app` | Create a new app |
| `pnpx create-tanstack@latest my-app --template file-router` | Create a new file based app |
| `pnpx create-tanstack@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
| `pnpx create-tanstack@latest my-app --tailwind` | Add Tailwind CSS support |
| `pnpx create-tanstack@latest my-app --framework solid` | Create a Solid app |
| `pnpx create-tanstack@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
| `pnpm dlx create-tanstack@latest my-app` | Create a new app |
| `pnpm dlx create-tanstack@latest my-app --template file-router` | Create a new file based app |
| `pnpm dlx create-tanstack@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
| `pnpm dlx create-tanstack@latest my-app --tailwind` | Add Tailwind CSS support |
| `pnpm dlx create-tanstack@latest my-app --framework solid` | Create a Solid app |
| `pnpm dlx create-tanstack@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |

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

```bash
pnpx create-tanstack@latest
pnpm dlx create-tanstack@latest
```

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

```bash
pnpx create-tanstack@latest my-app --template file-router --tailwind --package-manager pnpm
pnpm dlx create-tanstack@latest my-app --template file-router --tailwind --package-manager pnpm
```

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

```bash
pnpx create-tanstack@latest my-app --template file-router
pnpm dlx create-tanstack@latest my-app --template file-router
```

### Code Based Routing

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:

```bash
pnpx create-tanstack@latest my-app --template typescript
pnpm dlx create-tanstack@latest my-app --template typescript
```

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

```bash
pnpx create-tanstack@latest --add-ons
pnpm dlx create-tanstack@latest --add-ons
```

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

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

```bash
pnpx create-tanstack@latest my-app --add-ons shadcn,tanstack-query
pnpm dlx create-tanstack@latest my-app --add-ons shadcn,tanstack-query
```

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

```bash
pnpx create-tanstack@latest --list-add-ons
pnpm dlx create-tanstack@latest --list-add-ons
```

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

```bash
pnpx create-tanstack@latest --list-add-ons --framework solid --template file-router
pnpm dlx create-tanstack@latest --list-add-ons --framework solid --template file-router
```

Will get you a list of all available add-ons for Solid that are compatible with the File Router.
Expand All @@ -139,7 +139,7 @@ Will get you a list of all available add-ons for Solid that are compatible with
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.

```bash
pnpx create-tanstack@latest --mcp
pnpm dlx create-tanstack@latest --mcp
```

Here is the JSON configuration for MCP support in many MCP clients.
Expand All @@ -148,7 +148,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
{
"mcpServers": {
"create-tanstack": {
"command": "pnpx",
"command": "pnpm dlx",
"args": ["create-tanstack@latest", "--mcp"]
}
}
Expand Down
32 changes: 16 additions & 16 deletions cli/create-tsrouter-app/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,17 @@ To maintain compatability with `create-react-app` you can build a new applicatio

| Command | Description |
| --------------------------------------------------------------------------------- | ------------------------------------------------- |
| `pnpx create-tsrouter-app@latest my-app` | Create a new app |
| `pnpx create-tsrouter-app@latest my-app --template file-router` | Create a new file based app |
| `pnpx create-tsrouter-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
| `pnpx create-tsrouter-app@latest my-app --tailwind` | Add Tailwind CSS support |
| `pnpx create-tsrouter-app@latest my-app --framework solid` | Create a Solid app |
| `pnpx create-tsrouter-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |
| `pnpm dlx create-tsrouter-app@latest my-app` | Create a new app |
| `pnpm dlx create-tsrouter-app@latest my-app --template file-router` | Create a new file based app |
| `pnpm dlx create-tsrouter-app@latest my-app --template typescript` | Create a new TypeScript app using the Code Router |
| `pnpm dlx create-tsrouter-app@latest my-app --tailwind` | Add Tailwind CSS support |
| `pnpm dlx create-tsrouter-app@latest my-app --framework solid` | Create a Solid app |
| `pnpm dlx create-tsrouter-app@latest my-app --framework solid --template file-router` | Create a Solid app with file-router |

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

```bash
pnpx create-tsrouter-app@latest
pnpm dlx create-tsrouter-app@latest
```

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

```bash
pnpx create-tsrouter-app@latest my-app --template file-router --tailwind --package-manager pnpm
pnpm dlx create-tsrouter-app@latest my-app --template file-router --tailwind --package-manager pnpm
```

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

```bash
pnpx create-tsrouter-app@latest my-app --template file-router
pnpm dlx create-tsrouter-app@latest my-app --template file-router
```

### Code Based Routing

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:

```bash
pnpx create-tsrouter-app@latest my-app --template typescript
pnpm dlx create-tsrouter-app@latest my-app --template typescript
```

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

```bash
pnpx create-tsrouter-app@latest --add-ons
pnpm dlx create-tsrouter-app@latest --add-ons
```

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

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

```bash
pnpx create-tsrouter-app@latest my-app --add-ons shadcn,tanstack-query
pnpm dlx create-tsrouter-app@latest my-app --add-ons shadcn,tanstack-query
```

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

```bash
pnpx create-tsrouter-app@latest --list-add-ons
pnpm dlx create-tsrouter-app@latest --list-add-ons
```

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

```bash
pnpx create-tsrouter-app@latest --list-add-ons --framework solid --template file-router
pnpm dlx create-tsrouter-app@latest --list-add-ons --framework solid --template file-router
```

Will get you a list of all available add-ons for Solid that are compatible with the File Router.
Expand All @@ -139,7 +139,7 @@ Will get you a list of all available add-ons for Solid that are compatible with
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.

```bash
pnpx create-tsrouter-app@latest --mcp
pnpm dlx create-tsrouter-app@latest --mcp
```

Here is the JSON configuration for MCP support in many MCP clients.
Expand All @@ -148,7 +148,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
{
"mcpServers": {
"create-tsrouter-app": {
"command": "pnpx",
"command": "pnpm dlx",
"args": ["create-tsrouter-app@latest", "--mcp"]
}
}
Expand Down
2 changes: 1 addition & 1 deletion cli/ts-create-start/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Here is the JSON configuration for MCP support in many MCP clients.
{
"mcpServers": {
"create-start-app": {
"command": "pnpx",
"command": "pnpm dlx",
"args": ["create-start-app@latest", "--mcp"]
}
}
Expand Down
2 changes: 1 addition & 1 deletion examples/react-cra/blog-starter/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This project uses [Tailwind CSS](https://tailwindcss.com/) for styling.
Add components using the latest version of [Shadcn](https://ui.shadcn.com/).

```bash
pnpx shadcn@latest add button
pnpm dlx shadcn@latest add button
```


Expand Down
Loading