Search a project

Introduction

ripgrep searches files recursively with regular expressions. It skips hidden and gitignored files by default.

Find a match

rg TODO

Output

tests/main_test.rs:// TODO: add a test
scratch.md:TODO: untracked scratch note
src/lib.rs:    // TODO: validate input
src/main.rs:    // TODO: bind the port

Each match prints its path and matching line; -n adds line numbers.

See: ripgrep repository

Search a path

rg TODO src
rg -n 'TODO' src/main.rs tests

Pass files or directories after the pattern to narrow the search.

See: rg --help (USAGE)

List files with matches

rg -l TODO

Output

scratch.md
tests/main_test.rs
src/lib.rs
src/main.rs

-l prints only the paths that contain a match.

See: rg --help (-l)

Search patterns

Regex and fixed strings

Regex

rg 'a.b' notes.txt
# → path a.b
# → path axb

Fixed string

rg -F 'a.b' notes.txt
# → path a.b

. is a regex wildcard; -F treats the pattern as literal text.

See: regex syntax

Case and words

rg -i todo
rg -S todo
rg -w port

Case-sensitive by default. -i ignores case, -S only for all-lowercase patterns, -w matches whole words.

See: rg --help (-i, -S, -w)

Whole lines and inversion

rg -x 'port: 8080' config.yml
rg -v TODO src/lib.rs

-x matches the entire line; -v selects the lines without a match.

See: rg --help (-x, -v)

Multiple patterns

rg 'TODO|FIXME'
rg -e TODO -e FIXME

Both forms find the same matches; -e may be repeated.

See: regex syntax

Files and globs

rg --files

Output

scratch.md
notes.txt
config.yml
README.md
tests/main_test.rs
src/lib.rs
src/main.rs

--files lists what rg would search, after ignore rules are applied.

See: rg --help (--files)

Include globs

rg -g '*.rs' TODO

Output

tests/main_test.rs:// TODO: add a test
src/lib.rs:    // TODO: validate input
src/main.rs:    // TODO: bind the port

-g uses gitignore-style patterns and may be repeated.

See: gitignore patterns

Exclude globs

rg -g '!tests/**' TODO

Output

scratch.md:TODO: untracked scratch note
src/lib.rs:    // TODO: validate input
src/main.rs:    // TODO: bind the port

A leading ! removes paths from the search.

See: gitignore patterns

File types

rg -t rust TODO
rg -T rust TODO

-T inverts the type filter; rg --type-list lists the known types.

See: rg --help (--type, --type-list)

Hidden and ignored files

Hidden

rg --hidden -g '!.git/**' token
# → .hidden.toml:token = "hidden-token"

Ignored

rg --no-ignore TODO

Output

build/output.log:TODO: ignored build line
tests/main_test.rs:// TODO: add a test
src/lib.rs:    // TODO: validate input
src/main.rs:    // TODO: bind the port
scratch.md:TODO: untracked scratch note

--hidden also enters .git; exclude it with a glob. --no-ignore overrides .gitignore and .ignore.

See: rg --help (--hidden, --no-ignore)

Output and context

Context lines

rg -n -C 1 TODO src/main.rs

Output

2-    let port = 8080;
3:    // TODO: bind the port
4-}

Options

FlagPrints
-A NN lines after each match
-B NN lines before each match
-C NN lines on both sides

See: rg --help (-A, -B, -C)

Paths and line numbers

With paths

rg -n -H port src

Output

src/main.rs:2:    let port = 8080;
src/main.rs:3:    // TODO: bind the port

Without paths

rg -I -n port src

Output

2:    let port = 8080;
3:    // TODO: bind the port

-H forces paths; -I removes them. --column adds a column number.

See: rg --help (-H, -I, --column)

Count matching lines

rg -c TODO src tests

Output

tests/main_test.rs:1
src/lib.rs:1
src/main.rs:1

--count-matches counts matches rather than matching lines.

See: rg --help (-c, --count-matches)

Only matching text

rg -n -o 'port: \d+' config.yml
# → 2:port: 8080

-o prints each match instead of its whole line.

See: regex syntax

Replacement

Replace printed matches

rg -o 'TODO: (\w+)' -r '$1!' src

Output

src/main.rs:bind!
src/lib.rs:validate!

-r changes only printed output, never the files. Capture groups use $1.

See: rg --help (-r)

Keep non-matching lines

rg --passthru -r '<todo>' TODO src/main.rs

Output

fn main() {
    let port = 8080;
    // <todo>: bind the port
}

--passthru prints every line, replacing matches in place.

See: rg --help (--passthru)

Multiline and PCRE2

rg -U '(?s)fn main\(\).*?TODO' src/main.rs

Output

fn main() {
    let port = 8080;
    // TODO: bind the port

-U spans lines; (?s) makes . match newlines; --multiline-dotall applies that globally.

See: regex syntax

PCRE2 lookaround

rg -P '(?<=TODO: )\w+' src tests

Output

tests/main_test.rs:// TODO: add a test
src/lib.rs:    // TODO: validate input
src/main.rs:    // TODO: bind the port

The default engine rejects look-around; -P switches to PCRE2.

See: PCRE2 syntax

Engine selection

FlagEffect
-P, --pcre2Use PCRE2
--engine pcre2Use PCRE2 (long form)
--no-pcre2Restore the default
--engine defaultUse the default engine

See: rg --help (--engine)

Integration

With find (xargs)

find src tests -name '*.rs' -print0 \
  | xargs -0 rg -H -n TODO

Output

tests/main_test.rs:1:// TODO: add a test
src/main.rs:3:    // TODO: bind the port
src/lib.rs:2:    // TODO: validate input

-print0/-0 handle spaces; -H keeps filenames for single-file batches.

See: find(1)

With find (exec)

find src tests -name '*.rs' \
  -exec rg -H -n TODO {} +

Output

src/lib.rs:2:    // TODO: validate input
src/main.rs:3:    // TODO: bind the port
tests/main_test.rs:1:// TODO: add a test

-exec ... + batches matched files into one rg call.

See: find(1)

With git

git ls-files -z | xargs -0 rg -n TODO

Output

tests/main_test.rs:1:// TODO: add a test
src/main.rs:3:    // TODO: bind the port
src/lib.rs:2:    // TODO: validate input

rg already skips gitignored files; git ls-files narrows the search to tracked files.

See: git-ls-files

0 Comments for this cheatsheet. Write yours!