Skip to main content

RCF CLI — Active Protection & Audit Framework (Python Edition)

Project description

RCF CLI — Python Edition 🛡️🐍

The official Python Command Line Interface for the RCF (Restricted Correlation Framework) Protocol Active Integrity & Audit Framework.

RCF is an author-defined licensing protocol designed to protect intellectual property in the age of automated extraction and AI/ML mass replication. It creates a clear legal and technical boundary between Visibility and Usage Rights using cryptographic integrity chains.

Installation

Install via PyPI:

pip install rcf-cli

Features

  • Audit Shield Protection: Active enforcement of RCF-PL standards across your codebase.
  • Project Initialization: Instantly generate NOTICE.md and .rcfignore files to protect your project.
  • Automated Scanning: Quickly scan projects for RCF compliance and extract Audit Markers.
  • Header Validation: Ensure files have the required NOTICE: This file is protected under RCF-PL header.
  • RCF-Audit: Generate cryptographically signed compliance reports for enterprise auditing.
  • Integrity Chains: Compare current file hashes and Audit Markers against an audit report to detect unauthorized modifications or tampering.

CLI Usage

1. Initialize RCF in your project

Run this in your project's root directory to generate the legal notice:

rcf-cli init --project "My awesome app" --author "Aladdin Aliyev"

2. Scan your project

# Scan the current directory
rcf-cli .

# Output scan results as JSON
rcf-cli . --format json

# Print summary only
rcf-cli . --summary

3. Generate an RCF-Audit Report

rcf-cli audit .

4. Verify Project Integrity

Compare current files with the latest audit report:

rcf-cli verify .

# Show summary only
rcf-cli verify . --summary

5. Forensic Analysis & Code Similarity

The Python SDK includes forensic utilities to analyze code uniqueness, generate watch-lists (sentinels), registry integrity canaries, and compute court-grade similarity proof reports.

Build Background Corpus

Builds a probability database of language structures (p_nat.json) using standard library and project files:

rcf-cli build-corpus --project . --out tests/corpus.json

Rank Sentinels (Watch-List)

Surfaces the highest-surprisal-mass functions in a codebase that are the most unique and worth watching:

rcf-cli sentinel . --corpus tests/corpus.json --top 5

Build Null Distribution Model

Calibrates a Monte Carlo null distribution (null_model.json) of similarity scores for independent code pairs:

rcf-cli build-null --project . --corpus tests/corpus.json --n-pairs 1000 --out tests/null_model.json

Compute Similarity Proof (Prove)

Compares two files and calculates statistical significance (Z-score, p-empirical, p-parametric, E-value):

rcf-cli prove src/core/wl.py src/core/wl.py --corpus tests/corpus.json --null tests/null_model.json --search-space 1

Register and Scan Designed Canaries

Register a functional canary to track code theft:

# Register canary
rcf-cli canary register --name "my_canary" --desc "integrity check" --source "def c(x): return x ^ 0xAB" --registry tests/rcf_canaries.json

# Scan codebase for the canary
rcf-cli canary scan . --registry tests/rcf_canaries.json

AST Adversarial Noise

Inject adversarial AST structures into protected files to break AI models trying to analyze the code:

rcf-cli noise src/

Export WAF Gateway

Exports production-ready Edge/WAF configurations to protect repositories and assets from AI scrapers and automated bots:

# Export Cloudflare Worker WAF script (cloudflare_worker.ts)
rcf-cli gateway cloudflare --out ./output_dir

# Export Nginx Lua WAF script (rcf_waf.lua) and nginx.conf snippet
rcf-cli gateway nginx --out ./output_dir

Markers Reference

RCF uses semantic markers to define protection levels. Place these inside code comments:

  • [RCF:PUBLIC] — Architecture and public concepts. Safe to discuss.
  • [RCF:PROTECTED] — Core methodology. Visible but not replicable.
  • [RCF:RESTRICTED] — Highly sensitive implementation. Minimal rights.
  • [RCF:AUDIT:HASH] — Cryptographic marker for active integrity verification.

Example header for protected files:

# NOTICE: This file is protected under RCF-PL
# [RCF:PROTECTED]
# [RCF:AUDIT:6A...F3]

Documentation

For full specification and legal framework details, visit the official site: aliyev.site/rcf

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rcf_cli-2.1.7.tar.gz (65.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rcf_cli-2.1.7-py3-none-any.whl (61.1 kB view details)

Uploaded Python 3

File details

Details for the file rcf_cli-2.1.7.tar.gz.

File metadata

  • Download URL: rcf_cli-2.1.7.tar.gz
  • Upload date:
  • Size: 65.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for rcf_cli-2.1.7.tar.gz
Algorithm Hash digest
SHA256 464541d25b891bcb7a8d882c6f4f3c940a19dbc12c25c9eb184db148768c576f
MD5 f9add5273494a4a459e662648b29a25d
BLAKE2b-256 4bbaea37431f5c84dc45cfb97f100a7d5114eff95fb858d09c547678ffcc7846

See more details on using hashes here.

File details

Details for the file rcf_cli-2.1.7-py3-none-any.whl.

File metadata

  • Download URL: rcf_cli-2.1.7-py3-none-any.whl
  • Upload date:
  • Size: 61.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.6

File hashes

Hashes for rcf_cli-2.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9d545da352725c929d17c1bd51d2e9318ffd3de2764397f728826751bd475387
MD5 ba47531a6aecef529181c03af2b1878b
BLAKE2b-256 c2c5d6193f6ff73422d6afa7258c2176864a1775f52853f9315d0a34abd439f3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page