@onproper/cli 1.0.2 → 1.0.4

package/README.md

@@ -0,0 +1,100 @@
+# Proper
+
+**Lightweight, Zero-Knowledge Change Data Capture (CDC) & Dispatcher for PostgreSQL.**
+
+Proper is a blazing-fast, edge-first Go binary that monitors your PostgreSQL database in real-time and triggers local scripts or external webhooks the millisecond a row changes. 
+
+Designed for strict memory safety and enterprise compliance, it runs securely inside your own VPC. Your database credentials never leave your servers.
+
+---
+
+## ✨ Features
+
+* **Zero-Knowledge Architecture:** Reads your database locally. No raw row data is ever transmitted to a third party.
+* **Smart Polymorphic Dispatching:** Automatically routes actions to local scripts (`node handler.js`) or HTTP webhooks based on the target string.
+* **Lock-Free Hot Reloading:** Update your `proper.config.yaml` and the engine hot-swaps your rules in memory using atomic pointers—zero restarts, zero dropped events.
+* **Poison Pill Prevention:** Built-in exponential backoff retries. If a webhook or script repeatedly fails, the event is quarantined to a local Dead Letter Queue (`proper.dlq.log`) to protect the database stream.
+* **Enterprise Audit Logging:** Automatically outputs a structured `JSONL` (JSON Lines) file of every success and failure, instantly ready for Datadog, Splunk, or ELK.
+
+---
+
+## ⚡️ Quick Start
+
+Proper is designed to be deployed as a sidecar to your database using Docker.
+
+### 1. Define Environment Variables
+
+# Your local database connection (Requires logical replication enabled)
+DATABASE_URL=postgres://root:password@host.docker.internal:5432/app_db?replication=database
+
+# A unique identifier for this deployment (prevents replication slot collisions)
+PROPER_PIPELINE_ID=pipe_local_dev
+
+### 2. Define your triggers (`proper.config.yaml`)
+
+triggers:
+  - id: notify_slack_on_large_discount
+    table: purchase_order
+    action: UPDATE
+    condition:
+      field: discount_rate
+      operator: gt
+      value: "0.40"
+    dispatch:
+      # Proper auto-detects webhooks vs local scripts
+      exec: "[https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX](https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX)"
+
+
+### 3. Boot the Engine (`docker-compose.yml`)
+
+version: '3.8'
+services:
+  proper-agent:
+    image: proper/engine:latest
+    container_name: proper_agent
+    env_file:
+      - .env
+    volumes:
+      - ./proper.config.yaml:/proper/proper.config.yaml:ro
+      - ./proper.dlq.log:/proper/proper.dlq.log
+      - ./proper.audit.log:/proper/proper.audit.log
+
+
+
+Run:
+touch proper.dlq.log proper.audit.log && docker compose up -d
+
+---
+
+## 📊 The JSONL Audit Trail
+
+Proper defaults to writing a high-performance, structured audit log to `/proper/proper.audit.log`. Every execution drops a complete JSON object, allowing your security team to easily parse and query your data movement.
+
+{
+  "trigger_id":"notify_slack_on_large_discount",
+  "target":"[https://hooks.slack.com/](https://hooks.slack.com/)...",
+  "status":"success",
+  "payload":{
+    "id": 4, 
+    "email": "test@example.com", 
+    "discount_rate": 0.50},
+    "timestamp":"2026-10-02T14:32:01Z"
+  }
+}
+
+---
+
+## ☁️ Upgrading to Proper Cloud (SaaS)
+
+Managing local YAML files and grepping text logs is fine for side projects, but enterprise compliance (like the **California Delete Act / SB 362**) requires a cryptographically secure chain of custody.
+
+**Proper Cloud** acts as your immutable compliance ledger and control plane.
+
+By simply adding a `PROPER_API_KEY` to your `.env` file, the open-source agent instantly upgrades:
+
+1. **GitOps Sync:** It pushes your local YAML rules to the Cloud Dashboard for version control and one-click rollbacks.
+2. **Visual Dashboard:** Manage your triggers, conditions, and webhooks via a clean web UI without touching code.
+3. **Verified Telemetry:** The agent securely streams its execution batches to our Control Plane, separating them from the unverified local text files.
+4. **Automated Compliance:** Generate legally binding Certificates of Erasure (PDFs) with a single click to prove to regulators that your fan-out deletions executed successfully across HubSpot, Stripe, and your internal DB.
+
+*Proper Cloud is currently in early access.* **[Join the waitlist at onproper.com](https://www.onproper.com)**

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@onproper/cli",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "The Zero-Trust Entity Orchestration & Compliance Engine",
   "main": "index.js",
   "bin": {
     "proper": "bin/proper"
   },
   "scripts": {
+    "prepublishOnly": "cp ../README.md ./README.md",
     "postinstall": "node postinstall.js"
   },
   "keywords": [

package/postinstall.js

@@ -7,7 +7,7 @@ const { execSync } = require('child_process');
 // 🔥 THE FIX: Dynamically read the version NPM just installed
 const packageJson = require('./package.json');
 const VERSION = `v${packageJson.version}`; // Translates "1.0.0" to "v1.0.0"
-const REPO = 'vulsys/proper-engine';
+const REPO = 'vulsys/proper-release';
 
 // 1. Map Node's OS/Arch to Go's OS/Arch
 const platformMap = {