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.

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 .

## 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.3.tar.gz (6.6 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.3-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rcf_cli-1.2.3.tar.gz
  • Upload date:
  • Size: 6.6 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.3.tar.gz
Algorithm Hash digest
SHA256 11227052c3f4981796a5d932f9467862f932f19540222ae59f7b3cf19b668df4
MD5 3f8f16e4d850fe2c9fcc86ee44f4ee80
BLAKE2b-256 682bffe91cfc0f1411d6d84862499fd0b5554c54579788e9395824b22f6bcab0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rcf_cli-1.2.3-py3-none-any.whl
  • Upload date:
  • Size: 6.7 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f17900ca5071103ff3b7210e58e90eee343acea819c43ee9ecc1ac4fa2306bfd
MD5 22852b31473aec015e3446d144aaacae
BLAKE2b-256 394a680b552d2f626e3e510b537766a69903fa01e3fac170e80d430a4a5371a8

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