Skip to content

docs: update prisma dev command documentation #7426

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AmanVarshney01 merged 3 commits into from
Jan 7, 2026
Merged

docs: update prisma dev command documentation #7426

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ef681e7
docs: update prisma dev command documentation
AmanVarshney01 Jan 7, 2026
91fc5e8
docs: add detached mode example for prisma dev
AmanVarshney01 Jan 7, 2026
2556c6f
docs: update local-development with detach and force options
AmanVarshney01 Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 22 additions & 7 deletions content/200-orm/500-reference/200-prisma-cli-reference.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -839,13 +839,14 @@ The `dev` command starts a [local Prisma Postgres](/postgres/database/local-deve

### Arguments

| Argument | Required | Description | Default |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
| `--name` (or `-n`) | No | Enables targeting a specific database instance. [Learn more](/postgres/database/local-development#using-different-local-prisma-postgres-instances). | |
| `--port` (or `-p`) | No | Main port number the local Prisma Postgres HTTP server will listen on. | `51213` |
| `--db-port` (or `-P`) | No | Port number the local Prisma Postgres database server will listen on. | `51214` |
| `--shadow-db-port` | No | Port number the shadow database server will listen on. | `51215` |
| `--debug` | No | Enable debug logging. | `false` |
| Argument | Required | Description | Default |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| `--name` (or `-n`) | No | Enables targeting a specific database instance. [Learn more](/postgres/database/local-development#using-different-local-prisma-postgres-instances). | `default` |
| `--port` (or `-p`) | No | Main port number the local Prisma Postgres HTTP server will listen on. | `51213` |
| `--db-port` (or `-P`) | No | Port number the local Prisma Postgres database server will listen on. | `51214` |
| `--shadow-db-port` | No | Port number the shadow database server will listen on. | `51215` |
| `--detach` (or `-d`) | No | Run the server in the background. | `false` |
| `--debug` | No | Enable debug logging. | `false` |

### Examples

Expand Down Expand Up @@ -887,6 +888,14 @@ npx prisma dev --name="mydbname"

This creates a named instance called `mydbname` that you can later start, stop, or manage using the instance management commands.

**Run `prisma dev` in detached mode**

```terminal
npx prisma dev --detach
```

This runs the server in the background, freeing up your terminal for other commands. Use `prisma dev ls` to see running servers and `prisma dev stop` to stop them.

### `dev start`

Starts existing [local Prisma Postgres](/postgres/database/local-development) instances in the background.
Expand Down Expand Up @@ -971,6 +980,12 @@ To remove all databases that begin with `mydb` (e.g. `mydb-dev` and `mydb-prod`)
npx prisma dev rm mydb* # removes all DBs starting with `mydb`
```

#### Arguments

| Argument | Required | Description | Default |
| --------- | -------- | -------------------------------------------------------------------------------------------------------------------- | ------- |
| `--force` | No | Stops any running servers before removing them. Without this flag, the command will fail if any server is running. | `false` |

:::note

The `rm` command is interactive and includes safety prompts to prevent accidental data loss.
Expand Down
22 changes: 19 additions & 3 deletions content/250-postgres/300-database/550-local-development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,15 @@ If you want to connect via Prisma ORM, hit <kbd>h</kbd> on your keyboard, copy t
DATABASE_URL="prisma+postgres://localhost:51213/?api_key=__API_KEY__"
```

Keep the local Prisma Postgres server running in the background while you work on your application.
Keep the local Prisma Postgres server running in the background while you work on your application.

Alternatively, you can run the server in detached mode to free up your terminal:

```terminal
npx prisma dev --detach
```

This starts the server in the background. Use `prisma dev ls` to see running servers and `prisma dev stop` to stop them.

### 2. Applying migrations and seeding data

Expand Down Expand Up @@ -166,12 +174,20 @@ npx prisma dev rm <glob>
npx prisma dev rm mydb # removes a DB called `mydb`
```

To stop all databases that begin with `mydb` (e.g. `mydb-dev` and `mydb-prod`), you can use a glob:
To remove all databases that begin with `mydb` (e.g. `mydb-dev` and `mydb-prod`), you can use a glob:

```
```terminal
npx prisma dev rm mydb* # removes all DBs starting with `mydb`
```

You can use the `--force` flag to stop any running servers before removing them:

```terminal
npx prisma dev rm mydb --force
```

Without `--force`, the command will fail if any server is still running.

:::note

The `rm` command is interactive and includes safety prompts to prevent accidental data loss. You'll be asked to confirm the action by typing a confirmation phrase that hints at the risks involved.
Expand Down
Loading