safelaunch 1.0.3 → 1.0.4

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.
Files changed (2) hide show
  1. package/README.md +20 -42
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -5,46 +5,26 @@
5
5
  safelaunch validates your local environment against a required environment contract before you push to production. No more missing variables. No more runtime mismatches. No more production surprises.
6
6
 
7
7
  ## Install
8
- ```bash
8
+
9
9
  npm install -g safelaunch
10
- ```
11
10
 
12
11
  ## Quick Start
13
12
 
14
- **Step 1: Create your environment manifest**
15
-
16
- Add an `env.manifest.json` file to your project root:
17
- ```json
18
- {
19
- "version": "1",
20
- "runtime": {
21
- "node": "20"
22
- },
23
- "variables": {
24
- "DATABASE_URL": {
25
- "required": true,
26
- "description": "PostgreSQL connection string"
27
- },
28
- "REDIS_URL": {
29
- "required": true,
30
- "description": "Redis connection string"
31
- },
32
- "API_KEY": {
33
- "required": true,
34
- "description": "External API key"
35
- }
36
- }
37
- }
38
- ```
39
-
40
- **Step 2: Run the validator**
41
- ```bash
13
+ **Step 1: Generate your environment manifest automatically**
14
+
15
+ Run this in your project folder:
16
+
17
+ safelaunch init
18
+
19
+ safelaunch scans your entire codebase, finds every environment variable your app uses, and generates env.manifest.json automatically.
20
+
21
+ **Step 2: Validate before you push**
22
+
42
23
  safelaunch validate
43
- ```
44
24
 
45
- **Step 3: See exactly what is wrong**
46
- ```
47
- Running safelaunch...
25
+ **Step 3: See exactly what will break**
26
+
27
+ Running safelaunch validate gives you:
48
28
 
49
29
  ❌ MISSING VARIABLES (2 found)
50
30
 
@@ -57,23 +37,21 @@ Running safelaunch...
57
37
 
58
38
  Your environment is not ready for production.
59
39
  Fix the issues above and run safelaunch again.
60
- ```
40
+
41
+ ## Commands
42
+
43
+ safelaunch init scan project and generate env.manifest.json automatically
44
+ safelaunch validate validate your .env against the manifest
61
45
 
62
46
  ## CI Integration
63
47
 
64
48
  Add this to your GitHub Actions workflow to block deployments automatically:
65
- ```yaml
49
+
66
50
  - name: Install safelaunch
67
51
  run: npm install -g safelaunch
68
52
 
69
53
  - name: Validate environment
70
54
  run: safelaunch validate
71
- ```
72
-
73
- ## What it checks
74
-
75
- - Missing required environment variables
76
- - Runtime version mismatches between local and manifest
77
55
 
78
56
  ## Built by Orches
79
57
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "safelaunch",
3
- "version": "1.0.3",
3
+ "version": "1.0.4",
4
4
  "description": "Backend Reliability Infrastructure - catch what breaks production before it breaks",
5
5
  "main": "index.js",
6
6
  "bin": {