Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.38 KB

File metadata and controls

65 lines (40 loc) · 2.38 KB

headjack - Interactive NIfTI Viewer for the Terminal

headjack is a versatile NIfTI image viewer tailored for the terminal. It offers seamless compatibility with most platforms, including remote clusters and containerized environments, making it an ideal choice for researchers and developers.

Demo GIF

Usage

To view NIfTI images in the terminal, simply run:

headjack image.nii.gz

Controls

Use the following controls to navigate and interact with the viewer:

Key Action
or A D Navigate along the X-axis / Scroll through metadata
or W S Navigate along the Y-axis / Scroll through metadata
Z X or Y X Navigate along the Z-axis
Tab Toggle metadata view
C Toggle color map
Q or Esc or Ctrl + C Quit

Installation

Precompiled Binaries (Recommended)

We recommend downloading the latest precompiled binary for your platform from the releases page. Optionally, you can add the binary to your PATH environment variable for easier access. headjack is a self-contained executable with no runtime dependencies.

To simplify access, consider aliasing the binary to hj:

alias hj=/path/to/headjack

Build from source

If you prefer to build headjack from source, ensure you have the latest Rust compiler installed and then run:

cargo build --release

The binary will be located at target/release/headjack.

Troubleshooting

Terminal Colors Issue

If your terminal displays colors incorrectly, it may not support 24-bit colors. You can try running headjack with the -a/--ansi flag for 256 ANSI color mode.

Unix: Libc Error on Startup

If you encounter an error related to libc when starting headjack, such as:

/lib64/libm.so.6: versionGLIBC_2.29' not found

It likely indicates that you are using an older version of glibc. Consider using the *-musl variant available on the releases page, or build headjack from source with the musl target.