1
0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-07-25 09:11:57 -07:00
Files
.cargo
.github
benchsuite
ci
crates
cli
core
flags
README.md
haystack.rs
logger.rs
main.rs
messages.rs
search.rs
globset
grep
ignore
matcher
pcre2
printer
regex
searcher
doc
pkg
scripts
tests
.gitignore
.ignore
CHANGELOG.md
COPYING
Cargo.lock
Cargo.toml
FAQ.md
GUIDE.md
LICENSE-MIT
README.md
RELEASE-CHECKLIST.md
UNLICENSE
build.rs
rustfmt.toml
ripgrep/crates/core

ripgrep core

This is the core ripgrep crate. In particular, main.rs is where the main function lives.

Most of ripgrep core consists of two things:

  • The definition of the CLI interface, including docs for every flag.
  • Glue code that brings the grep-matcher, grep-regex, grep-searcher and grep-printer crates together to actually execute the search.

Currently, there are no plans to make ripgrep core available as an independent library. However, much of the heavy lifting of ripgrep is done via its constituent crates, which can be reused independent of ripgrep. Unfortunately, there is no guide or tutorial to teach folks how to do this yet.