You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# `headjack` - Interactive NIfTI Viewer for the Terminal
3
2
4
-
# `headjack`
3
+
`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.
5
4
6
-
NIfTI viewer for the terminal.
7
-
8
-
(Placeholder screenshot)
9
5

10
6
11
7
## Usage
12
8
9
+
To view NIfTI images in the terminal, simply run:
10
+
13
11
```sh
14
12
headjack image.nii.gz
15
13
```
16
14
17
15
### Controls
18
16
17
+
Use the following controls to navigate and interact with the viewer:
18
+
19
19
| Key | Action |
20
20
| --- | --- |
21
-
| <kbd>↑</kbd> <kbd>↓</kbd> or <kbd>A</kbd> <kbd>D</kbd> | Navigate X axis / Metadata scrolling|
22
-
| <kbd>←</kbd> <kbd>→</kbd> or <kbd>W</kbd> <kbd>S</kbd> | Navigate Y axis / Metadata scrolling|
23
-
| <kbd>Z</kbd> <kbd>X</kbd> or <kbd>Y</kbd> <kbd>X</kbd> | Navigate Z axis |
24
-
| <kbd>tab</kbd> | Toggle metadata view |
25
-
| <kbd>c</kbd> | Toggle color map |
26
-
| <kbd>Q</kbd> or <kbd>esc</kbd> or <kbd>ctrl</kbd> + <kbd>C</kbd> | Quit |
21
+
| <kbd>↑</kbd> <kbd>↓</kbd> or <kbd>A</kbd> <kbd>D</kbd> | Navigate along the X-axis / Scroll through metadata|
22
+
| <kbd>←</kbd> <kbd>→</kbd> or <kbd>W</kbd> <kbd>S</kbd> | Navigate along the Y-axis / Scroll through metadata|
23
+
| <kbd>Z</kbd> <kbd>X</kbd> or <kbd>Y</kbd> <kbd>X</kbd> | Navigate along the Z-axis |
24
+
| <kbd>Tab</kbd> | Toggle metadata view |
25
+
| <kbd>C</kbd> | Toggle color map |
26
+
| <kbd>Q</kbd> or <kbd>Esc</kbd> or <kbd>Ctrl</kbd> + <kbd>C</kbd> | Quit |
27
27
28
28
## Installation
29
29
30
-
### Precompiled binaries (recommended)
30
+
### Precompiled Binaries (Recommended)
31
31
32
-
Head over to [releases](https://github.com/cmi-dair/headjack/releases)and download the latest binary for your platform.
32
+
We recommend downloading the latest precompiled binary for your platform from the [releases](https://github.com/cmi-dair/headjack/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.
33
33
34
-
**Optionally** add the binary to your `PATH` environment variable.
34
+
To simplify access, consider aliasing the binary to `hj`:
35
+
36
+
```sh
37
+
alias hj=/path/to/headjack
38
+
```
35
39
36
-
`headjack` is and will always be a single executable with 0 runtime dependencies.
37
40
38
41
### Build from source
39
42
40
-
With latest Rust compiler installed, run:
43
+
If you prefer to build `headjack` from source, ensure you have the latest Rust compiler installed and then run:
41
44
42
45
```sh
43
46
cargo build --release
@@ -47,16 +50,16 @@ The binary will be located at `target/release/headjack`.
47
50
48
51
## Troubleshooting
49
52
50
-
### Terminal colors look weird
53
+
### Terminal Colors Issue
51
54
52
-
Your terminal might not support 24-bit colors. Try running `headjack` with `-a`/`--ansi` for 256 ANSI color mode or `-b`/`--bw` for black and white mode.
55
+
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.
53
56
54
-
### Unix: libc error on startup
57
+
### Unix: Libc Error on Startup
55
58
56
-
If you get an error like this:
59
+
If you encounter an error related to `libc` when starting headjack, such as:
57
60
58
61
```
59
62
/lib64/libm.so.6: versionGLIBC_2.29' not found
60
63
```
61
64
62
-
You are probably using an older version of glibc. Try using the `*-musl` variant from the [releases page](https://github.com/cmi-dair/headjack/releases). Or build from source with `musl` target.
65
+
It likely indicates that you are using an older version of glibc. Consider using the `*-musl`variant available on the [releases page](https://github.com/cmi-dair/headjack/releases), or build `headjack`from source with the`musl` target.
0 commit comments