snkmt (Snakemate) works with the snakemake-logger-plugin-snkmt plugin to capture and store Snakemake workflow execution data in a SQLite database. This allows you to monitor workflow progress, view job statuses, and troubleshoot errors through an interactive terminal interface.
Note: This project is still under active development. Please report bugs, weird UI behavior, and feature requests - they are greatly appreciated!
- The
snakemake-logger-plugin-snkmtplugin captures workflow events during Snakemake execution - Events are written to a local SQLite database
- snkmt provides tools to view and monitor this data through a terminal UI and CLI commands
Install via the logger plugin (recommended):
pip install snakemake-logger-plugin-snkmtThis will automatically install snkmt as a dependency.
snakemake --logger snkmt ...Launch the real-time monitoring interface:
Tab/Shift+Tab: Navigate between interface elementsEnter: Select workflow rows or log filesEscape: Close modals/dialogsq/Ctrl+C: Quit application
snkmt consoleOptions:
--db-path, -d: Specify custom database path
View database information:
snkmt db info [DB_PATH]Migrate database to latest version:
snkmt db migrate [DB_PATH]By default, snkmt stores data in the XDG Base Directory specified user data directory. You can customize this location using the --db-path option or by configuring the logger plugin.
This project is licensed under the MIT License. See the LICENSE file for details.


