Quick Start

The fastest way to get started with TanStack Router is to scaffold a new project. Just run:

npx create-tsrouter-app@latest

pnpx create-tsrouter-app@latest

yarn dlx create-tsrouter-app@latest

bunx create-tsrouter-app@latest

The CLI will guide you through a short series of prompts to customize your setup, including options for:

• File-based or code-based route configuration
• TypeScript support
• Tailwind CSS integration
• Toolchain setup
• Git initialization

Once complete, a new project will be generated with TanStack Router installed and ready to use.

TanStack Router supports both file-based and code-based route configurations. You can specify your preference during the CLI setup, or use these commands directly:

The file-based approach is the recommended option for most projects. It automatically creates routes based on your file structure, giving you the best mix of performance, simplicity, and developer experience.

npx create-tsrouter-app@latest my-app --template file-router

pnpx create-tsrouter-app@latest my-app --template file-router

yarn dlx create-tsrouter-app@latest my-app --template file-router

bunx create-tsrouter-app@latest my-app --template file-router

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

npx create-tsrouter-app@latest my-app

pnpx create-tsrouter-app@latest my-app

yarn dlx create-tsrouter-app@latest my-app

bunx create-tsrouter-app@latest my-app

With either approach, navigate to your project directory and start the development server.

If you have an existing React project and want to add TanStack Router to it, you can install it manually.

Before installing TanStack Router, please ensure your project meets the following requirements:

TanStack Router is currently only compatible with React (with ReactDOM) and Solid. If you're interested in contributing to support other frameworks, such as React Native, Angular, or Vue, please reach out to us on Discord.

To install TanStack Router in your project, run the following command using your preferred package manager:

npm i @tanstack/react-router

pnpm add @tanstack/react-router

yarn add @tanstack/react-router

bun add @tanstack/react-router

Once installed, you can verify the installation by checking your package.json file for the dependency.

{
  "dependencies": {
    "@tanstack/react-router": "^x.x.x"
  }
}