korext 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,88 @@
+# Korext CLI
+
+**The Korext Node.js Command Line Interface.**
+Real-time policy enforcement and compliance proof for AI-generated code.
+
+[![NPM Version](https://img.shields.io/npm/v/korext)](https://www.npmjs.com/package/korext)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## Installation
+
+Install the CLI globally using NPM to access the `korext` command from anywhere:
+
+```bash
+npm install -g korext
+```
+
+## Authentication
+
+Before running analysis, you must authenticate the CLI against your Korext account.
+
+```bash
+# Login via browser (Recommended)
+korext login
+
+# Headless CI/CD Login via environment variable
+export KOREXT_API_TOKEN="your_personal_access_token"
+```
+
+## Commands
+
+### `korext enforce [path]`
+Scans a target directory or file and cross-references it against your active Korext Policy Pack in real-time.
+
+```bash
+# Run against the current directory
+korext enforce .
+
+# Run against a specific file
+korext enforce ./src/auth.ts
+```
+
+### `korext status`
+View your current authentication state, active Cloud storage tier, and active Policy Pack ID.
+
+```bash
+korext status
+```
+
+### `korext packs list`
+Retrieves and lists all available internal Policy Packs available for your organization.
+
+```bash
+korext packs list
+```
+
+---
+
+## CI/CD Pipeline Integration
+
+The Korext CLI is built to run headless inside GitHub Actions, GitLab CI, and isolated Docker environments. When a violation is detected during an enforcement run (`korext enforce`), the CLI intentionally exits with a non-zero code (`exit 1`) to fail the build automatically.
+
+**Example GitHub Action:**
+```yaml
+name: Korext Policy Pipeline
+on: [push, pull_request]
+
+jobs:
+  audit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          
+      - name: Install Korext globally
+        run: npm install -g korext
+        
+      - name: Korext Enforce
+        env:
+          KOREXT_API_TOKEN: ${{ secrets.KOREXT_API_TOKEN }}
+        run: korext enforce .
+```
+
+## Need Help?
+Visit the official documentation at [Korext.com](https://www.korext.com) or reach out to your Account Executive for Enterprise Support.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "korext",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Korext Command Line Interface",
   "type": "module",
   "main": "bin/korext.js",