hexhog

You can install hexhog using cargo, yay (AUR), or brew (Homebrew).

# Using cargo
cargo install hexhog

# Using AUR (Arch Linux)
yay -S hexhog

# Using Homebrew (macOS)
brew install hexhog

Hexhog is configured via a config.toml file. The configuration allows you to customize the color theme (using color names, ANSI codes, or RGB arrays) and the characters used to represent different byte types in the ASCII view.

Configuration File Locations

• Linux: /home/user/.config/hexhog/config.toml
• Windows: C:\Users\user\AppData\Roaming\hexhog\config.toml
• macOS: /Users/user/Library/Application Support/hexhog/config.toml

[theme]
null = "dark_gray"
ascii_printable = "blue"
ascii_whitespace = [67, 205, 128] # rgb
ascii_other = 162 # ansi
non_ascii = "red"
accent = "blue"
primary = "green"
background = "black"
border = "cyan"

[charset]
null = "."
ascii_whitespace = "·"
ascii_other = "°"
non_ascii = "×"

To open and edit a file with hexhog, pass the file path as an argument to the command.

hexhog <file>

To start the application's main execution loop, call App::run. This method takes ownership of the App instance and a DefaultTerminal (from the ratatui crate). It enters a loop that handles rendering, event processing, and state updates until the application is no longer running.

app.run(terminal)?;

To programmatically initialize the application state, use App::new. This function requires an Args struct (containing the target file path) and a Config object. It attempts to read the file contents into memory if the file exists.

Returns a Result<App>.

let app = App::new(args, config)?;

Use the read_config function to load a configuration from a TOML file path. If the file does not exist, the function returns the Config::default() values instead of an error.

Returns: Result<Config, String>

• Ok(Config): The loaded configuration or default configuration.
• Err(String): An error message if the TOML is malformed or if color/charset values are invalid (e.g., a color index out of range or a charset field containing more than one character).

let config = read_config("path/to/config.toml").unwrap_or_else(|e| panic!("Failed to load config: {}", e));

The ByteType enum is used to categorize bytes into one of five types based on their ASCII properties and value:

• Null: The byte value is 0.
• AsciiPrintable: The byte is an ASCII graphic character (e.g., letters, numbers, punctuation).
• AsciiWhitespace: The byte is an ASCII whitespace character (e.g., space, tab, newline).
• AsciiOther: The byte is an ASCII character that is neither graphic nor whitespace.
• NonAscii: The byte is not a valid ASCII character.

pub enum ByteType {
    Null,
    AsciiPrintable,
    AsciiWhitespace,
    AsciiOther,
    NonAscii,
}

If no configuration file is provided or if specific fields are missing, hexhog uses the following default settings:

Default ColorScheme:

• null: Color::DarkGray
• ascii_printable: Color::Blue
• ascii_whitespace: Color::Cyan
• ascii_other: Color::Yellow
• non_ascii: Color::Green
• accent: Color::Blue
• select: Color::DarkGray
• border: Color::White
• primary: Color::White
• background: Color::Reset

Default Charset:

• null: '.'
• ascii_whitespace: '·'
• ascii_other: '°'
• non_ascii: '×'

The hexhog application is invoked via the command line. It requires a single positional argument specifying the path to the file you wish to edit.

hexhog <file>

The hexhog application is a CLI tool that uses a terminal user interface (TUI) powered by ratatui. When executed, it automatically attempts to load a configuration file from the standard system configuration directory at [config_dir]/hexhog/config.toml. If the configuration file is missing or invalid, it falls back to the default configuration.

To run the application, use the standard binary execution method. The application expects command-line arguments defined by the Args struct (provided via clap).

# Example of running the binary (assuming it is compiled)
./hexhog