Usage

July 26, 2026 ยท View on GitHub

Supported formats

  • BAM (indexed and sorted). A .bai file is needed.
    • Local paths and s3:// URLs are supported.
    • The index path is inferred as <bam>.bai. There is no separate CLI option for a custom index path.
    • For s3:// BAMs, place the .bai object at the inferred path and configure S3 credentials in the environment.
  • VCF (.vcf and .vcf.gz) and BED (.bed and .bed.gz) files are supported as positional input files.
  • Custom FASTA and 2bit reference genomes are passed with -g / --reference, not as positional track files. FASTA references require a .fai index beside the FASTA file.
  • CRAM is not supported as a CLI input format. Configure CRAM tracks in a session file.

Key bindings

Quit: :q

Normal mode

CommandNotesExample
:Enter command mode
h/j/k/lMove left / down / up / right
H/J/K/LMove left / down / up / right faster
w/bBeginning of the next / previous exon
e/geEnd of the next / previous exon
W/BBeginning of the next / previous gene
E/gEEnd of the next / previous gene
z/oZoom in / out
_number_ + _movement_Move by _number_ steps20h: left by 20 bases

Command mode

CommandNotesExample
:qQuit
:wSave the active session
:wqSave the active session and quit
:hHelp
:_pos_Go to position on same contig:1000
:_contig_:_pos_Go to position on specific contig:17:7572659
:_gene_Go to _gene_:KRAS
:ls / :contigsList contigs (j/k to select, Esc, Enter)
EscSwitch to normal mode

Filter / sort reads in command mode:

# Restore
CLEAR

# Filter by base at position 123
FILTER BASE(123)=C

Compare TGV and Vim concepts

CommandTGVVimNotes
h/lHorizontal movementCharacter
w/b/e/geExonword
W/B/E/gEGeneWORD
j/kAlignment trackLine
z/oZoomNAo does a different thing in Vim