510022c3c1
Add more text roles and links. Add an example that broadcasts only to other windows in the current tab. Initial capitalization of the key names in the kbd text role. Add Python type hints for custom kittens. Note about hyperlink support for ls on macOS. Add description text for show_key.
86 lines
2.6 KiB
ReStructuredText
86 lines
2.6 KiB
ReStructuredText
Hyperlinked grep
|
|
=================
|
|
|
|
This kitten allows you to search your files using `ripgrep
|
|
<https://github.com/BurntSushi/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.
|
|
|
|
.. versionadded:: 0.19.0
|
|
|
|
To set it up, first create :file:`~/.config/kitty/open-actions.conf` with the
|
|
following contents:
|
|
|
|
.. code:: conf
|
|
|
|
# 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 :kbd:`Ctrl+Shift` keys and click on any of the result lines, to
|
|
open the file in :program:`vim` at the matching line. If you use some editor
|
|
other than :program:`vim`, you should adjust the :file:`open-actions.conf` file
|
|
accordingly.
|
|
|
|
Finally, add an alias to your shell's rc files to invoke the kitten as
|
|
:command:`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 :program:`rg`. How to do that varies based on the shell:
|
|
|
|
|
|
.. tab:: zsh
|
|
|
|
Instead of using an alias, create a simple wrapper script named
|
|
:program:`hg` somewhere in your :envvar:`PATH`:
|
|
|
|
.. code-block:: sh
|
|
|
|
#!/bin/sh
|
|
exec kitty +kitten hyperlinked_grep "$@"
|
|
|
|
Then, add the following to :file:`.zshrc`::
|
|
|
|
compdef _rg hg
|
|
|
|
.. tab:: fish
|
|
|
|
You can combine both the aliasing/wrapping and pointing fish to ripgrep's
|
|
autocompletion with a fish wrapper function in your :file:`config.fish`
|
|
or :file:`~/.config/fish/functions/hg.fish`:
|
|
|
|
.. code-block:: 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 :doc:`here </open_actions>`.
|
|
|
|
Hopefully, someday this functionality will make it into some `upstream grep
|
|
<https://github.com/BurntSushi/ripgrep/issues/665>`__ 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 :program:`rg`, do not use options that change the
|
|
output formatting as the kitten works by parsing the output from ripgrep.
|