Skip to main content

RCF Ghost Shield — Active Protection Framework (Python Edition)

Project description

RCF Ghost Shield — Python Edition 🛡️🐍

The official Python Command Line Interface for the RCF (Restricted Correlation Framework) Protocol v2.0 "Ghost Protocol".

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-ghost-shield

Features

  • Ghost Shield Protection: Active enforcement of RCF-PL v2.0 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 Ghost Markers.
  • Header Validation: Ensure files have the required NOTICE: This file is protected under RCF-PL v2.0 header.
  • RCF-Audit v2.0: Generate cryptographically signed compliance reports for enterprise auditing.
  • Integrity Chains: Compare current file hashes and Ghost Markers against an audit report to detect unauthorized modifications, tampering, or "Void Shell" imitations.

CLI Usage

1. Initialize RCF Ghost Shield in your project

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

rcf-ghost-shield init --project "My awesome app" --author "Aladdin Aliyev"

2. Scan your project

# Scan the current directory
rcf-ghost-shield .

# Output scan results as JSON
rcf-ghost-shield . --format json

# Print summary only
rcf-ghost-shield . --summary

3. Generate an RCF-Audit Report (v2.0)

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

# Or use environment variable
export RCF_LICENSE_KEY=RCF-AUDIT-XXXX-XXXX
rcf-ghost-shield audit .

4. Verify Project Integrity

Compare current files with the latest audit report:

rcf-ghost-shield verify .

# Show summary only
rcf-ghost-shield 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:GHOST:HASH]New in v2.0: Cryptographic marker for active integrity verification.

Example header for protected files:

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

Documentation

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

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.0.0.tar.gz (14.2 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.0.0-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rcf_cli-2.0.0.tar.gz
Algorithm Hash digest
SHA256 bfbff901dca08d86c5fde8e3f6b0c0fbe42842806dc42cf7a4be563bc10e61eb
MD5 e7047a4739bff745d7f307ba5a16080f
BLAKE2b-256 9be16f0ca1b27696e4e096a7769e7a61cf1c9d0fb4dc33a5a1dfd076eb44d0cb

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for rcf_cli-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f1e2ca1ddfd45db425880347753e6f851a20824165e3cad233320f8b3e912814
MD5 a6f2238bc248d859ed129fb9456a3a6e
BLAKE2b-256 c5a0096eacba1c47a434cea5c4ac268bfda0c312762bc3f9e7c46addf8ca7a13

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