본문으로 건너뛰기
오픈소스 전체 목록

ripgrep

  • 추천0
  • GitHub 별70K
  • 검색라이선스Unlicense

gitignore를 존중하며 디렉터리를 재귀로 검색하는 아주 빠른 Rust 검색 도구(rg). MIT 또는 Unlicense

원본:BurntSushi/ripgrep

요약

gitignore를 존중하며 디렉터리를 재귀로 검색하는 아주 빠른 Rust 검색 도구(rg). MIT 또는 Unlicense

설명

ripgrep (rg)

ripgrep은 현재 디렉터리를 재귀로 훑으며 정규식 패턴을 찾는, 줄 단위 검색 도구입니다. 기본적으로 gitignore 규칙을 따르고, 숨김 파일 · 디렉터리와 바이너리 파일은 자동으로 건너뜁니다. (자동 필터링을 모두 끄려면 rg -uuu를 쓰세요.) ripgrep은 Windows, macOS, Linux를 일급으로 지원하며, 모든 릴리스에 내려받을 수 있는 바이너리가 있습니다. ripgrep은 The Silver Searcher, ack, grep 같은 다른 인기 검색 도구와 비슷합니다.

빌드 상태 Crates.io 패키징 상태

MIT 또는 UNLICENSE의 이중 라이선스입니다.

변경 기록

릴리스 이력은 CHANGELOG를 보세요.

문서 바로가기

검색 결과 스크린샷

ripgrep으로 한 검색 예시 스크린샷

도구별 빠른 비교 예시

이 예시는 리눅스 커널 소스 트리(make defconfig && make -j8을 실행한 뒤) 전체에서 [A-Z]+_SUSPEND를 찾되, 일치하는 것이 모두 단어여야 합니다. 시간은 Intel i9-12900K 5.2 GHz 시스템에서 잰 값입니다.

벤치마크 하나로는 절대 충분하지 않다는 점을 기억하세요! 더 많은 벤치마크와 분석을 담은 아주 자세한 비교는 ripgrep에 관한 제 블로그 글을 보세요.

도구명령줄 수시간
ripgrep (Unicode)rg -n -w '[A-Z]+_SUSPEND'5360.082s (1.00x)
hypergrephgrep -n -w '[A-Z]+_SUSPEND'5360.167s (2.04x)
git grepgit grep -P -n -w '[A-Z]+_SUSPEND'5360.273s (3.34x)
The Silver Searcherag -w '[A-Z]+_SUSPEND'5340.443s (5.43x)
ugrepugrep -r --ignore-files --no-hidden -I -w '[A-Z]+_SUSPEND'5360.639s (7.82x)
git grepLC_ALL=C git grep -E -n -w '[A-Z]+_SUSPEND'5360.727s (8.91x)
git grep (Unicode)LC_ALL=en_US.UTF-8 git grep -E -n -w '[A-Z]+_SUSPEND'5362.670s (32.70x)
ackack -w '[A-Z]+_SUSPEND'26772.935s (35.94x)

다음은 같은 말뭉치에서 gitignore 파일을 무시하고 허용 목록으로 검색하는 또 다른 벤치마크입니다. 말뭉치는 앞의 벤치마크와 같고, 각 명령에 준 플래그는 서로 같은 일을 하도록 맞춘 것입니다.

도구명령줄 수시간
ripgreprg -uuu -tc -n -w '[A-Z]+_SUSPEND'4470.063s (1.00x)
ugrepugrep -r -n --include='*.c' --include='*.h' -w '[A-Z]+_SUSPEND'4470.607s (9.62x)
GNU grepgrep -E -r -n --include='*.c' --include='*.h' -w '[A-Z]+_SUSPEND'4470.674s (10.69x)

이제 큰 파일 하나를 검색하는 경우로 넘어갑니다. 메모리에 올려 둔 파일(약 13GB, 압축을 푼 OpenSubtitles.raw.en.gz)에서 ripgrep, ugrep, GNU grep을 곧바로 비교한 것입니다.

도구명령줄 수시간
ripgrep (Unicode)rg -w 'Sherlock [A-Z]\w+'78821.042s (1.00x)
ugrepugrep -w 'Sherlock [A-Z]\w+'78821.339s (1.28x)
GNU grep (Unicode)LC_ALL=en_US.UTF-8 egrep -w 'Sherlock [A-Z]\w+'78826.577s (6.31x)

