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.

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

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:

# 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.1.tar.gz (8.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-1.2.1-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rcf_cli-1.2.1.tar.gz
  • Upload date:
  • Size: 8.2 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.1.tar.gz
Algorithm Hash digest
SHA256 b6f5c79602147df552c0add2645144b9dfc4818ceb41b16ece7a82efa11d82ab
MD5 8e554efeb3b959580f88db2898fbb670
BLAKE2b-256 188edbf2b306c42689a40ea6e5d286780f07ee0cd48932a57c86e38173cf2aa2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rcf_cli-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.8 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 be61b8ee8136feae357c481f5d60dd5f969655483b9e18bfdca9c6dcbc4628cb
MD5 5b2822ab5a3b46e546344248c0c224f9
BLAKE2b-256 c11c1682b4f575311ac85ca4e813603cc11bcf1140d4220a4b8c6d48913fb267

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