jimporter / urgrep

Universal recursive grep for Emacs

Urgrep - Universal Recursive Grep

Urgrep is an Emacs package to provide a universal frontend for any grep-like tool, as an alternative to the built-in M-x rgrep (and other similar packages). Currently, ugrep, ripgrep, ag, ack, git grep, and grep/find are supported.

Why Urgrep?

One package, many tools

No matter which tool you prefer, you can use it with Urgrep. If a new tool comes along, you won't need to find a new Emacs package for it.

Rich minibuffer interface

Easily manipulate per-search options with Isearch-like key bindings within the Urgrep minibuffer prompt.

Seamless support for Tramp

Each host can use a different set of tools depending on what the system has installed without any special configuration.

Using Urgrep

The primary entry point to Urgrep is the interactive function urgrep. This prompts you for a query to search for in, by default, the root directory of the current project (or the default-directory if there is no project). By prefixing with C-u, this will always start the search within the default-directory. With C-u C-u, Urgrep will first prompt you for the search directory. Within the search prompt, there are several Isearch-like key bindings to let you modify the search's behavior:

Key binding	Action
M-s r	Toggle regexp search
M-s c	Toggle case sensitivity
M-s h	Toggle searching in hidden files
M-s f	Set wildcards to filter files¹
M-s C	Set number of lines of context²
M-s B	Set number of lines of leading context²
M-s A	Set number of lines of trailing context²
M-s t	Set the search tool

1. Prompts with a recursive minibuffer
   
2. With a numeric prefix argument, set immediately; otherwise, use a recursive minibuffer

In addition to the above, you can call urgrep-run-command, which works like urgrep but allows you to manually edit the command before executing it.

Configuring the tool to use

By default, Urgrep tries all search tools it's aware of to find the best option. To improve performance, you can restrict the set of tools to search for by setting urgrep-preferred-tools:

(setq urgrep-preferred-tools '(git-grep grep))

If a tool is installed in an unusual place on your system, you can specify this by providing a cons cell as an element in urgrep-preferred-tools:

(setq urgrep-preferred-tools '((ag . "/home/coco/bin/ag")))

This also works with connection-local variables:

(connection-local-set-profile-variables 'urgrep-ripgrep
 '((urgrep-preferred-tools . (ripgrep))))

(connection-local-set-profiles
 '(:application tramp :machine "imagewriter") 'urgrep-ripgrep)

Using with wgrep

wgrep provides a convenient way to edit results in grep-like buffers. Urgrep can hook into wgrep to support this as well. To enable this, just load urgrep-wgrep.el.

Using with Xref

Xref lets you search through your projects to find strings, identifiers etc. You can make Xref use Urgrep to generate its search command by loading urgrep-xref.el.

Using with outline-minor-mode

Inside of Urgrep buffers, you can enable outline-minor-mode. This will let you toggle the visibility of each file's results.

Using with Eshell

In Eshell buffers, you can call urgrep much like you'd call any command-line recursive grep command. The following options are supported:

Option	Action
-G, --basic-regexp	Pattern is a basic regexp
-E, --extended-regexp	Pattern is an extended regexp
-P, --perl-regexp	Pattern is a Perl-compatible regexp
-R, --default-regexp	Pattern is a regexp with the default syntax
-F, --fixed-strings	Pattern is a string
-s, --case-sensitive	Search case-sensitively
-i, --ignore-case	Search case-insensitively
-S, --smart-case	Ignore case if pattern is all lower-case
--group / --no-group	Enable/disable grouping results by file
--hidden / --no-hidden	Enable/disable searching hidden files
-Cn, --context=n	Show n lines of context
-Bn, --before-context=n	Show n lines of leading context
-An, --after-context=n	Show n lines of trailing context

Programmatic interface

In addition to interactive use, Urgrep is designed to allow for programmatic use, returning a command to execute with the specified query and options: urgrep-command. This takes a query as well as several optional keyword arguments. For more information, consult the docstring for urgrep-command.

Contributing

This project assigns copyright to the Free Software Foundation, so if you'd like to contribute code, please make sure you've filled out the assignment form and that it's up to date. In any case, before submitting patches, it's probably best to file an issue first so that we can discuss the best way to do things.