위 벤치마크에서 -n 플래그(줄 번호 표시)를 주면 ripgrep은 1.664s, GNU grep은 9.484s로 늘어납니다. ugrep의 시간은 -n이 있든 없든 달라지지 않습니다.

그래도 성능이 크게 떨어지는 구간을 조심하세요.

도구명령줄 수시간
ripgrep (Unicode)rg -w '[A-Z]\w+ Sherlock [A-Z]\w+'4851.053s (1.00x)
GNU grep (Unicode)LC_ALL=en_US.UTF-8 grep -E -w '[A-Z]\w+ Sherlock [A-Z]\w+'4856.234s (5.92x)
ugrepugrep -w '[A-Z]\w+ Sherlock [A-Z]\w+'48528.973s (27.51x)

그리고 리터럴로 최적화할 여지가 없는 패턴으로 큰 파일을 검색하면 모든 도구의 성능이 급격히 떨어질 수 있습니다.

도구명령줄 수시간
ripgreprg '[A-Za-z]{30}'674915.569s (1.00x)
ugrepugrep -E '[A-Za-z]{30}'674921.857s (1.40x)
GNU grepLC_ALL=C grep -E '[A-Za-z]{30}'674932.409s (2.08x)
GNU grep (Unicode)LC_ALL=en_US.UTF-8 grep -E '[A-Za-z]{30}'67958m30s (32.74x)

마지막으로, 일치하는 수가 많으면 성능이 떨어지고 도구 사이의 차이도 줄어듭니다(성능이 일치를 찾는 알고리즘이 아니라 일치 하나를 얼마나 빨리 처리하느냐에 좌우되기 때문입니다).

도구명령줄 수시간
ripgreprg the834999156.948s (1.00x)
ugrepugrep the8349991511.721s (1.69x)
GNU grepLC_ALL=C grep the8349991515.217s (2.19x)

왜 ripgrep을 써야 하나요?

  • 다른 검색 도구가 하던 많은 일을 대신할 수 있습니다. 그 도구들의 기능 대부분을 갖췄고 대체로 더 빠릅니다. (ripgrep이 정말 grep을 대체할 수 있는지는 FAQ에 더 자세히 있습니다.)
  • 코드 검색에 특화된 다른 도구처럼 ripgrep은 기본으로 재귀 검색을 하고 자동 필터링을 합니다. 곧 .gitignore / .ignore / .rgignore 파일이 무시하는 파일은 검색하지 않고, 숨김 파일과 바이너리 파일도 검색하지 않습니다. 자동 필터링은 rg -uuu로 끌 수 있습니다.
  • ripgrep은 특정 종류의 파일만 검색할 수 있습니다. 예를 들어 rg -tpy foo는 검색을 Python 파일로 한정하고, rg -Tjs foo는 JavaScript 파일을 검색에서 뺍니다. 사용자 정의 일치 규칙으로 새 파일 종류를 가르칠 수도 있습니다.
  • ripgrep은 주변 줄(context) 표시, 여러 패턴 검색, 색으로 일치 강조, 완전한 유니코드 지원처럼 grep에 있는 많은 기능을 지원합니다. GNU grep과 달리 ripgrep은 유니코드(항상 켜져 있음)를 지원하면서도 빠릅니다.
  • ripgrep은 정규식 엔진을 PCRE2로 바꾸는 선택 지원이 있습니다. 덕분에 기본 정규식 엔진이 지원하지 않는 lookaround와 역참조를 패턴에 쓸 수 있습니다. PCRE2는 -P/--pcre2(항상 PCRE2 사용) 또는 --auto-hybrid-regex(필요할 때만 PCRE2 사용)로 켤 수 있습니다. --engine (default|pcre2|auto) 옵션으로도 고를 수 있습니다.
  • ripgrep은 맞은 내용에 따라 출력을 다시 쓰는 초보적인 치환 지원이 있습니다.
  • ripgrep은 UTF-8이 아닌 텍스트 인코딩의 파일 검색을 지원합니다. UTF-16, latin-1, GBK, EUC-JP, Shift_JIS 등이 그렇습니다. (UTF-16은 어느 정도 자동 감지를 지원합니다. 다른 텍스트 인코딩은 -E/--encoding 플래그로 직접 지정해야 합니다.)
  • ripgrep은 -z/--search-zip 플래그로 흔한 형식(brotli, bzip2, gzip, lz4, lzma, xz, zstandard)으로 압축된 파일의 검색을 지원합니다.
  • ripgrep은 PDF 텍스트 추출, 덜 쓰이는 압축 해제, 복호화, 인코딩 자동 감지 같은 임의의 입력 전처리 필터를 지원합니다.
  • ripgrep은 설정 파일로 설정할 수 있습니다.

