Installation
Requirements
- Python 3.10+
- Java 11+ (for the Nextflow Language Server)
- Nextflow (optional — needed for parsing
nextflow.config)
Install
# Run as one-off
uvx nf-docs ./my-pipeline
# Install so "nf-docs" is available globally
uv tool install nf-docs
# Run
nf-docs ./my_pipeline
# Install
pip install nf-docs
# Run
nf-docs ./my_pipeline
# One-time channel setup
pixi config set default-channels '["conda-forge", "bioconda"]'
# Install globally
pixi global install nf-docs
# Run
nf-docs ./my_pipeline
# One-time channel setup
conda config --add channels bioconda
conda config --add channels conda-forge
conda config --set channel_priority strict
# Install
conda install nf-docs
# Run
nf-docs ./my_pipeline
# Clone the git repo locally
git clone https://github.com/ewels/nf-docs
# Install in 'editable' mode with dev dependencies
pip install -e ".[dev]"
# Run
nf-docs ./my_pipeline