@fahimadib01/db-snap 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +52 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# @fahimadib01/db-snap
|
|
2
|
+
|
|
3
|
+
`db-snap` is a local Postgres snapshot/restore CLI + TUI for repeatable test data setup.
|
|
4
|
+
|
|
5
|
+
## Install
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm i -g @fahimadib01/db-snap
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Requirements
|
|
12
|
+
|
|
13
|
+
- macOS or Linux
|
|
14
|
+
- `pg_dump` and `pg_restore` available in your `PATH`
|
|
15
|
+
|
|
16
|
+
## Quick start
|
|
17
|
+
|
|
18
|
+
Launch the interactive app:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
db-snap tui
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
From the TUI you can:
|
|
25
|
+
|
|
26
|
+
- create/edit DB profiles
|
|
27
|
+
- create/import/export snapshots
|
|
28
|
+
- plan and run restores
|
|
29
|
+
- manage safety policy and rules
|
|
30
|
+
|
|
31
|
+
## CLI usage
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
db-snap version
|
|
35
|
+
db-snap profile list
|
|
36
|
+
db-snap snapshot list --profile <name>
|
|
37
|
+
db-snap restore --profile <name> --snapshot <snapshot-id> --dry-run
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Update
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm update -g @fahimadib01/db-snap
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Data location
|
|
47
|
+
|
|
48
|
+
`db-snap` stores local app state under:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
~/.db-snap
|
|
52
|
+
```
|