다시 말해 속도, 기본 필터링, 더 적은 버그, 유니코드 지원이 마음에 든다면 ripgrep을 쓰세요.

왜 ripgrep을 쓰지 말아야 하나요?

처음에는 ripgrep에 온갖 기능을 다 넣고 싶지 않았지만, 시간이 지나며 다른 파일 검색 도구에 있는 대부분의 기능을 지원하게 되었습니다. 여러 줄에 걸친 결과 검색과, lookaround · 역참조를 제공하는 PCRE2의 선택 지원도 여기에 들어갑니다.

지금은 ripgrep을 쓰지 말아야 할 주된 이유가 다음 가운데 하나 이상일 것입니다.

  • 이식성 있고 어디에나 있는 도구가 필요합니다. ripgrep은 Windows, macOS, Linux에서 동작하지만 어디에나 있지는 않고 POSIX 같은 표준을 따르지도 않습니다. 이 일에 가장 알맞은 도구는 오래된 좋은 grep입니다.
  • 이 README에 적혀 있지 않지만 내가 의존하는 기능(또는 버그)이 다른 도구에는 있고 ripgrep에는 없습니다.
  • ripgrep이 잘하지 못하는 성능상의 예외 상황이 있고 다른 도구는 잘합니다. (버그 보고를 올려 주세요!)
  • 내 컴퓨터에 ripgrep을 설치할 수 없거나 내 플랫폼에서 쓸 수 없습니다. (버그 보고를 올려 주세요!)

정말 다른 어떤 것보다 빠른가요?

대체로 그렇습니다. 항목마다 자세한 분석을 곁들인 많은 벤치마크가 제 블로그에 있습니다.

요약하면 ripgrep이 빠른 이유는 다음과 같습니다.

  • Rust의 정규식 엔진 위에 만들었습니다. Rust의 정규식 엔진은 유한 오토마타, SIMD, 공격적인 리터럴 최적화로 검색을 아주 빠르게 합니다. (-P/--pcre2 플래그로 PCRE2 지원을 선택할 수 있습니다.)
  • Rust의 정규식 라이브러리는 UTF-8 디코딩을 결정적 유한 오토마타 엔진에 곧바로 넣어 완전한 유니코드 지원에서도 성능을 유지합니다.
  • 메모리 맵으로 검색하거나, 중간 버퍼로 조금씩 검색할 수 있습니다. 앞쪽은 파일 하나에, 뒤쪽은 큰 디렉터리에 더 좋습니다. ripgrep이 알아서 가장 좋은 검색 전략을 고릅니다.
  • .gitignore 파일의 무시 패턴을 RegexSet으로 적용합니다. 그래서 파일 경로 하나를 여러 glob 패턴과 동시에 맞춰 볼 수 있습니다.
  • crossbeam과 ignore 덕분에 락 없는 병렬 재귀 디렉터리 반복자를 씁니다.

기능 비교

ack의 저자 Andy Lester가 ack, ag, git-grep, GNU grep, ripgrep의 기능을 비교한 훌륭한 표를 공개했습니다. https://beyondgrep.com/feature-comparison/

단, ripgrep에는 최근 Andy의 표에 아직 없는 중요한 새 기능이 몇 가지 생겼습니다. 설정 파일, passthru, 압축 파일 검색 지원, 여러 줄 검색, PCRE2를 통한 fancy regex 선택 지원 등이 여기에 들어가지만 이에 그치지 않습니다.

놀이터

설치하기 전에 ripgrep을 써 보고 싶다면 비공식 놀이터와 대화형 튜토리얼이 있습니다.

이에 대한 질문이 있으면 튜토리얼 저장소에 이슈를 열어 주세요.

설치

ripgrep의 바이너리 이름은 rg입니다.

Windows, macOS, Linux용 미리 빌드된 바이너리 압축 파일을 받을 수 있습니다. Linux와 Windows 바이너리는 정적 실행 파일입니다. 아래에 따로 적히지 않은 플랫폼의 사용자는 이 압축 파일 중 하나를 내려받기를 권합니다.

