Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/router/how-to/integrate-shadcn-ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This guide covers setting up Shadcn/ui with TanStack Router, including solutions
**Option 1: New project with TanStack Router template**

```bash
npx create-tsrouter-app@latest my-app --template file-router --tailwind --add-ons shadcn
npx @tanstack/cli create my-app --add-ons shadcn
```

**Option 2: Add to existing TanStack Router project**
Expand Down
2 changes: 1 addition & 1 deletion docs/router/how-to/setup-ssr.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: How to Set Up Server-Side Rendering (SSR)
## Quick Start with TanStack Start

```bash
npx create-tsrouter-app@latest my-app --template start
npx @tanstack/cli create my-app
cd my-app
npm run dev
```
Expand Down
17 changes: 10 additions & 7 deletions docs/router/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The fastest way to get started with TanStack Router is to scaffold a new project

<!-- ::start:tabs variant="package-managers" mode="local-install" -->

react: create-tsrouter-app@latest
solid: create-tsrouter-app@latest --framework solid
react: npx @tanstack/cli create
solid: npx @tanstack/cli create --framework solid

<!-- ::end:tabs -->

Expand All @@ -25,7 +25,7 @@ The CLI will guide you through a short series of prompts to customize your setup
Once complete, a new project will be generated with TanStack Router installed and ready to use.

> [!TIP]
> For full details on available options and templates, visit the [`create-tsrouter-app` documentation](https://github.com/TanStack/create-tsrouter-app/tree/main/cli/create-tsrouter-app).
> For full details on available options and templates, visit the [`@tanstack/cli` documentation](https://tanstack.com/cli/latest/docs/quick-start).

## Routing Options

Expand All @@ -37,19 +37,22 @@ The file-based approach is the recommended option for most projects. It automati

<!-- ::start:tabs variant="package-manager" mode="local-install" -->

react: create-tsrouter-app@latest my-app --template file-router
solid: create-tsrouter-app@latest my-app --framework solid --template file-router
react: npx @tanstack/cli create my-app
solid: npx @tanstack/cli create my-app --framework solid

<!-- ::end:tabs -->

### Code-Based Route Configuration

If you prefer to define routes programmatically, you can use the code-based route configuration. This approach gives you full control over routing logic.

> [!NOTE]
> When using `@tanstack/cli create`, you'll be prompted to choose between file-based and code-based routing during interactive setup. Select **"code-router"** when asked about the routing mode.

<!-- ::start:tabs variant="package-manager" mode="local-install" -->

react: create-tsrouter-app@latest my-app
solid: create-tsrouter-app@latest my-app --framework solid
react: npx @tanstack/cli create my-app
solid: npx @tanstack/cli create my-app --framework solid

<!-- ::end:tabs -->

Expand Down
4 changes: 2 additions & 2 deletions docs/start/framework/react/tutorial/fetching-external-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,13 @@ The complete code for this tutorial is available on [GitHub](https://github.com/
First, let's create a new TanStack Start project:

```bash
pnpx create-start-app movie-discovery
pnpx @tanstack/cli create movie-discovery
cd movie-discovery
```

When this script runs, it will ask you a few setup questions. You can either pick choices that work for you or just press enter to accept the defaults.

Optionally, you can pass in a `--add-on` flag to get options such as Shadcn, Clerk, Convex, TanStack Query, etc.
Optionally, you can pass in a `--add-ons` flag to get options such as Shadcn, Clerk, Convex, TanStack Query, etc.

Once setup is complete, install dependencies and start the development server:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ cd devjokes

When this script runs, it will ask you a few setup questions. You can either pick choices that work for you or just press enter to accept the defaults.

Optionally, you can pass in a `--add-on` flag to get options such as Shadcn, Clerk, Convex, TanStack Query, etc.
Optionally, you can pass in a `--add-ons` flag to get options such as Shadcn, Clerk, Convex, TanStack Query, etc.

Once setup is complete, install dependencies and start the development server:

Expand Down
5 changes: 1 addition & 4 deletions examples/react/i18n-paraglide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="/favicon.ico" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-tsrouter-app"
/>
<meta name="description" content="Web site created using TanStack CLI" />
<link rel="apple-touch-icon" href="/logo192.png" />
<link rel="manifest" href="/manifest.json" />
<title>Create TanStack App - i18n-paraglide</title>
Expand Down
2 changes: 1 addition & 1 deletion examples/react/start-bun/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ npx gitpick TanStack/router/tree/main/examples/react/start-bun start-bun
This project was created with TanStack Start:

```bash
bunx create-start-app@latest
bunx @tanstack/cli create
```

Install dependencies:
Expand Down
5 changes: 1 addition & 4 deletions examples/solid/i18n-paraglide/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<link rel="icon" href="/favicon.ico" />
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Web site created using create-tsrouter-app"
/>
<meta name="description" content="Web site created using TanStack CLI" />
<link rel="apple-touch-icon" href="/logo192.png" />
<link rel="manifest" href="/manifest.json" />
<title>Create TanStack App - i18n-paraglide</title>
Expand Down
2 changes: 1 addition & 1 deletion examples/solid/start-bun/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ An optimized production server for TanStack Start applications using Bun, implem
This project was created with TanStack Start:

```bash
bunx create-start-app@latest
bunx @tanstack/cli create
```

Install dependencies:
Expand Down
Loading