Skip to content

Use @tanstack/cli for creating Tanstack Start application#6829

Open
rxssula wants to merge 1 commit intoTanStack:mainfrom
rxssula:quick-start/cli
Open

Use @tanstack/cli for creating Tanstack Start application#6829
rxssula wants to merge 1 commit intoTanStack:mainfrom
rxssula:quick-start/cli

Conversation

@rxssula
Copy link

@rxssula rxssula commented Mar 5, 2026

Replace deprecated npm create @tanstack/start@latest with npx @tanstack/cli create my-app

Summary by CodeRabbit

  • Documentation
    • Updated React getting started and quick-start guides with new CLI command syntax for project creation across npm and pnpm package managers.

@github-actions github-actions bot added the documentation Everything documentation related label Mar 5, 2026
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 5, 2026

📝 Walkthrough

Walkthrough

Updated TanStack Start CLI command syntax in React documentation files. The recommended project creation command changed from npm create @tanstack/start@latest to npx @tanstack/cli create my-app, with similar updates for pnpm package manager.

Changes

Cohort / File(s) Summary
React Documentation CLI Updates
docs/start/framework/react/getting-started.md, docs/start/framework/react/quick-start.md
Updated CLI invocation examples for project creation, replacing npm create @tanstack/start@latest with npx @tanstack/cli create my-app and pnpm create @tanstack/start@latest with pnpx @tanstack/cli create my-app.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~5 minutes

Poem

🐰 Hop, hop! The docs now say
A newer way to start the day
From create to cli we've grown,
Commands fresh, like garden shone! 🌱

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check ✅ Passed The title 'Use @tanstack/cli for creating Tanstack Start application' directly and clearly summarizes the main change: updating documentation to use the @tanstack/cli command for project creation instead of the deprecated approach.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/start/framework/react/quick-start.md`:
- Around line 10-18: The two fenced command blocks in the React quick-start
markdown are missing language identifiers; update both triple-backtick fences
around the commands "pnpx `@tanstack/cli` create my-app" and "npx `@tanstack/cli`
create my-app" to use ```bash so they include the bash language identifier
(e.g., change ``` to ```bash for each block) to satisfy markdownlint MD040 and
improve rendering consistency.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f101422b-ff58-41f9-8063-ae50c73c9a88

📥 Commits

Reviewing files that changed from the base of the PR and between 64dee75 and 657c4bf.

📒 Files selected for processing (2)
  • docs/start/framework/react/getting-started.md
  • docs/start/framework/react/quick-start.md

Comment on lines 10 to 18
```
pnpm create @tanstack/start@latest
pnpx @tanstack/cli create my-app
```

or

```
npm create @tanstack/start@latest
npx @tanstack/cli create my-app
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add language identifiers to fenced command blocks.

Both command snippets are missing a fence language (bash), which triggers markdownlint MD040 and hurts rendering consistency.

Suggested patch
-```
+```bash
 pnpx `@tanstack/cli` create my-app

@@
- +bash
npx @tanstack/cli create my-app

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
pnpm create @tanstack/start@latest
pnpx @tanstack/cli create my-app
```
or
```
npm create @tanstack/start@latest
npx @tanstack/cli create my-app
```
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 10-10: Fenced code blocks should have a language specified

(MD040, fenced-code-language)


[warning] 16-16: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/start/framework/react/quick-start.md` around lines 10 - 18, The two
fenced command blocks in the React quick-start markdown are missing language
identifiers; update both triple-backtick fences around the commands "pnpx
`@tanstack/cli` create my-app" and "npx `@tanstack/cli` create my-app" to use
```bash so they include the bash language identifier (e.g., change ``` to
```bash for each block) to satisfy markdownlint MD040 and improve rendering
consistency.

@github-actions
Copy link

github-actions bot commented Mar 5, 2026

Bundle Size Benchmarks

  • Commit: 64dee75088e3
  • Measured at: 2026-03-05T21:05:54.039Z
  • Baseline source: history:64dee75088e3
  • Dashboard: bundle-size history
Scenario Current (gzip) Delta vs baseline Raw Brotli Trend
react-router.minimal 86.84 KiB 0 B (0.00%) 273.33 KiB 75.44 KiB ▁▁▁▁▁▁▁▁▁██
react-router.full 89.88 KiB 0 B (0.00%) 283.67 KiB 78.18 KiB ▁▁▁▁▁▁▁▁▁██
solid-router.minimal 36.17 KiB 0 B (0.00%) 108.44 KiB 32.49 KiB ▁▁▁▁▁▁▁▁▁██
solid-router.full 40.50 KiB 0 B (0.00%) 121.49 KiB 36.40 KiB ▁▁▁▁▁▁▁▁▁██
vue-router.minimal 52.03 KiB 0 B (0.00%) 148.42 KiB 46.71 KiB ▁▁▁▁▁▁▁▁▁██
vue-router.full 56.85 KiB 0 B (0.00%) 164.01 KiB 51.04 KiB ▁▁▁▁▁▁▁▁▁██
react-start.minimal 99.40 KiB 0 B (0.00%) 312.48 KiB 85.98 KiB ▁▁▁▁▁▁▁▁▁██
react-start.full 102.78 KiB 0 B (0.00%) 322.29 KiB 88.82 KiB ▁▁▁▁▁▁▁▁▁██
solid-start.minimal 48.49 KiB 0 B (0.00%) 146.03 KiB 42.85 KiB ▁▁▁▁▁▁▁▁▁██
solid-start.full 53.96 KiB 0 B (0.00%) 161.98 KiB 47.51 KiB ▁▁▁▁▁▁▁▁▁██

Trend sparkline is historical gzip bytes ending with this PR measurement; lower is better.

@rxssula rxssula changed the title Use @tanstack/cli Use @tanstack/cli for creating Tanstack Start application Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Everything documentation related

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant