ReproLedger Setup Guide

Complete guide to setting up ReproLedger for your research workflow.

1. Install ReproHash CLI

The CLI is free, open source, and works offline forever.

pip install reprohash-core

Verify installation:

reprohash --version

2. Create Your First Snapshot

Basic Usage

# Create snapshot of input data
reprohash snapshot data/ -o snapshot.json

# Verify snapshot
reprohash verify snapshot.json -d data/

✓ Outputs:

PASS_INPUT_INTEGRITY - All files match
FAIL - Files changed or missing
INCONCLUSIVE - Could not verify

3. Install Local Agent (Optional)

Required only if using Google Drive integration.

Download Agent

# macOS/Linux
curl -O https://reproledger.com/download/agent
chmod +x agent
./agent

Windows
Download: agent.exe

Run from Source (All platforms)
git clone https://github.com/reproledger/reproledger-agent
cd reproledger-agent/agent
pip install -r requirements.txt
python agent.py


  The agent runs on http://localhost:8888 and receives commands from the Drive sidebar.

  
     Important: The agent only sends metadata to the cloud. No file contents are ever uploaded.
  

  4. Link Google Drive (Optional)

  Install Drive Add-on
  
    Visit Google Workspace Marketplace
    Search for "ReproLedger"
    Click "Install"
    Grant permissions
  

  Use in Drive
  
    Open any folder in Google Drive
    Click ReproLedger in the right sidebar
    Click "Create Snapshot"
    Agent creates snapshot locally
  

  5. Create Verification Bundle

  Complete Workflow
  # 1. Snapshot inputs
reprohash snapshot input_data/ -o input_snapshot.json

# 2. Run your analysis
python train.py

# 3. Snapshot outputs
reprohash snapshot output_data/ -o output_snapshot.json

# 4. Create bundle
reprohash create-bundle \
  --input-snapshot input_snapshot.json \
  --runrecord runrecord.json \
  --output-snapshot output_snapshot.json \
  -o bundle/

# 5. Verify bundle
reprohash verify-bundle bundle/ -d input_data/

  6. Publish to Zenodo

  Export Bundle
  
    Zip your bundle: zip -r bundle.zip bundle/
    Upload to Zenodo
    Add bundle hash to paper
  

  
    ✓ Reviewers can verify with:
    reprohash verify-bundle bundle/ -d data/
    No ReproLedger account required!
  

  7. Upgrade to Pro (Optional)

  Free tier includes:
  
    1 project
    5 bundles
    CLI verification
  

  Pro tier adds:
  
    10 projects
    100 bundles/month
    Drive integration
    Priority support
  

  View pricing →

  Support
  Questions? Email [email protected]
  Documentation: https://docs.reproledger.com

  

  
    ← Back to home