Skip to content

Installation

Requirements

  • Python 3.11 or later
  • A terminal that supports ANSI escape codes

Install from PyPI:

pip install snakesee

With logo support

To enable the Fulcrum Genomics logo easter egg (press fg in the TUI):

pip install snakesee[logo]

This installs the optional rich-pixels and pillow dependencies.

conda / mamba

Install from Bioconda:

conda install -c bioconda snakesee

Or with mamba:

mamba install -c bioconda snakesee

From source

Clone and install in development mode:

git clone https://github.com/nh13/snakesee.git
cd snakesee
pip install -e '.[logo]'

Verify installation

snakesee --help

You should see:

usage: snakesee [-h] {watch,status} ...

positional arguments:
  {watch,status}
    watch         Watch a Snakemake workflow in real-time with a TUI dashboard.
    status        Show a one-time status snapshot (non-interactive).

options:
  -h, --help      show this help message and exit

Optional: Logger Plugin

For enhanced real-time monitoring with more accurate job timing, install the optional Snakemake logger plugin:

pip install snakemake-logger-plugin-snakesee

This plugin provides direct event streaming from Snakemake instead of log parsing. See Usage for details.