You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
> **Note on Appearance**: The screenshot above features the **Dracula Dark** theme and **JetBrains Mono Nerd Font**. We highly recommend using a [Nerd Font](https://www.nerdfonts.com/) for the best visual experience, as future updates will introduce more icons and symbols.
8
+
9
+
## Features
10
+
11
+
-**Visualise Migrations**: View Local, Pending, and DB-Only migrations in a clean, organised TUI.
12
+
-**Safe Workflow**: Built-in validations for checksum mismatches and empty migrations to prevent database inconsistencies.
13
+
-**Prisma Studio Integration**: Toggle Prisma Studio directly from the app (`S` key) with automatic process management (no more zombie processes).
-**Quick Actions**: Delete pending migrations (`Del`/`Backspace`) and copy migration details to the clipboard (`c`).
16
+
7
17
## Installation
8
18
9
19
### Homebrew (macOS/Linux)
@@ -16,35 +26,68 @@ brew install lazyprisma
16
26
Download the latest binary from [Releases](https://github.com/DokaDev/lazyprisma/releases).
17
27
18
28
## Prerequisites
19
-
LazyPrisma requires Prisma CLI to be installed in your project:
29
+
30
+
LazyPrisma requires the Prisma CLI to be installed in your project:
31
+
20
32
```bash
21
33
npm install -D prisma
22
34
```
23
35
24
-
> **Note:** LazyPrisma uses `npx prisma` to execute commands. Global Prisma installation is not currently supported.
36
+
> **Note:** LazyPrisma uses `npx prisma` to execute commands. Ensure `npx`is available in your shell path. It supports both the classic `schema.prisma` and the new Prisma v7+ `prisma.config.ts`.
25
37
26
38
## Usage
39
+
40
+
Navigate to your project directory and launch the application:
41
+
27
42
```bash
28
43
cd your-prisma-project
29
44
lazyprisma
30
45
```
31
46
47
+
Check the version:
48
+
```bash
49
+
lazyprisma --version
50
+
```
51
+
32
52
### Keyboard Shortcuts
33
-
-`←/→` - Switch panels
34
-
-`↑/↓` - Scroll/Select
35
-
-`r` - Refresh migration status
36
-
-`g` - Generate Prisma Client
37
-
-`d` - Migrate Dev (create new migration)
38
-
-`D` - Migrate Deploy
39
-
-`f` - Format schema
40
-
-`t` - Open Prisma Studio
41
-
-`?` - Help
42
-
-`q` - Quit
53
+
54
+
**Navigation**
55
+
-`←` / `→`: Switch between panels (Workspace, Migrations, Details, Output).
56
+
-`↑` / `↓`: Scroll list or text content.
57
+
-`Tab` / `Shift+Tab`: Switch tabs within a panel (e.g., Local / Pending / DB-Only).
58
+
59
+
**Core Actions**
60
+
-`r`: **Refresh** all panels and migration status.
61
+
-`d`: **Migrate Dev** – Create a new migration (Schema diff-based or empty Manual migration).
62
+
-`D`: **Migrate Deploy** – Apply pending migrations to the database.
63
+
-`g`: **Generate** – Run `prisma generate` to update the client.
64
+
-`s`: **Resolve** – Fix failed migrations (mark as applied or rolled back).
65
+
-`S`: **Studio** – Toggle the Prisma Studio server (opens in your default browser).
66
+
67
+
**Utilities**
68
+
-`c`: **Copy** – Copy the selected migration's name, path, or checksum to the clipboard.
69
+
-`⌫` / `Del`: **Delete** – Delete the selected pending local migration folder.
70
+
-`q`: **Quit** – Exit the application (safely terminates any background Prisma Studio processes).
43
71
44
72
## Build from Source
45
-
```bash
46
-
brew install make
47
73
74
+
Ensure you have Go installed (1.21+ recommended).
75
+
76
+
```bash
77
+
# Clean and build
48
78
make clean
49
79
make
80
+
81
+
# Build and run immediately
82
+
83
+
make run
84
+
50
85
```
86
+
87
+
88
+
89
+
## Roadmap
90
+
91
+
92
+
93
+
-**Automatic `down.sql` Generation**: Initially planned for v0.2.x, but postponed due to technical constraints. We aim to implement this feature in a future sprint, alongside establishing a robust `lazytui` framework and refactoring the codebase.
0 commit comments