Skip to content

CLI

The openentropy CLI provides command-line access to entropy sources, analysis tools, and real-time monitoring.

Terminal window
cargo install openentropy-cli

Discover entropy sources on your machine:

Terminal window
openentropy scan

Benchmark all fast sources:

Terminal window
openentropy bench

Output 256 random hex bytes:

Terminal window
openentropy stream --format hex --bytes 256

Live TUI dashboard with real-time monitoring:

Terminal window
openentropy monitor

Security audit with NIST test battery:

Terminal window
openentropy analyze --profile security

Research-grade analysis with cross-correlation:

Terminal window
openentropy analyze --profile deep

Profiles are convenience presets that configure multiple flags at once. Choose the profile that matches your use case:

ProfileAudienceSamplesConditioningEntropyNIST ReportCross-CorrTrialsChaos
quickAny10,000raw
standardAny (default)50,000raw
deepResearch100,000raw
securitySecurity50,000sha256

For detailed explanations of each analysis category (forensic, entropy, chaos, trials, cross-correlation), interpretation guides, and the verdict system, see Analysis System.

Security engineers use the security profile to validate entropy quality and seed CSPRNGs:

Terminal window
openentropy analyze --profile security --output audit.md

Researchers use the deep profile to study raw noise characteristics:

Terminal window
openentropy analyze --profile deep --output analysis.json

For complete command documentation, examples, and advanced options, see the Full CLI Reference.