CLI Quick Start

Process variants with the standalone CLI.

Many samples on HPC? Use Nextflow instead.


Basic Usage

gbcms run \
    --variants variants.vcf \
    --bam sample.bam \
    --fasta reference.fa \
    --output-dir results/

Output: results/sample.vcf


Common Options

Output Format

# VCF output (default)
gbcms run -v variants.vcf -b sample.bam -f ref.fa -o out/ --format vcf

# MAF output
gbcms run -v variants.maf -b sample.bam -f ref.fa -o out/ --format maf

Multiple Samples

Custom Sample ID

Output: results/MySample.vcf

Quality Filters

Threading


Complete Example

Output: genotyped/TumorSample.genotyped.vcf


Docker


CLI Reference

Option
Default
Description

--variants

Required

VCF or MAF file

--bam

Required

BAM file(s)

--fasta

Required

Reference FASTA

--output-dir

Required

Output directory

--format

vcf

Output format (vcf/maf)

--min-mapq

20

Minimum mapping quality

--min-baseq

0

Minimum base quality

--threads

1

Number of threads


Next Steps

Last updated