SipHeron VDR CLI

The official zero-knowledge command-line interface for the SipHeron Virtual Data Room.

SipHeron VDR CLI is a developer-first toolchain for permanently anchoring document fingerprints to the Solana blockchain. It allows engineering teams and compliance officers to locally hash, digitally fingerprint, and establish tamper-proof verifiable histories directly from their trusted terminal.

Crucially, your files never leave your machine. The CLI securely hashes documents locally and only interacts with the blockchain or SipHeron APIs using cryptographic signatures (SHA-256, SHA-512, etc.).

🚀 Key Features

• Zero-Knowledge Hashing: All file digests (e.g., PDFs, ZIPs, Source Code) are computed entirely locally.
• Direct On-Chain Anchoring: Optionally bypass all SaaS APIs and commit hashes directly to the Solana blockchain using your own wallet.
• Massive Concurrency: Anchor up to 500 documents per batch concurrently using the optimized background processor.
• Version Chains: Graphically traverse the linked lineage of document amendments over time directly in the terminal.
• Integrity Reports: Generate professional, audit-ready PDF evidence packages dynamically from terminal output.
• Algorithmic Flexibility: Out-of-the-box support for SHA-256, SHA-512, MD5, and BLAKE3.
• Programmatic CLI Usage: Securely implement any CLI command as a strictly typed asynchronous function directly inside your Node.js operations.

📦 Installation

Install the CLI globally to access the sipheron command from anywhere:

npm install -g @sipheron/vdr-cli
# or
yarn global add @sipheron/vdr-cli
# or
pnpm add -g @sipheron/vdr-cli

⚡ Quick Start

1. Authentication

To use the sponsored transaction layers, authenticate the CLI with your SipHeron Organization:

sipheron login

Alternatively, you can export your API key: export SIPHERON_API_KEY="your_api_key"

2. Anchor a Document

Anchor a single document to the blockchain:

sipheron anchor ./contracts/q4-agreement.pdf --name "Q4 Deal"

3. Verify a Document

Validate an existing document locally against its immutable history:

sipheron verify ./contracts/q4-agreement.pdf

📚 Advanced Usage

Batch Anchoring

Need to register hundreds of files at once? Use the batch command to process an entire directory simultaneously:

sipheron anchor:batch ./legal-archives --concurrency 10

Tracing a Version Chain

Track the evolutionary history of a document through its amendments:

sipheron chain anc_9xN4kLpM

Expected Output:

# Version Chain for: Service Agreement
#
# v1  anc_3xK9mPqR  2026-01-14  Confirmed ✓  (original)
# v2  anc_7yL3nRsT  2026-02-01  Confirmed ✓  Updated payment terms
# v3  anc_9xN4kLpM  2026-03-10  Confirmed ✓  Renewal clause added
#   (current)

📄 Integrity Reporting

Generate a complete, professionally formatted PDF document proving the chain of custody for a batch of documents:

sipheron report --format pdf --output Q1-2026-integrity-report.pdf
# or filter structurally:
sipheron report --from 2026-01-01 --to 2026-03-31 --tag type:contract --format pdf

💻 Programmatic CLI Usage

DevOps engineers can implement the VDR CLI's behavior natively inside a Node.js script (bypassing the shell processing overhead entirely). All commands are exported as typed async functions:

// Use in Node.js scripts without spawning child processes
const { anchorFile, verifyFile } = require('@sipheron/vdr-cli/programmatic')

// In a deployment orchestration script:
const anchor = await anchorFile('./dist/app-v2.1.0.zip', {
  name: `Release v2.1.0`,
  tags: { version: '2.1.0', environment: 'production' }
})

console.log('Build anchored:', anchor.verificationUrl)

Changing Environments

Toggle between development and production environments effortlessly:

# Verify against Devnet
sipheron verify ./file.txt --network devnet

# Anchor to Mainnet
sipheron anchor ./file.txt --network mainnet

Direct Blockchain Interactions

You can utilize your own local Solana keypair to fund network fees and avoid the SipHeron API routing entirely.

sipheron anchor ./file.txt --keypair ~/.config/solana/id.json --network mainnet

⚙️ CI/CD Integration

The SipHeron CLI is strongly suited for automated build and compliance pipelines (GitHub Actions, GitLab CI, etc.). For headless environments, ensure you provide the --format json or --format quiet flags to ease programmatic log passing, and authenticate securely using env variables.

🤝 Contributing & Security

We greatly welcome community engagement. Please read our carefully laid out guidelines before submitting pull requests:

• Contributing Guidelines
• Security Policy
• Code of Conduct

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.