Skip to content

CLI Reference

Complete command-line interface reference for Hyperseed.

Commands Overview

Hyperseed provides the following commands:

Command Purpose Documentation
analyze Process single dataset Details →
batch Process multiple datasets Details →
segment Segmentation only Details →
config Generate configuration Via --help
info Show version/system info Via --help

Global Options

Options available for all commands:

--help              Show help message and exit
--version           Show version and exit
-v, --verbose       Enable verbose output
-d, --debug         Enable debug mode

Getting Help

Get help for any command:

# General help
hyperseed --help

# Command-specific help
hyperseed analyze --help
hyperseed batch --help
hyperseed segment --help

Quick Examples

Analyze a Single Dataset

hyperseed analyze dataset/sample_001 \
    --output results.csv \
    --export-plots

Batch Process Multiple Datasets

hyperseed batch dataset/ \
    --output-dir results/

Generate Configuration

hyperseed config --output my_config.yaml --preset minimal

Next Steps