Skip to content

πŸ” Search directories quickly with ripgrep, respecting .gitignore rules and skipping hidden and binary files for efficient, line-oriented regex searches.

License

Unlicense and 2 other licenses found

Licenses found

Unlicense
UNLICENSE
Unknown
COPYING
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

watsthis/ripgrep

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

πŸ” ripgrep - Fast Searching Made Easy

πŸš€ Getting Started

Welcome to ripgrep! This tool helps you search through directories for specific text patterns quickly and efficiently. It respects your gitignore settings, which means it skips files you choose to ignore. With ripgrep, finding text in files is simple and straightforward.

πŸ“₯ Download & Install

To get started with ripgrep, you need to download the software. Click the link below to visit the Releases page, where you can find the latest version:

Download ripgrep

After visiting the page:

  1. Find the version you want to download. The latest version is usually at the top.
  2. Look for the file that matches your operating system. For example, if you are using Windows, look for a file that includes ".exe." If you are using macOS, look for a ".tar.gz" file.
  3. Click the link to download the file.

βš™οΈ System Requirements

Before you install ripgrep, ensure your system meets these requirements:

  • Operating Systems: Windows, macOS, or Linux.
  • Memory: At least 256 MB of RAM.
  • Storage: A minimum of 50 MB of free disk space.

πŸ“„ How to Use ripgrep

Once you have downloaded and installed ripgrep, you can start using it right away:

  1. Open the Terminal:

    • On Windows, you can use Command Prompt or PowerShell.
    • On macOS, open the Terminal app.
    • On Linux, open your preferred terminal emulator.
  2. Basic Command: Type the following command to search for a pattern in a directory:

    rg 'search-pattern' path/to/directory
    

    Replace search-pattern with the text you are looking for and path/to/directory with the path to the folder you want to search through.

  3. Example: To search for "example" in your documents folder, you would use:

    rg 'example' ~/Documents
    
  4. Using Regex: You can also use regular expressions to make your search more specific. For example, to find any word that starts with "ex", use:

    rg '\bex\w*' ~/Documents
    

🎯 Key Features

  • Speed: ripgrep is designed to search fast, even in large directories.
  • Gitignore Support: Automatically skips files and directories ignored by git.
  • Recursive Searching: Searches through subdirectories with no extra effort.
  • Simple Syntax: Easy-to-understand commands make searching intuitive.

πŸ› οΈ Common Commands

Here are some common commands to help you get the most out of ripgrep:

  • Search in Current Directory:

    rg 'pattern'
    
  • Search Case Insensitively:

    rg -i 'pattern'
    
  • Exclude Specific Files:

    rg --glob '!*.txt' 'pattern' 
    
  • Use a Different Regex Flavor: You can specify different regex flavors if needed.

πŸ“– Helpful Tips

  • Always double-check your commands. A small typo can lead to difficult searches.
  • Use quotation marks for phrases or complex patterns to ensure they are treated as one string.
  • Familiarize yourself with regular expressions if you want to perform advanced searches. There are many online resources available to learn from.

🌐 Community & Support

If you have questions or need help, the ripgrep community is here for you. You can:

  • Open an issue on the GitHub page for support.
  • Join discussions in the Issues tab to see if your questions have already been answered.

Feel free to share your experiences and improvements, as this tool relies on community feedback to grow and improve.

πŸ“„ Learn More

To dive deeper into the usage of ripgrep, check out the official documentation. It provides detailed examples and advanced usage notes that can be quite useful.

πŸ”— Additional Resources

For more information and updates:

By following these guidelines, ripgrep can become an invaluable tool in your daily tasks. Enjoy simple, swift, and effective searching!

About

πŸ” Search directories quickly with ripgrep, respecting .gitignore rules and skipping hidden and binary files for efficient, line-oriented regex searches.

Topics

Resources

License

Unlicense and 2 other licenses found

Licenses found

Unlicense
UNLICENSE
Unknown
COPYING
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 423