vivainio / roughgrep

Fast, brutalist UI on top of RipGrep

RoughGrep

Fast, brutalist UI on top of RipGrep

"You RipGrep, so why not RoughGrep?" -Anon, 2018

Installation

Grab it from Releases and unzip somewhere. Works best when you can launch it from command line.

If you want to install RoughGrep for Explorer right click context menu, run "rgg --install" as administator.

You can also install with Scoop:

# install scoop (in PowerShell)
$ iex (new-object net.webclient).downloadstring('https://get.scoop.sh')

# install scoop extras
$ scoop bucket add extras

# finally, install roughgrep
$ scoop install roughgrep

Requirements

• RipGrep (rg.exe) on PATH. "choco install ripgrep"
• Microsoft Windows (R)
• .NET Framework 4.7.2 (because Windows Forms font rendering is broken on the old ones)
• VSCode launcher ("code") on PATH

Usage

• Go to the directory you want to search from in prompt of your choice.

• Run rgg.exe. You may also add ripgrep command line arguments, e.g. rgg -g *.fs to restrict the search to glob pattern

• Enter the search string in the box and press enter.

• Navigate the results. When you find interesting result you can:

  • Press space to open the file at line in preview window
  • Press ENTER to open it in VSCode
  • Press p to open the parent project DIRECTORY in vscode. RoughGrep takes the best guess on what that might be (e.g. finds .csproj).
  • Press n to create a note from current line (and file) to scratchpad window. If there is selection, it's appended instead of just the line.
  • Press g to view git history for the file in gitk.
  • Press d to open containing folder in Windows file explorer.

• You can modify RipGrep command line arguments after launch by using the ComboBox from the Status Bar.

• If you want to find file names instead of finding contents, use the --files command line argument. Then, the "text to search for" inputs becomes the list of glob patterns instead.

• Configurable in Scheme! Undocumented, but you get the idea.

Acknowledgements

Credit for the blazing fast UI performance goes to ScintillaNet editor component.

License

MIT

roughgrep's Issues

"Search this" on context menu

dark theme needed, plz fix

search for `gbk` content, show errow

Chinese and Japanese badly display:

And if I use ripgrep, it correctly display:

screenshot for website

Accessing from explorervia context menu for simpler access

I have found this be really useful when I am not already using the command line - any thoughts on including an option to make it easier to have context menu integration?

For my setup, only on folders, I implemented like this from a batch file:

@echo off
SET rggPath=C:\pathto\yourcopyof\rgg.exe
 
rem add it for folders
@reg add "HKEY_CLASSES_ROOT\Folder\shell\rough grep"         /t REG_SZ /v "" /d "rough grep"   /f
@reg add "HKEY_CLASSES_ROOT\Folder\shell\rough grep"         /t REG_EXPAND_SZ /v "Icon" /d "%rggPath%,0" /f
@reg add "HKEY_CLASSES_ROOT\Folder\shell\rough grep\command" /t REG_SZ /v "" /d "%rggPath% \"%%1\"" /f
pause

Needs focus on editor window on open

"Open Folder" functionality

To be the best, rgg needs an open folder feature.