Skip to content

Varvis Download CLIBioinformatics File Download Tool

Independently developed free software for downloading authorized BAM, BAI, and VCF files from the varvisยฎ API for research and bioinformatics workflow automation.

Varvis Download CLI

Quick Example โ€‹

bash
# Set credentials (recommended)
export VARVIS_USER="your_username"
export VARVIS_PASSWORD="your_password"

# Download BAM files for specific analyses
./varvis-download.js -t mytarget -a "12345,67890" -f "bam,bam.bai"

# Download with genomic range filtering
./varvis-download.js -t mytarget -a 12345 -g "chr1:1000000-2000000"

# List available files without downloading
./varvis-download.js -t mytarget -a 12345 --list

Installation โ€‹

bash
git clone https://github.com/LaborBerlin/varvis-download.git
cd varvis-download
npm install
chmod +x varvis-download.js
npm link  # Optional: global installation

Key Features โ€‹

๐Ÿ” Flexible File Discovery โ€‹

Find files by analysis IDs, sample IDs, or LIMS IDs with powerful filtering expressions.

๐Ÿ“ Multiple File Types โ€‹

Support for BAM, BAI, VCF, and VCF.GZ files with automatic index handling.

๐ŸŽฏ Genomic Range Downloads โ€‹

Extract specific genomic regions using coordinates or BED files for focused research data retrieval.

๐Ÿ“‹ Intended Use โ€‹

Provided for research, educational, development, interoperability, and bioinformatics workflow automation purposes only. Review the Intended Use page before using the software in regulated environments.

๐Ÿ”„ Archive Integration โ€‹

Seamless handling of archived files with restoration requests and automated workflows.

๐Ÿ“Š Comprehensive Reporting โ€‹

Detailed download reports, metrics tracking, and configurable logging levels.

๐ŸŒ Enterprise Support โ€‹

Proxy configuration, batch processing, and CI/CD integration capabilities.


Released under the GPL-3.0 License.