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.2.tar.gz (8.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.2-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rcf_cli-1.2.2.tar.gz
  • Upload date:
  • Size: 8.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.2.tar.gz
Algorithm Hash digest
SHA256 3f62d0d83373634d77fc7ffccb21c8ddc7e983c84cdb880a479cd22c5fbb9c00
MD5 019d7571e0ae4b3a78428e2070a993c0
BLAKE2b-256 a3d10fda5957bb6d49b5499c4ef4984a8556a69ad4f7fb9c94eb4d62459a9b73

See more details on using hashes here.

File details

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

File metadata

  • Download URL: rcf_cli-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 9.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 59456bd73662cd69e3930bf45f6701a236422a0657a5839a67a7c4820f37c167
MD5 5929040a4f00df9f831b4f8531050c33
BLAKE2b-256 293b4962ef9b517ab80264442064bea2ab9c4cb23a4503ca451ea510e0d1a4a0

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