add-osc-8-hyperlink

A Rust port of sentriz/add-osc-8-hyperlink.

Add clickable OSC 8 hyperlinks to file paths in terminal output. Useful for commands that don't have native hyperlink support.

Native Hyperlink Support

Some tools have built-in OSC 8 hyperlink support - use that instead:

• ripgrep: rg --hyperlink-format='file://{host}{path}' (or add to ~/.ripgreprc)
• ls (GNU coreutils): ls --hyperlink=auto

This tool is for commands without native support, like git status.

Note on Piping

Use --hyperlink=auto (not always) for tools like ls. The auto option disables hyperlinks when piping to other commands, avoiding issues where escape sequences can interfere with downstream processing.

For more details, see this ripgrep discussion about hyperlink handling in pipes.

Features

• Converts file paths to clickable file:// hyperlinks
• Preserves ANSI color codes
• Supports absolute paths, relative paths, and ~/ home directory expansion
• Works with any terminal that supports OSC 8 hyperlinks (Ghostty, iTerm2, WezTerm, etc.)

Installation

From crates.io:

cargo install add-osc-8-hyperlink

From GitHub:

cargo install --git https://github.com/konradko/add-osc-8-hyperlink-rs

Or build from source:

cargo build --release
cp target/release/add-osc-8-hyperlink ~/.local/bin/

Usage

Pipe any command output through the tool:

# Git status with colors and clickable file paths
git -c color.status=always status | add-osc-8-hyperlink

# Any command that outputs file paths
some-command | add-osc-8-hyperlink

Shell Integration

Add to your .bashrc or .bash_profile:

function g { git -c color.status=always status "$@" | add-osc-8-hyperlink; }

Or for fish shell:

function git
    if isatty stdout; and contains -- $argv[1] diff status log
        command git -c color.status=always -c color.ui=always $argv | add-osc-8-hyperlink
        return
    end
    command git $argv
end

How it Works

The tool scans each line for file paths matching:

• Absolute paths starting with common prefixes (/tmp, /home, /usr, etc.)
• Relative paths matching entries in the current directory
• Home directory paths starting with ~/

Paths are wrapped in OSC 8 escape sequences:

\e]8;;file://hostname/path\a<visible text>\e]8;;\a

ANSI color codes (\e[31m, etc.) are explicitly excluded from path matching, so colored output passes through unchanged.

Performance

Benchmarked against the Go implementation:

Binary size: 1.6 MB (Rust) vs 2.8 MB (Go)

License

MIT