EnglishGetting StartedCLI Usage

CLI Usage Reference

Global Options

OptionShortDescriptionDefault
--help-hShow help-
--version-vShow version-
--verbose-vVerbose outputfalse
--threads-tNumber of threadsAuto-detect
--memory-limit-Memory limit (MB)Auto

Commands

compress

Compress FASTQ to FQC format.

fqc compress [OPTIONS] -i <input> -o <output>

Options:

OptionShortDescriptionDefault
--input-iInput FASTQ (required)-
--input2-2Second input (paired-end)-
--output-oOutput FQC (required)-
--paired-Enable paired-end modefalse
--mode-mCompression modebalanced
--block-size-Block size (bases)10000000

Examples:

# Basic
fqc compress -i reads.fastq -o reads.fqc
 
# Parallel
fqc compress -i reads.fastq -o reads.fqc -t 8
 
# Best quality
fqc compress -i reads.fastq -o reads.fqc --mode best
 
# Paired-end
fqc compress -i r1.fastq -2 r2.fastq -o paired.fqc --paired
 
# From compressed input
fqc compress -i reads.fastq.gz -o reads.fqc

decompress

Decompress FQC to FASTQ.

fqc decompress [OPTIONS] -i <input> -o <output>

Options:

OptionDescriptionDefault
--rangeRead range to extractAll
--original-orderRestore original orderfalse
--header-onlyHeaders onlyfalse

Range Syntax:

SyntaxMeaning
1000:2000Reads 1000-2000 (inclusive)
:1000First 1000 reads
5000:From 5000 to end
1000Single read

Examples:

# Full
fqc decompress -i reads.fqc -o restored.fastq
 
# Partial
fqc decompress -i reads.fqc --range 1000:2000 -o subset.fastq
 
# Original order
fqc decompress -i reads.fqc -o restored.fastq --original-order

info

Show archive information.

fqc info [OPTIONS] <archive>
OptionDescription
--jsonJSON output
--detailedDetailed block info

verify

Verify archive integrity.

fqc verify <archive>

split-pe

Split paired-end archive.

fqc split-pe -i <input> -1 <out1> -2 <out2> [--range <range>]

Compression Modes

ModeSpeedRatioUse Case
fast~15 MB/s~3.5×Speed priority
balanced~11 MB/s~4.0×Default
best~6 MB/s~4.5×Max compression

Exit Codes

CodeMeaning
0Success
1General error
2Invalid arguments
3I/O error
4Format error
5Memory error

Environment Variables

VariableDescriptionExample
FQC_THREADSDefault threadsFQC_THREADS=8
FQC_MEMORY_LIMITDefault memory (MB)FQC_MEMORY_LIMIT=4096
FQC_LOG_LEVELLog levelFQC_LOG_LEVEL=debug