Package Exports

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@syntropysoft/praetorian) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Praetorian CLI 🏛️

Guardian of Configurations – Universal Validation Framework for DevSecOps

npm version
build status
license

░       ░░░       ░░░░      ░░░        ░░        ░░░      ░░░       ░░░        ░░░      ░░░   ░░░  ░░░░░░░░░      ░░░  ░░░░░░░░        ░
▒  ▒▒▒▒  ▒▒  ▒▒▒▒  ▒▒  ▒▒▒▒  ▒▒  ▒▒▒▒▒▒▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒  ▒▒  ▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒▒  ▒▒▒▒  ▒▒    ▒▒  ▒▒▒▒▒▒▒▒  ▒▒▒▒  ▒▒  ▒▒▒▒▒▒▒▒▒▒▒  ▒▒▒▒
▓       ▓▓▓       ▓▓▓  ▓▓▓▓  ▓▓      ▓▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓  ▓▓       ▓▓▓▓▓▓  ▓▓▓▓▓  ▓▓▓▓  ▓▓  ▓  ▓  ▓▓▓▓▓▓▓▓  ▓▓▓▓▓▓▓▓  ▓▓▓▓▓▓▓▓▓▓▓  ▓▓▓▓
█  ████████  ███  ███        ██  ███████████  █████  ████  ██  ███  ██████  █████        ██  ██    ████████  ████  ██  ███████████  ████
█  ████████  ████  ██  ████  ██        █████  ██████      ███  ████  ██        ██  ████  ██  ███   █████████      ███        ██        █
                                                                                                                                        


🛡️  Guardian of Configurations & Security

⚠️ MVP ALPHA VERSION WARNING

🚨 This is an MVP ALPHA version (0.0.1-alpha.7) - Limited functionality!

✅ CURRENTLY WORKING FEATURES:

CLI with professional banner - Beautiful ASCII art with security colors

Key comparison - Compare keys across multiple configuration files (JSON/YAML/.env)

Basic validation - Detect missing or extra keys between files

Configuration file - praetorian.yaml for defining files to compare

Exit codes - Proper exit codes for CI/CD integration

🚧 NOT YET IMPLEMENTED:

Schema validation, pattern matching, security rules

Plugin system, custom rules, audit engine

Advanced validation features mentioned in examples

For production use, wait for stable releases (1.0.0+)

🚀 Description

Praetorian CLI is a multi-environment configuration validation tool designed for DevSecOps teams.
It ensures that your configuration files (YAML/ENV) remain consistent across environments and detects critical differences before production deployments.

✨ Features

🛡️ Multi-file, multi-environment validation (dev, staging, prod).
🔍 Detects missing keys or inconsistent values.
📝 Simple setup with praetorian.yaml.
📦 CI/CD and security pipeline friendly.
🔑 Supports ignored keys and future advanced rules (types, patterns).

📦 Installation

npm install -g @syntropysoft/praetorian

⚙️ Basic Configuration

File praetorian.yaml:

files:
  - config-dev.yaml
  - config-prod.yaml
  - config-staging.yaml

ignore_keys:
  - debug
  - temp

environments:
  dev: config-dev.yaml
  prod: config-prod.yaml
  staging: config-staging.yaml

🛠️ Usage

Validate that all configuration files have matching keys:

praetorian validate

Output:

✅ All configuration files are consistent!

In case of differences:

❌ Missing key 'database.url' in config-staging.yaml

📋 Simple Examples

Example 1: Basic Configuration Files

# config-dev.yaml
app:
  name: my-app
  debug: true
  port: 3000

database:
  host: localhost
  port: 5432

# config-prod.yaml
app:
  name: my-app
  port: 80

database:
  host: prod-db.example.com
  port: 5432
  url: postgresql://user:pass@prod-db.example.com:5432/db

Example 2: Praetorian Configuration

# praetorian.yaml
files:
  - config-dev.yaml
  - config-prod.yaml

ignore_keys:
  - app.debug  # Ignore debug-specific keys

environments:
  dev: config-dev.yaml
  prod: config-prod.yaml

Example 3: CLI Output

$ praetorian validate

📊 Validation Results:

❌ Key inconsistencies found:
  • Key 'database.url' is missing in config-dev.yaml

⚠️  1 warning(s):
  • Key 'app.debug' is only present in config-dev.yaml

📈 Summary:
  • Files compared: 2
  • Total keys: 8
  • Duration: 2ms

🧩 CI/CD Integration

Example with GitHub Actions:

- name: Validate Configs
  run: praetorian validate

JSPM

@syntropysoft/praetorian