Skip to content

CLI reference

Auto-generated from the helixforge click app by scripts/gen_cli_reference.py. Do not edit by hand, run the script (or let the pre-commit/CI drift gate regenerate it). Each command's description, options, and examples come straight from its docstring and epilog, so this reference cannot drift from the code.

HelixForge v3: isoform-aware refinement of Helixer annotations.

CommandDescription
helixforge confidenceInspect (read-only): score genes against the Helixer HDF5 confidence track.
helixforge doctorPreflight: validate inputs + resolve external tools before a run.
helixforge evidenceInspect (read-only): score any GFF3 against RNA-seq + protein evidence.
helixforge parallel aggregateCollect per-chunk outputs by pattern → one annotation; verify + fail closed.
helixforge parallel example-sbatchWrite a copy-paste SBATCH wrapper that runs a tasks file on one node.
helixforge parallel planPartition the genome (v1 strategies) + reserve disjoint HFG ranges → plan.json.
helixforge parallel suggestRecommend chunk count + per-chunk resources (heuristic; prints trade-offs).
helixforge parallel tasksExpand a command template over the plan → an executor-agnostic task file.
helixforge reconcileReconcile Helixer models with evidence → tiered GFF3 + per-gene report.
helixforge statsInspect (read-only): before/after table of a Helixer vs HelixForge GFF3.
helixforge utils alignRun miniprot protein-to-genome alignment.
helixforge utils convertGFF3 <-> GTF format conversion.
helixforge utils extract-proteinsTranslate CDS from GFF3 + genome to protein FASTA.
helixforge utils fetch-dbDownload, decompress, and Diamond-format reference protein databases.
helixforge utils filterTiered output filtering by confidence/evidence/biotype.
helixforge utils qcGenome-wide QC report (HTML/JSON/TSV).
helixforge utils summarizeAnnotation statistics table.
helixforge vizRender per-locus plots, interactive pages, or browser tracks for a run.