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.1.2.tar.gz (5.1 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.1.2-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rcf_cli-1.1.2.tar.gz
  • Upload date:
  • Size: 5.1 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.1.2.tar.gz
Algorithm Hash digest
SHA256 cb6e2c3b51308a9a4881785ebc644e34f94dc64e5f1e38177806d87509368119
MD5 de7df80336e52c1057b05512e228f2cb
BLAKE2b-256 7158696f05e221912100529fddcf1ef0ae8d75820b71c2b7a017b664c75dc8f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rcf_cli-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.2 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.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f0d7431d722fadac8dfc658d82decf28ed55c0b36d6173a3ea27a05f3c88ae77
MD5 e687a7fc574d0aaf0541a149815b2d2d
BLAKE2b-256 9b42b32744965c646704ff273a300dfec8a4d40d20ab2ff7a658dcacfc80b2ad

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