macOS Homebrew나 Linuxbrew 사용자라면 homebrew-core에서 ripgrep을 설치할 수 있습니다.

$ brew install ripgrep

MacPorts 사용자라면 공식 포트에서 ripgrep을 설치할 수 있습니다.

$ sudo port install ripgrep

Windows Chocolatey 사용자라면 공식 저장소에서 ripgrep을 설치할 수 있습니다.

$ choco install ripgrep

Windows Scoop 사용자라면 공식 버킷에서 ripgrep을 설치할 수 있습니다.

$ scoop install ripgrep

Windows Winget 사용자라면 winget-pkgs 저장소에서 ripgrep을 설치할 수 있습니다.

$ winget install BurntSushi.ripgrep.MSVC

Arch Linux 사용자라면 공식 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo pacman -S ripgrep

Gentoo 사용자라면 공식 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo emerge sys-apps/ripgrep

Fedora 사용자라면 공식 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo dnf install ripgrep

openSUSE 사용자라면, ripgrep은 15.1부터 openSUSE Tumbleweed와 openSUSE Leap에 들어 있습니다.

$ sudo zypper install ripgrep

CentOS Stream 10 사용자라면 EPEL 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo dnf config-manager --set-enabled crb
$ sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-10.noarch.rpm
$ sudo dnf install ripgrep

Red Hat 10 사용자라면 EPEL 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo subscription-manager repos --enable codeready-builder-for-rhel-10-$(arch)-rpms
$ sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-10.noarch.rpm
$ sudo dnf install ripgrep

Rocky Linux 10 사용자라면 EPEL 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-10.noarch.rpm
$ sudo dnf install ripgrep

Nix 사용자라면 nixpkgs에서 ripgrep을 설치할 수 있습니다.

$ nix-env --install ripgrep

Flox 사용자라면 ripgrep을 이렇게 설치할 수 있습니다.

$ flox install ripgrep

Guix 사용자라면 공식 패키지 모음에서 ripgrep을 설치할 수 있습니다.

$ guix install ripgrep

Debian 사용자(또는 Ubuntu 같은 Debian 파생 배포판 사용자)라면, 각 ripgrep 릴리스에 들어 있는 바이너리 .deb 파일로 ripgrep을 설치할 수 있습니다.

$ curl -LO https://github.com/BurntSushi/ripgrep/releases/download/14.1.1/ripgrep_14.1.1-1_amd64.deb
$ sudo dpkg -i ripgrep_14.1.1-1_amd64.deb

Debian 안정판을 쓴다면 ripgrep은 Debian이 공식으로 관리하지만, 버전이 앞 단계의 deb 패키지보다 오래되었을 수 있습니다.

$ sudo apt-get install ripgrep

Ubuntu Cosmic (18.10)(또는 그 이후) 사용자라면 Debian과 같은 패키징으로 ripgrep을 쓸 수 있습니다.

$ sudo apt-get install ripgrep

(참고: Ubuntu용 ripgrep snap도 여러 가지 있지만, 어느 것도 제대로 동작하지 않는 것 같고 고칠 방법도 시간도 없는 매우 이상한 버그 보고를 여럿 만들어 냅니다. 그래서 더는 권장하는 설치 방법이 아닙니다.)

ALT 사용자라면 공식 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo apt-get install ripgrep

FreeBSD 사용자라면 공식 포트에서 ripgrep을 설치할 수 있습니다.

$ sudo pkg install ripgrep

OpenBSD 사용자라면 공식 포트에서 ripgrep을 설치할 수 있습니다.

$ doas pkg_add ripgrep

NetBSD 사용자라면 pkgsrc에서 ripgrep을 설치할 수 있습니다.

$ sudo pkgin install ripgrep

Haiku x86_64 사용자라면 공식 포트에서 ripgrep을 설치할 수 있습니다.

$ sudo pkgman install ripgrep

Haiku x86_gcc2 사용자라면 x86 보조 아키텍처 빌드를 써서 Haiku x86_64와 같은 포트에서 ripgrep을 설치할 수 있습니다.

$ sudo pkgman install ripgrep_x86

Void Linux 사용자라면 공식 저장소에서 ripgrep을 설치할 수 있습니다.

