preflight-scavenger 0.2.0-beta.0

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 ADDED
@@ -0,0 +1,79 @@
1
+ # 🛫 PreFlight
2
+
3
+ **The local security gate for AI-generated code.**
4
+
5
+ AI coding agents (Codex, Cursor, Copilot) are incredibly fast, but they consistently make catastrophic deployment mistakes. PreFlight is a zero-knowledge, local CLI tool that uses `tree-sitter` AST parsing to catch these hallucinations before they get merged into your codebase.
6
+
7
+ ### 🛡️ What it catches
8
+ * **Frontend Leaks:** Hardcoded `sk_live_` keys in Next.js client components.
9
+ * **Backend Leaks:** Exposed Database URLs and JWT secrets in `/api` routes.
10
+ * **Open Databases:** Supabase migrations missing `ENABLE ROW LEVEL SECURITY`.
11
+
12
+ ---
13
+
14
+ ## 🚀 The Free Scanner
15
+ The PreFlight scanner runs 100% locally. It never uploads your code to the cloud. You can run it manually or drop it directly into your GitHub Actions CI/CD pipeline to block dangerous PRs.
16
+
17
+ **Download the latest executable for your OS in the [Releases tab](https://github.com/av29nassh-sketch/PreFlight/releases/tag/v0.1.0).**
18
+
19
+ ### Usage
20
+ Scan a specific directory:
21
+ ```bash
22
+ preflight scan ./my-project
23
+ ```
24
+
25
+ Scan only files recently changed by an AI agent (Git Diff):
26
+ ```bash
27
+ preflight scan --diff
28
+ ```
29
+
30
+ Block CI/CD pipelines with SARIF output:
31
+ ```bash
32
+ preflight scan --diff --format=sarif
33
+ ```
34
+
35
+ ---
36
+
37
+ ## 🛠️ The Auto-Fix Orchestrator (Pro)
38
+ If the scanner catches a vulnerability, you don't have to fix it manually. The **Auto-Fix Orchestrator** will safely isolate the broken file in a Git branch and queue an auto-repair prompt directly to your IDE.
39
+
40
+ **Pricing:**
41
+ * **Global License:** $49 (One-time lifetime access)
42
+ * **India Localized License:** ₹1,999 (One-time lifetime access)
43
+
44
+ No subscriptions. No cloud telemetry.
45
+
46
+ 👉 **[Get notified when the Auto-Fix licenses go live this Friday!](https://github.com/av29nassh-sketch/PreFlight/issues/1)**
47
+ *(Note: The Auto-Fix engine is currently in final beta, but the scanner is 100% free to use today).*
48
+
49
+ ### Usage
50
+ ```bash
51
+ preflight apply-fix ./my-project
52
+ ```
53
+
54
+ ---
55
+
56
+ ## ⚙️ Configuration
57
+ You can ignore specific mock folders or rules by adding a `preflight.config.json` file to your project root:
58
+ ```json
59
+ {
60
+ "ignorePaths": ["tests", "mocks"],
61
+ "ignoreRules": ["frontend-secret"]
62
+ }
63
+ ```
64
+
65
+ ---
66
+
67
+ ## Pricing & Beta Status
68
+
69
+ PreFlight is currently in a 100% Free Beta while we battle-test the AI scanning and remediation workflow against real projects.
70
+
71
+ The scanner is free to use during this beta, and unlimited auto-patching is also available for testing. In the future, unlimited auto-patching will become a paid feature. Final pricing is still TBD.
72
+
73
+ ---
74
+
75
+ ## Disclaimer & Liability
76
+
77
+ This software is provided "AS IS", without warranties of any kind, express or implied, including but not limited to warranties of merchantability, fitness for a particular purpose, and non-infringement.
78
+
79
+ PreFlight may generate or suggest code patches using AI-assisted workflows. Users are solely responsible for reviewing, testing, and approving any AI-generated patches before deploying them to production or merging them into a codebase.