twin/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-05-19 09:40:22 -07:00
Code Issues Packages Projects Releases Wiki Activity

readme: add more links to overview

Browse Source 
Many of the features are documented in the GUIDE, so let's just link to
them.
This commit is contained in:
Andrew Gallant 2022-10-19 11:06:44 -04:00
parent 5b2f614aad
commit 55e62a4411
No known key found for this signature in database
GPG Key ID: B2E3A4923F8B0D44
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -90,16 +90,16 @@ times are unaffected by the presence or absence of `-n`.
because it contains most of their features and is generally faster. (See because it contains most of their features and is generally faster. (See
[the FAQ](FAQ.md#posix4ever) for more details on whether ripgrep can truly [the FAQ](FAQ.md#posix4ever) for more details on whether ripgrep can truly
replace grep.) replace grep.)
* Like other tools specialized to code search, ripgrep defaults to recursive * Like other tools specialized to code search, ripgrep defaults to
directory search and won't search files ignored by your [recursive search](GUIDE.md#recursive-search) and does [automatic
`.gitignore`/`.ignore`/`.rgignore` files. It also ignores hidden and binary filtering](GUIDE.md#automatic-filtering). Namely, ripgrep won't search files
files by default. ripgrep also implements full support for `.gitignore`, ignored by your `.gitignore`/`.ignore`/`.rgignore` files, it won't search
whereas there are many bugs related to that functionality in other code hidden files and it won't search binary files. Automatic filtering can be
search tools claiming to provide the same functionality. disabled with `rg -uuu`.
* ripgrep can search specific types of files. For example, `rg -tpy foo` * ripgrep can [search specific types of files](GUIDE.md#manual-filtering-file-types).
limits your search to Python files and `rg -Tjs foo` excludes JavaScript For example, `rg -tpy foo` limits your search to Python files and `rg -Tjs
files from your search. ripgrep can be taught about new file types with foo` excludes JavaScript files from your search. ripgrep can be taught about
custom matching rules. new file types with custom matching rules.
* ripgrep supports many features found in `grep`, such as showing the context * ripgrep supports many features found in `grep`, such as showing the context
of search results, searching multiple patterns, highlighting matches with of search results, searching multiple patterns, highlighting matches with
color and full Unicode support. Unlike GNU grep, ripgrep stays fast while color and full Unicode support. Unlike GNU grep, ripgrep stays fast while
@ -110,16 +110,20 @@ times are unaffected by the presence or absence of `-n`.
regex engine. PCRE2 support can be enabled with `-P/--pcre2` (use PCRE2 regex engine. PCRE2 support can be enabled with `-P/--pcre2` (use PCRE2
always) or `--auto-hybrid-regex` (use PCRE2 only if needed). An alternative always) or `--auto-hybrid-regex` (use PCRE2 only if needed). An alternative
syntax is provided via the `--engine (default|pcre2|auto-hybrid)` option. syntax is provided via the `--engine (default|pcre2|auto-hybrid)` option.
* ripgrep supports searching files in text encodings other than UTF-8, such * ripgrep has [rudimentary support for replacements](GUIDE.md#replacements),
as UTF-16, latin-1, GBK, EUC-JP, Shift_JIS and more. (Some support for which permit rewriting output based on what was matched.
automatically detecting UTF-16 is provided. Other text encodings must be * ripgrep supports [searching files in text encodings](GUIDE.md#file-encoding)
specifically specified with the `-E/--encoding` flag.) other than UTF-8, such as UTF-16, latin-1, GBK, EUC-JP, Shift_JIS and more.
(Some support for automatically detecting UTF-16 is provided. Other text
encodings must be specifically specified with the `-E/--encoding` flag.)
* ripgrep supports searching files compressed in a common format (brotli, * ripgrep supports searching files compressed in a common format (brotli,
bzip2, gzip, lz4, lzma, xz, or zstandard) with the `-z/--search-zip` flag. bzip2, gzip, lz4, lzma, xz, or zstandard) with the `-z/--search-zip` flag.
* ripgrep supports * ripgrep supports
[arbitrary input preprocessing filters](GUIDE.md#preprocessor) [arbitrary input preprocessing filters](GUIDE.md#preprocessor)
which could be PDF text extraction, less supported decompression, decrypting, which could be PDF text extraction, less supported decompression, decrypting,
automatic encoding detection and so on. automatic encoding detection and so on.
* ripgrep can be configured via a
[configuration file](GUIDE.md#configuration-file).
In other words, use ripgrep if you like speed, filtering by default, fewer In other words, use ripgrep if you like speed, filtering by default, fewer
bugs and Unicode support. bugs and Unicode support.