Skip to content

docs(docs): use package-manager-agnostic wording for Prisma CLI in quickstarts#7926

Open
morgan-coded wants to merge 1 commit into
prisma:mainfrom
morgan-coded:docs/7913-package-manager-agnostic-cli-wording
Open

docs(docs): use package-manager-agnostic wording for Prisma CLI in quickstarts#7926
morgan-coded wants to merge 1 commit into
prisma:mainfrom
morgan-coded:docs/7913-package-manager-agnostic-cli-wording

Conversation

@morgan-coded
Copy link
Copy Markdown

@morgan-coded morgan-coded commented May 29, 2026

What

The "Initialize Prisma ORM" step in the quickstart guides says:

You can now invoke the Prisma CLI by prefixing it with npx:

…directly above a code block that renders package-manager tabs (npm / pnpm /
yarn / bun). For the non-npm tabs the rendered command is pnpm dlx prisma,
yarn dlx prisma, and bunx --bun prisma, so the "prefix it with npx"
wording is npm-specific and incorrect for 3 of the 4 tabs.

The tabs come from apps/docs/source.config.ts (remarkNpmOptions), which runs
every npm code block through npm-to-yarn.

Change

Reword the intro sentence to be package-manager-neutral on all 8 quickstart
pages that have it:

You can now run Prisma CLI commands using your package manager:

The tabbed code block already adapts the command per package manager, so the
prose no longer needs to name npx.

Pages updated: postgresql, prisma-postgres, mysql, sqlite, sql-server,
cockroachdb, planetscale, mongodb.

Testing

  • pnpm run lint:spellcheck — passes (prose-only change, all words valid).
  • Prose-only edit; no MDX structure, code fences, or links changed.

Closes #7913

Summary by CodeRabbit

  • Documentation
    • Updated quickstart guides for all supported databases—CockroachDB, MongoDB, MySQL, PlanetScale, PostgreSQL, Prisma Postgres, SQL Server, and SQLite. Instructions on running Prisma CLI commands have been clarified, allowing users to execute them directly through their package manager.

Review Change Stack

…ickstarts

The quickstart 'Initialize Prisma ORM' step said 'invoke the Prisma CLI by
prefixing it with npx', but the code block below it renders package-manager
tabs (npm/pnpm/yarn/bun) via remarkNpmOptions. For the pnpm/yarn/bun tabs the
command is 'pnpm dlx prisma' / 'yarn dlx prisma' / 'bunx --bun prisma', so the
npx-specific prose is incorrect for 3 of the 4 tabs. Reword to be neutral.

Linear: N/A (external community contribution)

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 29, 2026 15:16
@vercel
Copy link
Copy Markdown

vercel Bot commented May 29, 2026

@morgan-coded is attempting to deploy a commit to the Prisma Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 31d0420d-af51-414a-b54f-fd06e62a750d

📥 Commits

Reviewing files that changed from the base of the PR and between ffe9059 and e2c0f75.

📒 Files selected for processing (8)
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/cockroachdb.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/mongodb.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/mysql.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/planetscale.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/postgresql.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/prisma-postgres.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/sql-server.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/sqlite.mdx

Walkthrough

This PR updates Prisma quickstart documentation across eight database-specific guides to replace npm-centric CLI invocation wording with package-manager-agnostic language. Each guide's "Initialize Prisma ORM" step now instructs users they can run Prisma CLI commands via their package manager, making the guidance consistent across npm, pnpm, yarn, and bun tabs.

Changes

Quickstart CLI Instructions

Layer / File(s) Summary
Generalize CLI invocation wording across quickstart guides
apps/docs/content/docs/(index)/prisma-orm/quickstart/cockroachdb.mdx, mongodb.mdx, mysql.mdx, planetscale.mdx, postgresql.mdx, prisma-postgres.mdx, sql-server.mdx, sqlite.mdx
Eight parallel quickstart guides replace npm-specific npx invocation guidance with package-manager-agnostic text. Step 4 instructions now read "You can now run Prisma CLI commands using your package manager" instead of the prior npx-specific wording, ensuring the text remains accurate when users switch between npm, pnpm, yarn, and bun tabs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: updating Prisma CLI wording across quickstart docs to be package-manager-agnostic instead of npm-specific.
Linked Issues check ✅ Passed All code changes directly address issue #7913: eight quickstart files updated with package-manager-neutral wording replacing npm-specific npx instructions.
Out of Scope Changes check ✅ Passed All changes are in-scope: only eight quickstart documentation files modified with the exact targeted wording change, no unrelated modifications present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] avoid npm-specific npx wording in package manager tabs

1 participant