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/

3. Install Local Agent (Optional)

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:8989.

  

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


  
4. 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/

  
5. 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!
  

  
6. Upgrade to Pro (Optional)

  
Free tier includes:
  

    
1 project
    
5 bundles
    
CLI verification
  

  
Pro tier adds:
  

    
10 projects
    
100 bundles/month
    
Priority support
  

  
View pricing →

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

  


  

    ← Back to home