Hex viewer
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Přemysl Eric Janouch c7a6e9ec36
README.adoc: fix a dead link
10 months ago
liberty@34f86651f6 Bump liberty, termo 2 years ago
plugins xcursor.lua: fix file version decoding 2 years ago
termo@8265f075b1 Bump liberty, termo 2 years ago
.clang-format Add clang-format configuration 2 years ago
.gitignore Update .gitignore 2 years ago
.gitmodules Bump liberty, termo 5 years ago
CMakeLists.txt CMakeLists.txt: synchronize with sdtui 2 years ago
LICENSE Name change 3 years ago
README.adoc README.adoc: fix a dead link 10 months ago
config.h.in Bump minimum CMake version to 3.0 3 years ago
hex.c Fix second nibbles in the hex dump 2 years ago
hex.png Update screenshot 6 years ago



hex is yet another hex viewer. It automatically interprets fields within files using a set of Lua scripts, colorizing them and showing descriptions on the side.

At the moment there arent that many features and we only have a few decoders.



Regular releases are sporadic. git master should be stable enough. You can get a package with the latest development version from Archlinuxs AUR.

Building and Running

Build dependencies: CMake, pkg-config, help2man, liberty (included), termo (included)
Runtime dependencies: ncursesw, libunistring, Lua >= 5.3 (for highlighting)

$ git clone --recursive https://git.janouch.name/p/hex.git
$ mkdir hex/build
$ cd hex/build
$ make

To install the application, you can do either the usual:

# make install

Or you can try telling CMake to make a package for you. For Debian it is:

$ cpack -G DEB
# dpkg -i hex-*.deb

Having the program installed, optionally create a configuration file and run it on a file of your choice.


Create ~/.config/hex/hex.conf with contents like the following:

colors = {
	footer     = ""
	footer_hl  = "bold"
	bar        = "reverse"
	bar_hl     = "reverse bold"
	even       = ""
	odd        = ""
	selection  = "reverse"

Terminal caveats

Terminals are somewhat tricky to get consistent results on, so be aware of the following:

  • Xterm needs XTerm*metaSendsEscape: true for the default bindings to work

  • urxvts 'vtwheel' plugin sabotages scrolling


While the Lua API has been made considerably easy to write new decoders with, the design is far from efficient as we make tons of new formatted strings. Since we need Lua 5.3 features (64-bit integers), LuaJIT cant help us here.

Similar software

Contributing and Support

Use https://git.janouch.name/p/hex to report any bugs, request features, or submit pull requests. git send-email is tolerated. If you want to discuss the project, feel free to join me at ircs://irc.janouch.name, channel #dev.

Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9


This software is released under the terms of the 0BSD license, the text of which is included within the package along with the list of authors.