$ sudo xbps-install -Syv ripgrep

Rust 프로그래머라면 cargo로 ripgrep을 설치할 수 있습니다.

  • ripgrep이 지원하는 최소 Rust 버전은 1.96.0이지만, 더 오래된 버전에서도 동작할 수 있습니다.
  • 바이너리가 기대보다 클 수 있다는 점에 유의하세요. 디버그 기호가 들어 있기 때문이며 의도한 것입니다. 디버그 기호를 없애 파일 크기를 줄이려면 바이너리에 strip을 실행하세요.
$ cargo install ripgrep

또는 cargo binstall로 GitHub에서 ripgrep 바이너리를 곧바로 설치할 수도 있습니다.

$ cargo binstall ripgrep

빌드

ripgrep은 Rust로 작성되어 있으므로 컴파일하려면 Rust를 설치해야 합니다. ripgrep은 Rust 1.96.0(stable) 이상으로 컴파일됩니다. 대체로 ripgrep은 Rust 컴파일러의 최신 stable 릴리스를 따라갑니다.

ripgrep을 빌드하려면 이렇게 하세요.

$ git clone https://github.com/BurntSushi/ripgrep
$ cd ripgrep
$ cargo build --release
$ ./target/release/rg --version
0.1.3

참고: 예전에는 ripgrep이 Rust nightly 컴파일러에서 simd-accel Cargo 기능을 지원했습니다. 이는 UTF-16 트랜스코딩에만 도움이 되었습니다. 불안정한 기능이 필요해서 이 빌드 방식은 자주 깨졌고, 그래서 지원을 없앴습니다. UTF-16 트랜스코딩의 SIMD 최적화를 원한다면 encoding_rs 프로젝트에 안정(stable) API를 쓰라고 요청해야 합니다.

마지막으로, pcre2 기능을 켜면 ripgrep에 선택 사항인 PCRE2 지원을 넣어 빌드할 수 있습니다.

$ cargo build --release --features 'pcre2'

PCRE2 기능을 켜는 것은 stable Rust 컴파일러로 동작하며, pkg-config로 시스템의 PCRE2 라이브러리를 자동으로 찾아 링크하려고 합니다. 없으면 ripgrep이 시스템 C 컴파일러로 PCRE2를 소스에서 빌드하고 최종 실행 파일에 정적으로 링크합니다. 시스템 PCRE2 라이브러리가 있어도 MUSL 타깃으로 ripgrep을 빌드하거나 PCRE2_SYS_STATIC=1을 설정하면 정적 링크를 강제할 수 있습니다.

Linux에서는 먼저 시스템에 MUSL 라이브러리를 설치하고(친근한 이웃 패키지 관리자에게 물어보세요) Rust 툴체인에 MUSL 지원을 더한 뒤 ripgrep을 다시 빌드하면, 완전히 정적인 실행 파일이 나옵니다.

$ rustup target add x86_64-unknown-linux-musl
$ cargo build --release --target x86_64-unknown-linux-musl

위의 --features 플래그를 적용해도 기대한 대로 동작합니다. MUSL과 PCRE2로 정적 실행 파일을 빌드하려면 musl-gcc가 설치되어 있어야 하는데, 배포판에 따라 실제 MUSL 라이브러리와 다른 패키지에 들어 있을 수 있습니다.

테스트 실행

ripgrep은 단위 테스트와 통합 테스트를 모두 갖춘, 비교적 잘 테스트된 프로젝트입니다. 전체 테스트를 실행하려면 이렇게 하세요.

$ cargo test --all

저장소 루트에서 실행합니다.

관련 도구

  • delta는 rg --json 출력 형식을 지원하는 구문 강조 페이저입니다. 그래서 rg --json pattern | delta만 하면 동작합니다. 자세한 내용은 delta 매뉴얼의 grep 절을 보세요.

취약점 보고

보안 취약점을 보고하려면 Andrew Gallant에게 연락해 주세요. 연락 페이지에 암호화한 메시지를 보내고 싶을 때 쓸 이메일 주소와 PGP 공개 키가 있습니다.

번역

다음은 ripgrep 문서의 알려진 번역 목록입니다. 비공식으로 관리되며 최신이 아닐 수 있습니다.

저장소

BurntSushi/ripgrep

평점

–평가 0개 기준
5점
0
4점
0
3점
0
2점
0
1점
0