pgpm 0.2.2 β 0.2.3
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 +21 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -14,28 +14,39 @@
|
|
|
14
14
|
- π **Turnkey Module-First Workspaces** β `pgpm init` delivers a ready-to-code Postgres workspace with CI/CD, Docker, end-to-end testing, and modern TS tooling.
|
|
15
15
|
|
|
16
16
|
|
|
17
|
+
Hereβs a version that keeps it **light**, **simple**, and **zero-fluff**, but still feels tight and confident:
|
|
18
|
+
|
|
17
19
|
## π Quick Start
|
|
18
20
|
|
|
19
|
-
###
|
|
21
|
+
### Install & Setup
|
|
20
22
|
|
|
21
23
|
```bash
|
|
24
|
+
# Install pgpm globally
|
|
22
25
|
npm install -g pgpm
|
|
26
|
+
|
|
27
|
+
# Start local Postgres (via Docker) and export env vars
|
|
28
|
+
pgpm docker start
|
|
29
|
+
eval "$(pgpm env)"
|
|
23
30
|
```
|
|
24
31
|
|
|
32
|
+
> **Tip:** Already running Postgres? Skip the Docker step and just export your PG* vars.
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
25
36
|
### Create Your First Project
|
|
26
37
|
|
|
27
38
|
```bash
|
|
28
|
-
# 1. Create workspace
|
|
39
|
+
# 1. Create a workspace
|
|
29
40
|
pgpm init --workspace
|
|
30
41
|
cd my-app
|
|
31
42
|
|
|
32
43
|
# 2. Create your first module
|
|
33
44
|
pgpm init
|
|
34
45
|
|
|
35
|
-
# 3. Add
|
|
46
|
+
# 3. Add a database change
|
|
36
47
|
pgpm add some_change
|
|
37
48
|
|
|
38
|
-
# 4. Deploy
|
|
49
|
+
# 4. Deploy everything
|
|
39
50
|
pgpm deploy --createdb
|
|
40
51
|
```
|
|
41
52
|
|
|
@@ -46,6 +57,12 @@ pgpm deploy --createdb
|
|
|
46
57
|
- `pgpm init` - Initialize a new module
|
|
47
58
|
- `pgpm init --workspace` - Initialize a new workspace
|
|
48
59
|
|
|
60
|
+
### Development Setup
|
|
61
|
+
|
|
62
|
+
- `pgpm docker start` - Start PostgreSQL container (via Docker)
|
|
63
|
+
- `pgpm docker stop` - Stop PostgreSQL container
|
|
64
|
+
- `pgpm env` - Print PostgreSQL environment variables for shell export
|
|
65
|
+
|
|
49
66
|
### Database Operations
|
|
50
67
|
|
|
51
68
|
- `pgpm deploy` - Deploy database changes and migrations
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pgpm",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"author": "Dan Lynch <pyramation@gmail.com>",
|
|
5
5
|
"description": "PostgreSQL Package Manager - Database migration and package management CLI",
|
|
6
6
|
"main": "index.js",
|
|
@@ -70,5 +70,5 @@
|
|
|
70
70
|
"pg",
|
|
71
71
|
"pgsql"
|
|
72
72
|
],
|
|
73
|
-
"gitHead": "
|
|
73
|
+
"gitHead": "6fc8eb0f1fdf69575f7198708121e4f43134c965"
|
|
74
74
|
}
|