API Documentation Index

This directory contains auto-generated API documentation for the Varvis Download CLI.

CLI Reference

The following modules are documented:

apiClient - Default headers for all requests to avoid undici v7's automatic sec-fetch-mode: cors
archiveUtils - Triggers restoration for an archived analysis file using the internal restore endpoint.
arrayUtils - Array utility functions for normalizing CLI and config inputs.
authService - Default headers for all requests to avoid undici v7's automatic sec-fetch-mode: cors
configUtils - Loads configuration from a specified file.
errors - Error thrown when user-provided configuration is invalid.
errorUtils - Returns a readable message for an unknown thrown value.
fetchUtils - API communication utilities for data fetching
fileUtils - Downloads a file from the given URL to the specified output path with progress reporting.
filterUtils - Parses a filter expression into its components.
logger - Creates a logger with specified configuration.
promptUtils - Prompts the user for a password with hidden/muted input.
rangedUtils - Performs a ranged download for a BAM file using samtools.
restorationState - Deep equality comparison for objects that is order-independent.
toolChecks - Wraps spawn in a Promise to maintain async/await syntax.
urlUtils - URL utility functions for handling S3 pre-signed URL expiration.
varvis-download - Main CLI application entry point

This documentation is auto-generated from JSDoc comments in the source code. To regenerate:

bash

npm run docs:generate

Last generated: 2026-09-14