Skip to main content

A command-line tool for RCF protocol compliance verification.

Project description

RCF Protocol — Python CLI & SDK

The official Python Command Line Interface for the RCF (Restricted Correlation Framework) 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.

Installation

Install via PyPI:

pip install rcf-cli

Features

  • Project Initialization: Instantly generate NOTICE.md and .rcfignore files to protect your project.
  • Automated Scanning: Quickly scan projects for RCF compliance and extract markers.
  • Header Validation: Ensure files have the required NOTICE: This file is protected under RCF-PL v1.1 header.
  • RCF-Audit (Premium): Generate cryptographically signed compliance reports for enterprise auditing.
  • Integrity Verification: Compare current file hashes 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 "John Doe"

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 (Premium)

```bash
# 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 at the block or file level. 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:NOTICE]` — Triggers requirement for adjacent legal notice.

Example header for protected files:
```python
# NOTICE: This file is protected under RCF-PL v1.1
# [RCF:PROTECTED]

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-1.2.8.tar.gz (9.3 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-1.2.8-py3-none-any.whl (9.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for rcf_cli-1.2.8.tar.gz
Algorithm Hash digest
SHA256 213baf56dbb1c65d445a8a393d1a097494220ffdf81e264ddf27fa333c8e2f2d
MD5 dc750d5d1eff68b876ef031728e82bf8
BLAKE2b-256 3797fcecb7f5b8910e0e510f1dbb9260b2f97e20b32d2b7c5b530d7db1774012

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for rcf_cli-1.2.8-py3-none-any.whl
Algorithm Hash digest
SHA256 a94ed6a7c812018676b783d22ed2a3076c6c7ed5be5db6074caafd89c663e264
MD5 2bb4b31ad516ec24b741834c9145a645
BLAKE2b-256 ce07ccc5380e693e8cabcb3952bd4a3d974cdb099b78a6a37784b3a4a0756ddb

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