Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# Hyperlinked grep

This kitten allows you to search your files using ripgrep and open the results directly in your favorite editor in the terminal, at the line containing the search result, simply by clicking on the result you want.

New in version 0.19.0.

To set it up, first create `~/.config/kitty/open-actions.conf` with the following contents:

    # Open any file with a fragment in vim, fragments are generated
    # by the hyperlink_grep kitten and nothing else so far.
    protocol file
    fragment_matches [0-9]+
    action launch --type=overlay vim +${FRAGMENT} ${FILE_PATH}

    # Open text files without fragments in the editor
    protocol file
    mime text/*
    action launch --type=overlay ${EDITOR} ${FILE_PATH}

Now, run a search with:

    kitty +kitten hyperlinked_grep something

Hold down the ``Ctrl`+`Shift`` keys and click on any of the result lines, to open the file in vim at the matching line. If you use some editor other than vim, you should adjust the `open-actions.conf` file accordingly.

Finally, add an alias to your shell's rc files to invoke the kitten as hg:

    alias hg="kitty +kitten hyperlinked_grep"

You can now run searches with:

    hg some-search-term

If you want to enable completion, for the kitten, you can delegate completion to rg. How to do that varies based on the shell:

zsh

Instead of using an alias, create a simple wrapper script named hg somewhere in your `PATH`:

    #!/bin/sh
    exec kitty +kitten hyperlinked_grep "$@"

Then, add the following to `.zshrc`:

    compdef _rg hg

fish

You can combine both the aliasing/wrapping and pointing fish to ripgrep's autocompletion with a fish wrapper function in your `config.fish` or `~/.config/fish/functions/hg.fish`:

    function hg --wraps rg; kitty +kitten hyperlinked_grep $argv; end

To learn more about kitty's powerful framework for customizing URL click actions, see here.

By default, this kitten adds hyperlinks for several parts of ripgrep output: the per-file header, match context lines, and match lines. You can control which items are linked with a --kitten hyperlink flag. For example, --kitten hyperlink=matching_lines will only add hyperlinks to the match lines. --kitten hyperlink=file_headers,context_lines will link file headers and context lines but not match lines. --kitten hyperlink=none will cause the command line to be passed to directly to rg so no hyperlinking will be performed. --kitten hyperlink may be specified multiple times.

Hopefully, someday this functionality will make it into some upstream grep program directly removing the need for this kitten.

Note

While you can pass any of ripgrep's comand line options to the kitten and they will be forwarded to rg, do not use options that change the output formatting as the kitten works by parsing the output from ripgrep.