Deadgrep is the fast, beautiful text search that your Emacs deserves.
Table of Contents
-
Install ripgrep. You need version 0.8 or later.
-
Install deadgrep from MELPA (do
M-x package-installRETdeadgrepwithin Emacs 25.1 or later), or copy it into your~/.emacs.d. -
(Optional) add deadgrep to a convenient shortcut. I like F5.
(global-set-key (kbd "<f5>") #'deadgrep)Navigating results:
| Key | Action |
|---|---|
| RET | Visit the result, file or push button at point |
| o | Visit the result in another window |
| n and p | Move between search hits |
| M-n and M-p | Move between file headers |
The commands deadgrep-forward and deadgrep-backward are also
available to move between buttons as well as search hits.
Starting/stopping a search:
| Key | Action |
|---|---|
| S | Change the search term |
| T | Cycle through available search types: string, words, regexp |
| C | Cycle through case sensitivity types: smart, sensitive, ignore |
| F | Cycle through file modes: all, type, glob |
| I | Switch to incremental search, re-running on every keystroke |
| D | Change the search directory |
| ^ | Re-run the search in the parent directory |
| g | Re-run the search |
| TAB | Expand/collapse results for a file |
| C-c C-k | Stop a running search |
| C-u | A prefix argument prevents search commands from starting automatically. |
| Name | Action |
|---|---|
imenu |
Move between files in a results buffer. |
deadgrep-kill-all-buffers |
Kill all open deadgrep buffers. |
deadgrep-debug |
In a results buffer, view the rg command, output and environment used. |
You use the minibuffer to enter a new search term.
You can also reuse a previous search term with M-p in the minibuffer. To edit the default search term, use M-n.
The easiest way to debug search results is to review the actual rg command executed.
Fortunately, the deadgrep-debug function makes it easy:
- Move to the deadgrep results buffer.
- Type
M-x deadgrep-debug. - Strike
enter, and the debug buffer will appear. - Move to the deadgrep debug buffer.
Study the results to review the rg command string and other debugging information to assist you.
Deadgrep uses ripgrep for extremely fast text searches.
If you change your search settings, deadgrep will immediately re-run your search.
Deadgrep works hard to minimise your keystrokes.
Search term: If the region is active, deadgrep uses that.
Search directory: If your current file is in a VCS repository, deadgrep uses that for your search directory.
Regexp and case sensitivity options: Deadgrep re-uses whatever settings you used in your last search.
Globbing and file types: Deadgrep suggests file types and globbing options that match the file you started the search from.
Host: If you're editing a remote file with Tramp, deadgrep will
search the remote machine. This requires rg to be installed on that
machine.
Didn't get the results you wanted? It's easy to change the search term, search type, or search directory, directly from the results buffer. Just push the relevant button.
Deadgrep uses spinners to give you feedback on whether your search has finished.
It highlights regexp syntax according to the syntax accepted by rg.
When navigating to a line that matched, the relevant part of the line is temporarily highlighted.
You can collapse and expand files with TAB.
Deadgrep handles minified files robustly.
You can always jump to exactly the position that point is on, even when searching files that contain tab characters. You can also navigate to the file itself from the file headings.
You can now edit files directly from results buffers with M-x deadgrep-edit-mode.
It is currently in beta. Alternatively, package wgrep
added support for editing deadgrep buffers in April 2023 via wgrep-deadgrep.
(One feature unlocked that way is, e.g., the ability to delete a line in edit mode via C-d)
I believe that deadgrep is the best tool for doing Emacs text searches, but there are some other great tools out there. See ALTERNATIVES for a discussion.
The name "deadgrep" is a pun on "R.I.P. grep", and ripgrep.el was already taken.
R.I.P wasn't actually the intention of the name "ripgrep" (see their FAQ), but deadgrep is easy to remember and type.
