Rg Manual

rg.el is an Emacs search package based on the ripgrep command line tool. It allows you to interactively create searches, doing automatic searches based on the editing context, refining and modifying search results and much more. It is also highly configurable to be able to fit different users’ needs.

Throughout this manual this emacs package will be referred to as rg while the command line utility will be referred to as ripgrep.

If you are used to built-in Emacs rgrep command, transitioning to rg should be simple. rg provides a lot of extra features but the basics are similar.

The big benefit of using ripgrep instead of grep as a backend is speed. Especially when searching large source code repositories where ripgrep really shines. Please read this blog post for some speed comparisons with other tools.

• Usage
  • Installation
  • Searching
  • Results buffer
  • Search management
  • Multi line search
• Configuration
  • Customization
  • Faces
  • Configuration functions
  • Hooks
  • Configuration macros
  • Use with evil-mode
  • Customizing the menu
• Contribute
  • Pull requests
  • Docker
  • Tests
  • Documentation

License

rg is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

rg is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

• GNU General Public License