Installation

Recommended: Use pre-built binaries for fastest setup. No dependencies required for static builds.

Pre-built Binaries

Linux (x86_64, musl - Static)

wget https://github.com/LessUp/fq-compressor/releases/download/v0.2.0/\
  fq-compressor-v0.2.0-linux-x86_64-musl.tar.gz
tar -xzf fq-compressor-v0.2.0-linux-x86_64-musl.tar.gz
sudo mv fq-compressor-v0.2.0-linux-x86_64-musl/fqc /usr/local/bin/
fqc --version

Linux (x86_64, glibc)

wget https://github.com/LessUp/fq-compressor/releases/download/v0.2.0/\
  fq-compressor-v0.2.0-linux-x86_64-glibc.tar.gz
tar -xzf fq-compressor-v0.2.0-linux-x86_64-glibc.tar.gz
sudo mv fq-compressor-v0.2.0-linux-x86_64-glibc/fqc /usr/local/bin/

Linux (ARM64, musl)

wget https://github.com/LessUp/fq-compressor/releases/download/v0.2.0/\
  fq-compressor-v0.2.0-linux-aarch64-musl.tar.gz
tar -xzf fq-compressor-v0.2.0-linux-aarch64-musl.tar.gz
sudo mv fq-compressor-v0.2.0-linux-aarch64-musl/fqc /usr/local/bin/

macOS (Intel)

wget https://github.com/LessUp/fq-compressor/releases/download/v0.2.0/\
  fq-compressor-v0.2.0-macos-x86_64.tar.gz
tar -xzf fq-compressor-v0.2.0-macos-x86_64.tar.gz
sudo mv fq-compressor-v0.2.0-macos-x86_64/fqc /usr/local/bin/

macOS (Apple Silicon)

wget https://github.com/LessUp/fq-compressor/releases/download/v0.2.0/\
  fq-compressor-v0.2.0-macos-arm64.tar.gz
tar -xzf fq-compressor-v0.2.0-macos-arm64.tar.gz
sudo mv fq-compressor-v0.2.0-macos-arm64/fqc /usr/local/bin/

Build from Source

Prerequisites

ToolMinimumRecommended
CompilerGCC 14+ or Clang 18+GCC 15.2 / Clang 21
CMake3.283.28+
Conan2.xlatest

Install Dependencies

# Ubuntu/Debian
sudo apt install -y build-essential cmake python3 python3-pip
pip3 install conan
 
# macOS
brew install cmake python conan

Clone and Build

git clone https://github.com/LessUp/fq-compressor.git
cd fq-compressor
 
# Install dependencies
conan install . --build=missing -of=build/clang-release \
    -s build_type=Release -s compiler.cppstd=23
 
# Configure
cmake --preset clang-release
 
# Build
cmake --build --preset clang-release -j$(nproc)
 
# Verify
build/clang-release/src/fqc --version

Docker

# Build image
docker build -f docker/Dockerfile -t fq-compressor .
 
# Run compression
docker run --rm -v $(pwd):/data \
  fq-compressor compress -i /data/reads.fastq -o /data/reads.fqc

DevContainer

For VS Code users, the project includes DevContainer configuration:

  1. Open project in VS Code
  2. Press F1 → “Dev Containers: Reopen in Container”
  3. All tools are pre-installed

System Requirements

ComponentMinimumRecommended
OSLinux 5.0+ / macOS 11+Latest LTS
CPUx86_64 or ARM64Multi-core (8+)
RAM2 GB4 GB+
Disk100 MB1 GB+ temp space

Verification

After installation:

# Check version
fqc --version
 
# View help
fqc --help
 
# Quick test
echo -e "@test\nACGT\n+\n1234" | fqc compress -o test.fqc
fqc info test.fqc