Skip to content

Conversation

@AmanVarshney01
Copy link
Member

@AmanVarshney01 AmanVarshney01 commented Jan 7, 2026

Summary

  • Add missing --detach (-d) option to prisma dev arguments table - allows running the server in the background
  • Add default value default for --name option
  • Add --force option documentation for dev rm command - stops running servers before removing them

Test plan

  • Verify the documentation renders correctly
  • Confirm options match npx prisma@latest dev --help output

Summary by CodeRabbit

  • Documentation
    • Updated Prisma CLI docs for dev and rm: set --name default to "default"; added --detach (aka -d) flag with default false and a detached-mode example; introduced --force for rm with default false; adjusted argument tables and section structure for clarity.

✏️ Tip: You can customize this high-level summary in your review settings.

- Add missing --detach (-d) option to run server in background
- Add default value 'default' for --name option
- Add --force option documentation for dev rm command
@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

Dangerous URL check

No absolute URLs to prisma.io/docs found.
No local URLs found.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 7, 2026

Walkthrough

Updated CLI and local Postgres docs: set --name default to "default", added a --detach (-d) flag with default false and a detached-mode example for prisma dev, and added an --force (false) argument under prisma dev rm. Local dev guide now documents detached usage and rm --force behavior.

Changes

Cohort / File(s) Summary
CLI reference
content/200-orm/500-reference/200-prisma-cli-reference.mdx
- Set --name default to "default" in dev arguments table
- Added --detach (-d) flag to dev with description and default false and a detached-mode example (prisma dev --detach)
- Added Arguments subsection for rm with --force (default false)
- Minor formatting and spacing adjustments
Local Postgres guide
content/250-postgres/300-database/550-local-development.mdx
- Documented running the local server in detached mode (npx prisma dev --detach), plus prisma dev ls and prisma dev stop instructions
- Added rm --force behavior (stops running servers before removal); clarified removal uses glob prefix matching
- Minor phrasing edits

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately summarizes the main change: updating documentation for the prisma dev command with new flags and options.
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.


📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 91fc5e8 and 2556c6f.

📒 Files selected for processing (1)
  • content/250-postgres/300-database/550-local-development.mdx
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2026-01-06T22:06:57.725Z
Learnt from: newclarityex
Repo: prisma/docs PR: 7425
File: content/200-orm/050-overview/500-databases/400-mysql.mdx:80-80
Timestamp: 2026-01-06T22:06:57.725Z
Learning: In Prisma docs, when showing examples of instantiating driver adapters with connection strings from environment variables, use the template literal pattern `const connectionString = `${process.env.DATABASE_URL}`` for consistency across all database adapter examples (PostgreSQL, MySQL/MariaDB, etc.).

Applied to files:

  • content/250-postgres/300-database/550-local-development.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Check internal links
  • GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
content/250-postgres/300-database/550-local-development.mdx (2)

53-61: Nice addition of detached mode documentation!

The flow is logical and helpful—you introduce the basic interactive mode first, then show the detached alternative. The cross-reference to prisma dev ls and prisma dev stop (documented later in the file) helps users understand the full workflow for managing detached servers.


177-189: Excellent fix and enhancement!

You've correctly fixed the copy-paste error (changing "stop" to "remove") and added clear documentation for the --force flag. The two-part explanation—what happens with --force versus without—makes the behavior immediately understandable.


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

@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

@github-actions
Copy link
Contributor

github-actions bot commented Jan 7, 2026

Redirect check

This PR probably requires the following redirects to be added to static/_redirects:

  • This PR does not change any pages in a way that would require a redirect.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Jan 7, 2026

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 2556c6f
Status: ✅  Deploy successful!
Preview URL: https://6c9866c0.docs-51g.pages.dev
Branch Preview URL: https://update-prisma-dev-docs.docs-51g.pages.dev

View logs

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 7, 2026
coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 7, 2026
- Add --detach option example for running server in background
- Add --force option documentation for dev rm command
- Fix typo: 'stop' -> 'remove' in dev rm section
@AmanVarshney01 AmanVarshney01 merged commit 500e472 into main Jan 7, 2026
8 checks passed
@AmanVarshney01 AmanVarshney01 deleted the update-prisma-dev-docs branch January 7, 2026 18:02
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.

3 participants