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

# Provide license key via flag
rcf-cli audit . --license-key RCF-AUDIT-XXXX-XXXX

# Or use environment variable
export RCF_LICENSE_KEY=RCF-AUDIT-XXXX-XXXX
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

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.1.tar.gz (14.5 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.1-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rcf_cli-2.1.1.tar.gz
Algorithm Hash digest
SHA256 feff001ea1fa407fc2c18878fcf84067513dcfa9c5b1e552e65ce5be4c3a9147
MD5 af9d44f7509d43017af7a46367c5b844
BLAKE2b-256 1e71f8aa72d97f5b9dbdb9029cc53a1ccb25d1bfb6c9808636f92d3bf4571862

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for rcf_cli-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d3d6abcd920419dbc95b7c6f77c3e485ee8fd58104641c1db2525462944a902
MD5 9c801cb83d0fe86aace76676e04eb2be
BLAKE2b-256 023c59bd7b4529e9339fb82867347538d48fbd362b313f7c37c14b1dca57204d

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