hexyl README

The project's README from github.com/sharkdp/hexyl. As one markdown file: README.md.

CICD

hexyl is a hex viewer for the terminal. It uses a colored output to distinguish different categories of bytes (NULL bytes, printable ASCII characters, ASCII whitespace characters, other ASCII characters and non-ASCII).

Preview

Installation

On Ubuntu

... and other Debian-based Linux distributions.

If you run Ubuntu 19.10 (Eoan Ermine) or newer, you can install the officially maintained package:

sudo apt install hexyl

If you use an older version of Ubuntu, you can download the latest .deb package from the release page and install it via:

sudo dpkg -i hexyl_0.15.0_amd64.deb  # adapt version number and architecture

On Debian

If you run Debian Buster or newer, you can install the officially maintained Debian package:

sudo apt-get install hexyl

If you run an older version of Debian, see above for instructions on how to manually install hexyl.

On Fedora

If you run Fedora 35 or newer, you can install the officially maintained Fedora package:

sudo dnf install hexyl

On Arch Linux

You can install hexyl from the official package repository:

pacman -S hexyl

On Void Linux

xbps-install hexyl

On Gentoo Linux

Available in dm9pZCAq overlay

sudo eselect repository enable dm9pZCAq
sudo emerge --sync dm9pZCAq
sudo emerge sys-apps/hexyl::dm9pZCAq

On macOS

Via Homebrew:

brew install hexyl

...or via MacPorts:

sudo port install hexyl

On FreeBSD

pkg install hexyl

On NetBSD

pkgin install hexyl

On OpenBSD

doas pkg_add hexyl

on Termux

pkg install hexyl

or

apt install hexyl

Via Nix

nix-env -i hexyl

Via Guix

guix package -i hexyl

Or add the hexyl package in the list of packages to be installed in your system configuration (e.g., /etc/config.scm).

On other distributions

Check out the release page for binary builds.

On Windows

Check out the release page for binary builds. Alternatively, install from source via cargo, snap or scoop (see below). Make sure that you use a terminal that supports ANSI escape sequences (like ConHost v2 since Windows 10 1703 or Windows Terminal since Windows 10 1903).

Via cargo

If you have Rust 1.56 or higher, you can install hexyl from source via cargo:

cargo install hexyl

Alternatively, you can install hexyl directly from the repository by using:

git clone https://github.com/sharkdp/hexyl
cargo install --path ./hexyl

Note: To convert the man page, you will need Pandoc.

You can convert from Markdown by using (in the project root):

pandoc -s -f markdown -t man -o ./doc/hexyl.1 ./doc/hexyl.1.md

Via snap package

sudo snap install hexyl

Get it from the Snap Store

Via Scoop

scoop install hexyl

Via X-CMD

x env use hexyl

Configuration

hexyl colors can be configured via environment variables. The variables used are as follows:

The colors can be any of the 8 standard terminal colors: black, blue, cyan, green, magenta, red, yellow and white. The "bright" variants are also supported (e.g., bright blue). Additionally, you can use the RGB hex format, #abcdef. For example, HEXYL_COLOR_ASCII_PRINTABLE=blue HEXYL_COLOR_ASCII_WHITESPACE="bright green" HEXYL_COLOR_ASCII_OTHER="#ff7f99".

License

Licensed under either of

at your option.

hexyl (sharkdp/hexyl)

Searching Database…

10.3K ·GitHub
What is this?hexyl is a command-line hex viewer: it prints the raw bytes of a file in your terminal, with colors distinguishing NULL bytes, printable ASCII, whitespace, other ASCII and non-ASCII bytes.
So it runs in the terminal — what does the output actually look like?A pure terminal tool, no GUI. It prints a classic hex dump — offsets, hex values, printable preview — with each byte category in its own color so the file's structure is visible at a glance.
Do I need Rust or any other dependencies installed first?None for everyday use — the packages ship a self-contained binary. The cargo route is the only one needing a toolchain: Rust 1.56 or higher.
Anything that might trip me up on Windows?Only the terminal: hexyl's colored output needs ANSI escape support, so use ConHost v2 (Windows 10 1703+) or Windows Terminal (Windows 10 1903+) — older consoles render it poorly.
Does it work on macOS and Windows too, or is it a Linux-only tool?All of them: there are packages or binaries for major Linux distros, macOS, Windows, the BSDs (FreeBSD, NetBSD, OpenBSD), and even Android via Termux.
Can I change the colors it uses for different byte types?Yes, via environment variables: HEXYL_COLOR_ASCII_PRINTABLE, HEXYL_COLOR_ASCII_WHITESPACE, HEXYL_COLOR_ASCII_OTHER and HEXYL_COLOR_OFFSET accept the 8 standard terminal colors, their bright variants, or RGB hex like #ff7f99.
What do the colors actually tell me about a file?Its structure at a glance: long runs of NULL bytes (often padding), regions of readable ASCII text, whitespace, stray ASCII control bytes and non-ASCII binary blobs each show up in their own color.
When would I reach for a hex viewer like this?Whenever you need to see what a binary file really contains — checking file headers, verifying encodings, or finding where readable text ends and raw data begins. hexyl is built around exactly that byte-level inspection.
What are similar projects?edit, fx, cobra, dust, homebrew-cask, spotify-tui, ripgrep, turbocrypt
Creator
sharkdp
Size
0.6 MB
Stars
10.3K
Age
7y
Commits · 90 Days