Skip to content

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

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

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, SQLite). Wording for running the Prisma CLI clarified: users can invoke Prisma commands via their project’s package manager instead of the previously prescribed approach.

…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)
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

Review Change Stack

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: c3d24924-1db7-412e-a6a7-0a21a26b87c1

📥 Commits

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

📒 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
✅ Files skipped from review due to trivial changes (4)
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/planetscale.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/sqlite.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/postgresql.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/mongodb.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/prisma-postgres.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/cockroachdb.mdx
  • apps/docs/content/docs/(index)/prisma-orm/quickstart/mysql.mdx

Walkthrough

Reworded eight database-specific quickstarts to replace npm-specific npx wording with package-manager-agnostic text instructing users to run Prisma CLI commands via their package manager.

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, 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
Eight quickstart guides replace npm-specific npx invocation guidance with package-manager-agnostic text. Each "Initialize Prisma ORM" step now instructs that Prisma CLI commands can be run using the project's package manager instead of explicitly prefixing with npx.

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 documentation wording across eight quickstart files to use package-manager-agnostic language instead of npm-specific npx references.
Linked Issues check ✅ Passed The PR fully addresses issue #7913 by replacing npm-specific npx wording with "You can now run Prisma CLI commands using your package manager:" across all eight affected quickstart pages (postgresql, prisma-postgres, mysql, sqlite, sql-server, cockroachdb, planetscale, mongodb).
Out of Scope Changes check ✅ Passed All changes are strictly in-scope: only the introductory prose sentence in eight quickstart pages was modified; no code examples, MDX structure, or other content was altered.
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.


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.

@morgan-coded morgan-coded force-pushed the docs/7913-package-manager-agnostic-cli-wording branch from e2c0f75 to 8ab4b3b Compare June 4, 2026 01:22
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