برای مثال، جهت جستجوی عبارت متنی مستقیم -foo:

rg -e -foo

همچنین می‌توانید از جداکننده ویژه -- استفاده کنید تا نشان دهید پرچم دیگری ارائه نخواهد شد. به طور مشخص، دستور زیر معادل دستور بالا است:

rg -- -foo

هنگامی که -f/--file یا -e/--regexp استفاده شود، ripgrep تمامی آرگومان‌های موضعی را به عنوان فایل‌ها یا دایرکتوری‌هایی برای جستجو در نظر می‌گیرد.

یک خط تنها در صورتی چاپ می‌شود که حداقل با یکی از الگوها تطبیق یابد.

هنگامی که PATTERNFILE برابر با - باشد، الگوها از stdin خوانده خواهند شد.

هنگامی که -f/--file یا -e/--regexp استفاده شود، ripgrep تمامی آرگومان‌های موضعی را به عنوان فایل‌ها یا دایرکتوری‌هایی برای جستجو در نظر می‌گیرد.

هشدار (WARNING)

هنگامی که این پرچم تنظیم شود، ripgrep بدون قید و شرط برای هر فایلی که جستجو می‌شود یک فرآیند (process) ایجاد می‌کند. بنابراین اگر به انعطاف‌پذیری ارائه‌شده توسط این پرچم نیازی نداشته باشید، این امر می‌تواند افت کارایی بسیار زیادی را تحمیل کند. یک راهکار ممکن برای کاهش این مشکل، استفاده از پرچم --pre-glob برای محدود کردن فایل‌هایی است که پیش‌پردازنده روی آن‌ها اجرا می‌شود.

هنگامی که ripgrep در حال جستجوی stdin است، پیش‌پردازنده اجرا نمی‌شود.

هنگام جستجو در میان مجموعه‌ای از فایل‌ها که ممکن است به یکی از چندین پیش‌پردازنده نیاز داشته باشند، COMMAND باید یک برنامه پوششی (wrapper) باشد که ابتدا PATH را بر اساس شماره‌های جادویی (magic numbers)/محتوا یا بر اساس نام PATH دسته‌بندی کرده و سپس آن را به پیش‌پردازنده مناسب ارسال کند. همچنین ورودی استاندارد هر COMMAND برای سهولت به PATH متصل است.

برای مثال، یک اسکریپت شل برای COMMAND ممکن است به این شکل باشد:

case "$1" in
*.pdf)
    exec pdftotext "$1" -
    ;;
*)
    case $(file "$1") in
    *Zstandard*)
        exec pzstd -cdq
        ;;
    *)
        exec cat
        ;;
    esac
    ;;
esac

اسکریپت بالا از pdftotext برای تبدیل یک فایل PDF به متن ساده استفاده می‌کند. برای سایر فایل‌ها، اسکریپت از ابزار file برای تشخیص نوع فایل بر اساس محتوای آن بهره می‌برد. اگر فایلی فشرده‌شده در قالب Zstandard باشد، آنگاه از pzstd برای خارج کردن محتوا از حالت فشرده به سمت stdout استفاده می‌شود.

این گزینه بر پرچم -z/--search-zip اولویت دارد.

این پرچم هنگام جستجوی فایل‌های متعدد به همراه پرچم --pre مفید است؛ بدین صورت که امکان جلوگیری از ایجاد سربار فرآیند را برای فایل‌هایی که نیازی به پیش‌پردازش ندارند فراهم می‌سازد. برای مثال، با در نظر گرفتن اسکریپت شل زیر با نام pre-pdftotext:

#!/bin/sh
pdftotext "$1" -

می‌توان از --pre pre-pdftotext --pre-glob '*.pdf' استفاده کرد تا ripgrep دستور pre-pdftotext را فقط روی فایل‌های دارای پسوند .pdf اجرا کند.

می‌توان از چندین پرچم --pre-glob استفاده کرد. قوانین تطبیق الگو (globbing) با الگوهای gitignore یکسان است. برای مستثنی کردن یک الگو، یک نویسه ! قبل از آن قرار دهید.

اگر از پرچم --pre استفاده نشود، این پرچم هیچ اثری نخواهد داشت.

توجه داشته باشید که این پرچم باعث نمی‌شود ripgrep قالب‌های آرشیو را مانند ساختار درختی دایرکتوری‌ها جستجو کند. این پرچم تنها سبب می‌شود ripgrep فایل‌های فشرده را تشخیص داده و قبل از جستجوی محتوای آن‌ها همانند هر فایل دیگری، آن‌ها را از حالت فشرده خارج سازد.

این گزینه بر پرچم --pre اولویت دارد.

این پرچم را می‌توان با --no-search-zip غیرفعال کرد.

این یک گزینه سراسری است که برای تمام الگوهای داده‌شده به ripgrep اعمال می‌شود. الگوهای منفرد همچنان می‌توانند با استفاده از نشانگرهای درون‌خطی regex، به صورت غیرحساس به حروف مطابقت داده شوند. برای مثال، (?i)abc حتی در صورت استفاده از این پرچم، با abc به صورت غیرحساس به حروف مطابقت خواهد داشت.

این پرچم، پرچم‌های -i/--ignore-case و -S/--smart-case را لغو می‌کند.

در اصل، این به لنگرهای خط ^ و $ در الگوهای regex اجازه می‌دهد تا CRLF،‏ CR یا LF را به‌جای صرفاً LF به عنوان پایان‌دهنده خط در نظر بگیرند. توجه داشته باشید که آن‌ها هرگز بین یک CR و یک LF تطبیق داده نمی‌شوند. با CRLF به عنوان یک پایان‌دهنده خط واحد رفتار می‌شود.

هنگام استفاده از موتور regex پیش‌فرض، پشتیبانی از CRLF را می‌توان در داخل الگو با پرچم R نیز فعال کرد. برای مثال، (?R:$) دقیقاً پیش از CR یا LF تطبیق می‌یابد، اما هرگز بین CR و LF قرار نمی‌گیرد.

این پرچم، --null-data را لغو می‌کند.

این پرچم را می‌توان با --no-crlf غیرفعال کرد.

قالب ورودی پسوندهای K،‏ M یا G را می‌پذیرد که به ترتیب نشان‌دهنده کیلوبایت، مگابایت و گیگابایت هستند. اگر پسوندی ارائه نشود، ورودی به عنوان بایت در نظر گرفته می‌شود.

سایر مقادیر پشتیبانی‌شده را می‌توان در فهرست برچسب‌ها در اینجا یافت: https://encoding.spec.whatwg.org/#concept-encoding-get.

برای جزئیات بیشتر درباره کدگذاری و نحوه برخورد ripgrep با آن، GUIDE.md را ببینید.

تشخیص کدگذاری که ripgrep استفاده می‌کند را می‌توان با پرچم --no-encoding به حالت خودکار آن بازگرداند.

مقادیر پذیرفته‌شده عبارتند از default،‏ pcre2، یا auto.

مقدار پیش‌فرض default است که معمولاً سریع‌ترین گزینه است و باید برای بیشتر موارد استفاده مناسب باشد. موتور pcre2 عموماً زمانی مفید است که بخواهید از قابلیت‌هایی مانند look-around یا پس‌ارجاع‌ها (backreferences) استفاده کنید. مقدار auto بسته به ویژگی‌های استفاده‌شده در الگو، با نهایت تلاش به صورت پویا میان موتورهای regex پشتیبانی‌شده انتخاب می‌کند.

توجه داشته باشید که موتور pcre2 یک قابلیت اختیاری در ripgrep است. اگر PCRE2 در ساخت ripgrep شما گنجانده نشده باشد، استفاده از این پرچم منجر به چاپ پیام خطا توسط ripgrep و خروج از برنامه می‌شود.

این پرچم کاربردهای قبلی پرچم‌های -P/--pcre2 و --auto-hybrid-regex را لغو می‌کند.

این پرچم را می‌توان با --no-fixed-strings غیرفعال کرد.

این یک گزینه سراسری است که برای تمامی الگوهای داده‌شده به ripgrep اعمال می‌شود. الگوهای منفرد همچنان می‌توانند با استفاده از پرچم‌های درون‌خطی regex به صورت حساس به حروف تطبیق داده شوند. برای مثال، (?-i)abc حتی در صورت استفاده از این پرچم، با abc به صورت حساس به حروف تطبیق می‌یابد.

این پرچم، -s/--case-sensitive و -S/--smart-case را لغو می‌کند.

توجه داشته باشید که این گزینه تنها تطبیق خط‌به‌خط را معکوس می‌کند. برای مثال، ترکیب این پرچم با -l/--files-with-matches فایل‌هایی را نشان می‌دهد که دارای هر خطی باشند که با الگوهای ارائه‌شده مطابقت ندارد. این با گزینه‌ای مانند --files-without-match یکسان نیست، که فایل‌هایی را خروجی می‌دهد که هیچ خط منطبقی در آن‌ها وجود ندارد.

این پرچم را می‌توان با --no-invert-match غیرفعال کرد.

این پرچم، پرچم -w/--word-regexp را لغو می‌کند.

هنگامی که از -U/--multiline استفاده می‌شود، یک تطابق واحد که چندین خط را در بر می‌گیرد، برای این محدودیت تنها یک بار شمرده می‌شود. تطابق‌های متعدد در یک خط منفرد تنها یک بار شمرده می‌شوند، درست همان‌طور که در حالت غیرچندخطی رفتار می‌شود.

در صورت ترکیب با -A/--after-context یا -C/--context، اگر خطوط زمینه (context) دارای تطابق باشند، ممکن است تطابق‌های بیشتری نسبت به حد حداکثر چاپ شوند.

توجه داشته باشید که 0 یک مقدار مجاز است اما بعید است مفید باشد. در صورت استفاده از آن، ripgrep هیچ چیزی را جستجو نخواهد کرد.

جستجوی نگاشت حافظه در تمامی شرایط قابل استفاده نیست. برای مثال، هنگام جستجوی فایل‌های مجازی یا جریان‌هایی مانند stdin. در چنین مواردی، حتی در صورت فعال بودن این پرچم، از نگاشت حافظه استفاده نخواهد شد.

توجه داشته باشید که در صورت استفاده از نگاشت حافظه، اگر ripgrep فایلی را جستجو کند که هم‌زمان کوتاه (truncate) می‌شود، ممکن است به طور غیرمنتظره متوقف شود. کاربران می‌توانند با غیرفعال کردن نگاشت حافظه، از وقوع این احتمال جلوگیری کنند.

این پرچم را می‌توان با --no-mmap غیرفعال کرد.

هنگامی که حالت چندخطی فعال است، ripgrep این محدودیت را که تطابق نمی‌تواند شامل نویسه پایان‌دهنده خط باشد، برمی‌دارد. برای مثال، وقتی حالت چندخطی فعال نیست (پیش‌فرض)، عبارت باقاعده \p{any} با هر نقطه کد (codepoint) یونیکد به جز \n تطبیق می‌یابد. به طور مشابه، استفاده از عبارت باقاعده \n صریحاً ممنوع است و اگر سعی کنید از آن استفاده کنید، ripgrep خطایی برمی‌گرداند. با این حال، وقتی حالت چندخطی فعال باشد، \p{any} با هر نقطه کد یونیکد، از جمله \n تطبیق پیدا می‌کند و عبارات باقاعده‌ای مانند \n مجاز هستند.

یک نکته مهم این است که حالت چندخطی معناشناسی تطابق . را تغییر نمی‌دهد؛ به این معنی که در اکثر موتورهای تطبیق regex، یک . به طور پیش‌فرض با هر نویسه‌ای غیر از \n مطابقت دارد و این موضوع در ripgrep نیز صادق است. برای اینکه . با \n تطبیق داده شود، باید پرچم «dot all» را در داخل عبارت باقاعده فعال کنید. برای مثال، هر دو عبارت (?s). و (?s:.) معناشناسی یکسانی دارند که در آن . با هر نویسه‌ای از جمله \n مطابقت می‌یابد. در غیر این صورت، پرچم --multiline-dotall می‌تواند برای تبدیل رفتار «dot all» به پیش‌فرض ارسال شود. این پرچم تنها زمانی اعمال می‌شود که جستجوی چندخطی فعال باشد.

هیچ محدودیتی در تعداد خطوطی که یک تطابق منفرد می‌تواند در بر گیرد وجود ندارد.

هشدار: به دلیل نحوه عملکرد موتور regex زیرین، جستجوهای چندخطی ممکن است کندتر از جستجوهای عادی خط‌محور باشند و همچنین ممکن است حافظه بیشتری مصرف کنند. به‌ویژه، هنگامی که حالت چندخطی فعال است، ripgrep نیاز دارد که هر فایلی که جستجو می‌کند به طور پیوسته در حافظه قرار گیرد (خواه با خواندن آن روی heap یا با نگاشت حافظه آن). مواردی که نمی‌توان آن‌ها را نگاشت حافظه کرد (مانند stdin) پیش از شروع جستجو تا رسیدن به EOF به طور کامل خوانده خواهند شد. به طور کلی، ripgrep این اقدامات را تنها در صورت لزوم انجام می‌دهد. به طور مشخص، اگر پرچم -U/--multiline داده شود اما regex شامل الگوهایی نباشد که با نویسه‌های \n تطبیق یابند، ripgrep به طور خودکار از خواندن کل فایل در حافظه قبل از جستجو در آن خودداری می‌کند. با این وجود، اگر فقط به تطابق‌هایی اهمیت می‌دهید که حداکثر یک خط را در بر می‌گیرند، همیشه بهتر است حالت چندخطی را غیرفعال کنید.

این پرچم، پرچم --stop-on-nonmatch را لغو می‌کند.

این پرچم را می‌توان با --no-multiline غیرفعال کرد.

به طور معمول، . با هر نویسه‌ای به جز پایان‌دهنده‌های خط مطابقت پیدا می‌کند. در حالی که این رفتار معمولاً برای تطبیق خط‌محور مرتبط نیست (زیرا تطابق‌ها حداکثر می‌توانند یک خط را در بر گیرند)، هنگام جستجو با پرچم -U/--multiline می‌تواند مفید باشد. به طور پیش‌فرض، حالت چندخطی بدون فعال بودن حالت «dot all» اجرا می‌شود.

این پرچم به طور کلی برای استفاده در یک نام مستعار (alias) یا فایل پیکربندی ripgrep شما در نظر گرفته شده است اگر معناشناسی «dot all» را به طور پیش‌فرض ترجیح می‌دهید. توجه داشته باشید که صرف‌نظر از استفاده شدن یا نشدن این پرچم، معناشناسی «dot all» همچنان از طریق پرچم‌های درون‌خطی در خود الگوی regex قابل کنترل است، برای مثال (?s:.) همیشه «dot all» را فعال می‌کند، در حالی که (?-s:.) همیشه «dot all» را غیرفعال می‌سازد. علاوه بر این، می‌توانید از رده‌های نویسه مانند \p{any} برای تطبیق با هر نقطه کد یونیکد بدون توجه به فعال بودن یا نبودن حالت «dot all» استفاده کنید.

این پرچم را می‌توان با --no-multiline-dotall غیرفعال کرد.

به طور پیش‌فرض، ripgrep «حالت یونیکد» را در تمام عبارات باقاعده خود فعال می‌کند. این امر پیامدهای متعددی دارد: نویسه . تنها با مقادیر اسکالر معتبر یونیکد کدگذاری‌شده با UTF-8 مطابقت پیدا می‌کند.

• کلاس‌هایی مانند \w، \s و \d همگی سازگار با یونیکد هستند و دامنه بسیار گسترده‌تری نسبت به نسخه‌های صرفاً ASCII خود دارند.
• تطبیق غیرحساس به حروف کوچک و بزرگ از فولدینگ حروف یونیکد (Unicode case folding) استفاده خواهد کرد.
• طیف گسترده‌ای از کلاس‌ها مانند \p{Emoji} در دسترس هستند. (اگرچه مجموعه کلاس‌های در دسترس بسته به موتور regex متغیر است. به‌طور کلی، موتور regex پیش‌فرض کلاس‌های بیشتری را پشتیبانی می‌کند.)
• مرزهای کلمه (\b و \B) از تعریف یونیکد برای نویسه‌های کلمه استفاده می‌کنند.

در برخی موارد ممکن است غیرفعال کردن این ویژگی‌ها مطلوب باشد. این پرچم دقیقاً همین کار را انجام می‌دهد. برای مثال، حالت یونیکد گاهی می‌تواند تأثیر منفی بر کارایی داشته باشد، به‌ویژه هنگامی که مواردی مانند \w مکرراً استفاده می‌شوند (از جمله با تکرارهای مقید مانند \w{100}) در حالی که تنها تفسیر ASCII آن‌ها مورد نیاز است.

این پرچم را می‌توان با --unicode غیرفعال کرد.

این قابلیت هنگام جستجو در فایل‌های باینری بزرگ مفید است؛ فایل‌هایی که اگر از \n به عنوان پایان‌دهندهٔ خط در آن‌ها استفاده می‌شد، خطوط بسیار طویلی می‌داشتند. به‌ویژه اینکه ripgrep نیاز دارد هر خط دست‌کم در حافظه جا شود. استفاده از NUL می‌تواند یک راهکار موقتِ سودمند برای پایین نگه داشتن حافظه مورد نیاز و جلوگیری از شرایط OOM (کمبود حافظه / out of memory) باشد.

این گزینه همچنین برای پردازش داده‌های جداشده با NUL، مانند خروجی تولیدشده هنگام استفاده از پرچم -0/--null در ripgrep یا پرچم --print0 در find، مفید است.

استفاده از این پرچم به معنای اعمال خودکار -a/--text است. این پرچم همچنین اولویت بالاتری نسبت به --crlf دارد و آن را نادیده می‌گیرد.

این گزینه به‌طور کلی زمانی سودمند است که می‌خواهید از امکاناتی مانند look-around یا ارجاع به گذشته (backreferences) استفاده کنید.

استفاده از این پرچم معادل ارسال --engine=pcre2 است. کاربران می‌توانند به جای آن از --engine=auto استفاده کنند تا ripgrep به‌طور خودکار موتور regex مناسب را بر اساس الگوهای داده‌شده انتخاب کند. این پرچم و پرچم --engine یکدیگر را لغو می‌کنند.

توجه داشته باشید که PCRE2 یک قابلیت اختیاری در ripgrep است. اگر PCRE2 در بیلد ripgrep شما گنجانده نشده باشد، استفاده از این پرچم باعث چاپ یک پیام خطا توسط ripgrep و خروج از برنامه خواهد شد. همچنین PCRE2 در برخی موارد ممکن است تجربه کاربری ضعیف‌تری ارائه دهد، زیرا APIهای درون‌نگری (introspection APIs) کمتری نسبت به موتور regex پیش‌فرض ripgrep دارد. به عنوان مثال، اگر از یک \n در regex مربوط به PCRE2 بدون پرچم -U/--multiline استفاده کنید، ripgrep بدون اعلام خطا هیچ تطابقی پیدا نخواهد کرد (silently fail)، در حالی که در موتور regex پیش‌فرض بلافاصله خطایی گزارش می‌شود.

این پرچم را می‌توان با --no-pcre2 غیرفعال کرد.

تغییر این مقدار زمانی مفید است که صراحتاً بخواهید به ripgrep اجازه دهید تا در صورت نیاز زمان و/یا حافظه بسیار بیشتری را برای ساخت تطبیق‌دهندهٔ regex صرف کند.

قالب ورودی پسوندهای K، M یا G را می‌پذیرد که به ترتیب متناظر با کیلوبایت، مگابایت و گیگابایت هستند. اگر پسوندی ارائه نشود، ورودی به عنوان بایت در نظر گرفته می‌شود.

یک الگو در صورتی تماماً با حروف کوچک در نظر گرفته می‌شود که هر دو شرط زیر برقرار باشند:

• نخست، الگو شامل حداقل یک نویسه عینی (literal) باشد. برای مثال، a\w حاوی یک نویسه عینی (a) است، اما \w به‌تنهایی چنین نیست.
• دوم، از میان نویسه‌های عینی موجود در الگو، هیچ‌کدام طبق یونیکد حرف بزرگ به شمار نیایند. برای مثال، foo\pL هیچ نویسه بزرگی ندارد اما Foo\pL دارای نویسه بزرگ است.

این گزینه بر پرچم‌های -s/--case-sensitive و -i/--ignore-case اولویت دارد و آن‌ها را لغو می‌کند.

این گزینه پرچم -U/--multiline را نادیده می‌گیرد و بر آن اولویت دارد.

تشخیص فایل باینری، در زمان فعال بودن نیز عملکردی کاملاً بی‌نقص ندارد. به‌طور کلی، این سازوکار از یک روش مکاشفه‌ای (heuristic) ساده استفاده می‌کند. اگر در حین جستجو یک بایت NUL دیده شود، فایل باینری در نظر گرفته شده و جستجو متوقف می‌شود (مگر اینکه این پرچم داده شده باشد). در مقابل، اگر از پرچم --binary استفاده شود، ripgrep تنها زمانی متوقف می‌شود که پس از یافتن یک تطابق، بایت NUL را مشاهده کند (یا تمام فایل را جستجو نماید).

این پرچم اولویت بالاتری نسبت به --binary دارد و آن را لغو می‌کند.

این پرچم را می‌توان با --no-text غیرفعال کرد.

این گزینه پرچم -x/--line-regexp را نادیده می‌گیرد.

هنگام استفاده از این پرچم، ripgrep بسته به قابلیت‌های استفاده‌شده در الگو، به‌طور پویا میان موتورهای regex پشتیبانی‌شده یکی را انتخاب می‌کند. هنگامی که ripgrep موتور regex را انتخاب کرد، این انتخاب را برای تمام عبارات باقاعده ارائه‌شده به ripgrep (مثلاً از طریق چندین پرچم -e/--regexp یا -f/--file) اعمال می‌کند.

به عنوان نمونه‌ای از رفتار این پرچم، ripgrep هر زمان که الگو بتواند با موفقیت توسط موتور regex پیش‌فرض مبتنی بر اتوماتای متناهی کامپایل شود، تلاش می‌کند از آن استفاده کند. اگر PCRE2 فعال باشد و الگوی داده‌شده نتواند با موتور regex پیش‌فرض کامپایل شود، PCRE2 به‌طور خودکار برای جستجو به کار گرفته خواهد شد. اگر PCRE2 در دسترس نباشد، این پرچم اثری ندارد زیرا تنها یک موتور regex برای انتخاب وجود خواهد داشت.

در آینده ممکن است ripgrep قواعد مکاشفه‌ای خود را برای نحوه تصمیم‌گیری درباره موتور regex مورد استفاده تغییر دهد. به‌طور کلی، این مکاشفه‌ها محدود به تحلیل ایستای الگوها خواهند بود و نه رفتارهای مشخص زمان اجرا حین جستجوی فایل‌ها.

نقطه ضعف اصلی استفاده از این پرچم این است که ممکن است همیشه مشخص نباشد ripgrep از کدام موتور regex استفاده می‌کند، و بنابراین ممکن است معناشناسی تطابق یا مشخصات کارایی ripgrep به‌طور نامحسوس و غیرمنتظره‌ای دستخوش تغییر شود. با این حال، در بسیاری از موارد همه موتورهای regex درباره نتیجه تطابق توافق دارند و پشتیبانی شفاف از ویژگی‌های پیشرفته‌تر regex مانند look-around و مراجع بازگشتی بدون نیاز صریح به فعال کردن آن‌ها می‌تواند مناسب باشد.

این پرچم را می‌توان با --no-auto-hybrid-regex غیرفعال کرد.

توجه داشته باشید که حالت یونیکد به‌طور پیش‌فرض فعال است.

این پرچم را می‌توان با --pcre2-unicode غیرفعال کرد.

فایل‌های دودویی بر اساس وجود یا عدم وجود بایت NUL به‌صورت اکتشافی شناسایی می‌شوند. به‌طور پیش‌فرض (بدون تنظیم این پرچم)، به محض مشاهده یک بایت NUL، جستجوی فایل توسط ripgrep متوقف می‌شود. معمولاً بایت‌های NUL در ابتدای بیشتر فایل‌های دودویی قرار دارند. اگر بایت NUL پس از یک تطابق رخ دهد، ripgrep آن تطابق را چاپ نخواهد کرد، جستجوی آن فایل را متوقف می‌کند و هشداری مبنی بر نادیده گرفته شدن برخی از تطابق‌ها صادر می‌نماید.

در مقابل، هنگام استفاده از این پرچم، ripgrep حتی در صورت یافتن بایت NUL به جستجوی فایل ادامه خواهد داد. به‌ویژه، در صورت مشاهده بایت NUL، جستجو تا زمان یافتن یک تطابق یا رسیدن به انتهای فایل (هرکدام زودتر رخ دهد) ادامه می‌یابد. اگر تطابقی یافت شود، ripgrep متوقف شده و هشداری مبنی بر توقف زودهنگام جستجو چاپ می‌کند.

اگر می‌خواهید ripgrep فایلی را بدون هیچ‌گونه رسیدگی ویژه به بایت‌های NUL جستجو کند (و احتمالاً داده‌های دودویی را در خروجی استاندارد stdout چاپ نماید)، باید از پرچم -a/--text استفاده کنید.

پرچم --binary پرچمی برای کنترل سازوکار پالایش خودکار ripgrep است. از این رو، هنگام جستجوی صریح یک فایل مشخص یا هنگام جستجو در ورودی استاندارد stdin نیازی به استفاده از آن نیست؛ یعنی تنها هنگام جستجوی بازگشتی در یک دایرکتوری کاربرد دارد.

هنگامی که پرچم -u/--unrestricted سه بار تکرار شود، این پرچم به‌طور خودکار فعال می‌گردد.

این پرچم بر پرچم -a/--text اولویت دارد.

این پرچم را می‌توان با --no-binary غیرفعال کرد.

این پرچم را می‌توان با --no-follow غیرفعال کرد.

به‌عنوان یک قابلیت الحاقی، الگوهای glob از تعیین گزینه‌های جانشین پشتیبانی می‌کنند: -g 'ab{c,d}*' معادل است با -g abc -g abd. گزینه‌های جانشین خالی مانند -g 'ab{,c}' در حال حاضر پشتیبانی نمی‌شوند. توجه داشته باشید که این افزونهٔ نحوی در حال حاضر در فایل‌های gitignore نیز فعال است، حتی با وجود اینکه این نحو توسط خود git پشتیبانی نمی‌شود. ممکن است ripgrep این افزونهٔ نحوی را در فایل‌های gitignore غیرفعال کند، اما همواره از طریق پرچم -g/--glob در دسترس خواهد بود.

هنگامی که این پرچم تنظیم شود، هر فایل و دایرکتوری برای بررسی تطابق با آن ارزیابی می‌شود. برای نمونه، اگر تنها می‌خواهید در یک دایرکتوری خاص با نام foo جستجو کنید، استفاده از -g foo نادرست است زیرا foo/bar با الگوی foo مطابقت ندارد. در عوض، باید از -g 'foo/**'. استفاده کنید.

این پرچم را می‌توان با --no-glob-case-insensitive غیرفعال کرد.

یک فایل یا دایرکتوری در صورتی مخفی در نظر گرفته می‌شود که نام پایهٔ آن با یک نویسه نقطه (.) شروع شود. در سیستم‌عامل‌هایی که از صفت فایل «مخفی» پشتیبانی می‌کنند، مانند Windows، فایل‌های دارای این صفت نیز مخفی تلقی می‌شوند.

توجه داشته باشید که -./--hidden فایل‌ها و پوشه‌هایی مانند .git را صرف‌نظر از پرچم --no-ignore-vcs شامل خواهد کرد. برای مستثنی کردن چنین مسیرهایی هنگام استفاده از -./--hidden، باید صریحاً آن‌ها را با استفاده از پرچمی دیگر یا یک فایل چشم‌پوشی نادیده بگیرید.

این پرچم را می‌توان با --no-hidden غیرفعال کرد.

اگر به دنبال روشی برای گنجاندن یا استثنا کردن مستقیم فایل‌ها و دایرکتوری‌ها در خط فرمان هستید، در عوض از -g/--glob استفاده کنید.

این پرچم را می‌توان با --no-ignore-file-case-insensitive غیرفعال کرد.

برای نمونه، rg --max-depth 0 dir/ هیچ اثری ندارد زیرا به داخل dir/ ورود نمی‌کند. دستور rg --max-depth 1 dir/ تنها فرزندان مستقیم dir را جستجو می‌کند.

نگارش جایگزین برای این پرچم --maxdepth است.

قالب ورودی پسوندهای K، M یا G را می‌پذیرد که به‌ترتیب متناظر با کیلوبایت، مگابایت و گیگابایت هستند. در صورت عدم درج پسوند، مقدار بر حسب بایت در نظر گرفته می‌شود.

مثال‌ها: --max-filesize 50K یا --max-filesize 80M.

این گزینه شامل --no-ignore-files نمی‌شود، چرا که --ignore-file صریحاً به‌عنوان یک آرگومان خط فرمان تعیین می‌گردد.

هنگامی که پرچم -u/--unrestricted تنها یک بار داده شود، رفتاری کاملاً مشابه با این پرچم خواهد داشت و می‌توان آن را یک نام مستعار در نظر گرفت. با این حال، تکرار بیشتر پرچم -u/--unrestricted تأثیرات مضاعفی به دنبال دارد.

این پرچم را می‌توان با --ignore غیرفعال کرد.

این گزینه تأثیری بر نادیده گرفتن فایل‌ها و دایرکتوری‌هایی که نامشان با نقطه آغاز می‌شود توسط ripgrep ندارد. برای آن منظور، پرچم -./--hidden را ببینید. این پرچم همچنین تأثیری بر رعایت قواعد پالایش در فایل‌های .gitignore ندارد.

این پرچم را می‌توان با --ignore-dot غیرفعال کرد.

این پرچم را می‌توان با --ignore-exclude غیرفعال کرد.

این پرچم را می‌توان با --ignore-files غیرفعال کرد.

این پرچم را می‌توان با --ignore-global غیرفعال کرد.

این پرچم را می‌توان با --ignore-parent غیرفعال کرد.

توجه داشته باشید که این پرچم مستقیماً بر پالایش فایل‌ها یا پوشه‌های کنترل نسخه‌ای که با نقطه (.) آغاز می‌شوند (مانند .git) اثر نمی‌گذارد. این موارد در عوض تحت تأثیر -./--hidden و پرچم‌های مربوط به آن هستند.

این پرچم برای فایل‌های چشم‌پوشی سامانه کنترل نسخه به منزلهٔ اعمال --no-ignore-parent نیز هست.

این پرچم را می‌توان با --ignore-vcs غیرفعال کرد.

به‌طور پیش‌فرض، ripgrep تنها زمانی قواعد پالایش فایل‌های چشم‌پوشی سامانه کنترل نسخه را رعایت می‌کند که تشخیص دهد جستجو در داخل یک مخزن کنترل نسخه در حال اجراست؛ برای نمونه، هنگامی که یک دایرکتوری .git مشاهده شود.

این پرچم محدودیت پیش‌فرض فوق را برمی‌دارد. برای مثال، این پرچم زمانی می‌تواند سودمند باشد که محتویات یک مخزن git در محلی ذخیره یا کپی شده باشد، اما وضعیت اصلی مخزن وجود نداشته باشد.

این پرچم را می‌توان با --require-git غیرفعال کرد.

توجه داشته باشید که این حالت به ازای هر آرگومان مسیر داده‌شده به ripgrep اعمال می‌شود. برای نمونه، در دستور

rg --one-file-system /foo/bar /quux/baz

ابزار ripgrep هر دو مسیر /foo/bar و /quux/baz را حتی در صورت قرار داشتن روی سیستم‌های فایل متفاوت جستجو می‌کند، اما هنگام پیمایش درخت دایرکتوریِ هر مسیر، از مرز سیستم فایل مربوط به آن عبور نخواهد کرد.

این رفتار مشابه پرچم -xdev یا -mount در دستور find است.

این پرچم را می‌توان با --no-one-file-system غیرفعال کرد.

این پرچم از مقدار ویژهٔ all پشتیبانی می‌کند؛ در این حالت دستور به‌گونه‌ای عمل خواهد کرد که گویی -t/--type برای تک‌تک انواع فایل‌های پشتیبانی‌شده توسط ripgrep (از جمله انواع فایل‌های سفارشی) داده شده است. نتیجه این است که --type=all موجب می‌شود ripgrep در حالت «فهرست سفید» جستجو کند، به این معنا که تنها فایل‌هایی را جستجو می‌کند که از طریق تعاریف نوع خود می‌شناسد.

توجه داشته باشید که اولویت این پرچم نسبت به پرچم -g/--glob و هرگونه قواعد موجود در فایل‌های چشم‌پوشی کمتر است.

برای مشاهدهٔ فهرست انواع فایل‌های موجود، از پرچم --type-list استفاده کنید.

این پرچم از مقدار ویژهٔ all پشتیبانی می‌کند؛ در این صورت عملکرد آن همانند ارائه‌شدن -T/--type-not برای تمام انواع فایل‌های پشتیبانی‌شده توسط ripgrep (شامل انواع فایل‌های سفارشی) خواهد بود. نتیجه آن است که --type-not=all موجب کارکرد ripgrep در حالت «فهرست سیاه» می‌شود؛ یعنی فقط فایل‌هایی که توسط تعاریف نوع آن ناشناخته هستند جستجو خواهند شد.

جهت مشاهده فهرست انواع فایل‌های دردسترس، از پرچم --type-list استفاده کنید.

توجه داشته باشید که این پرچم باید در هر بار اجرای ripgrep به آن منتقل شود؛ زیرا تنظیمات نوع پایدار نمی‌مانند. برای یک راه‌حل دائمی، بخش CONFIGURATION FILES را بررسی کنید.

مثال:

rg --type-add 'foo:*.foo' -tfoo PATTERN

همچنین می‌توان از این پرچم برای وارد کردن قواعد از انواع دیگر با استفاده از دستور ویژه include بهره گرفت. این دستور ویژه اجازه می‌دهد یک یا چند نام نوع دیگر (جداشده با ویرگول) که تعریف شده‌اند تعیین گردند و قواعد آن‌ها به‌طور خودکار به نوع مشخص‌شده وارد شوند. برای نمونه، به‌منظور ایجاد یک نوع به نام src که با فایل‌های C++، Python و Markdown مطابقت داشته باشد، می‌توان دستور زیر را به کار برد:

--type-add 'src:include:cpp,py,md'

با تکرار استفاده از این پرچم، همچنان می‌توان قواعد glob بیشتری را به نوع src اضافه نمود:

--type-add 'src:include:cpp,py,md' --type-add 'src:*.foo'

توجه داشته باشید که نام انواع فایل فقط باید شامل حروف یا ارقام یونیکد باشد. استفاده از نویسه‌های نشانه‌گذاری مجاز نیست.

توجه داشته باشید که این گزینه باید در هر بار فراخوانی ripgrep داده شود؛ تنظیمات نوع فایل ماندگار نیستند. برای یک راه‌حل پایدار، بخش CONFIGURATION FILES را ببینید.

یک بار استفاده از پرچم -u/--unrestricted معادل --no-ignore است. دو بار استفاده از -u/--unrestricted معادل --no-ignore -./--hidden خواهد بود. سه بار استفاده از آن معادل --no-ignore -./--hidden --binary است.

تنها پالایشی که ripgrep حتی در هنگام استفاده از -uuu همچنان انجام می‌دهد، نادیده گرفتن پیوندهای نمادین و جلوگیری از چاپ تطابق‌های مربوط به فایل‌های دودویی است. پیوندهای نمادین را می‌توان با پرچم -L/--follow دنبال کرد و با فایل‌های دودویی نیز می‌توان از طریق پرچم -a/--text مانند فایل‌های متنی رفتار نمود. -A NUM, --after-context=NUM

-B NUM, --before-context=NUM

--block-buffered

-b, --byte-offset

--color=WHEN

--colors 'path:none' \
--colors 'line:none' \
--colors 'column:none' \
--colors 'match:none' \
--colors 'highlight:none'

--colors=COLOR_SPEC

rg --colors 'match:fg:magenta' --colors 'line:bg:yellow'

rg --colors 'highlight:bg:yellow' --colors 'highlight:fg:black'

rg --colors 'match:bg:0,128,255'

rg --colors 'match:bg:0x0,0x80,0xFF'

--column

-C NUM, --context=NUM

--context-separator=SEPARATOR

--field-context-separator=SEPARATOR

--field-match-separator=SEPARATOR

--heading

-h, --help

--hostname-bin=COMMAND

--hyperlink-format=FORMAT

--colors 'path:none' \
--colors 'line:none' \
--colors 'column:none' \
--colors 'match:none'

rg foo path/to/file

--include-zero

--line-buffered

tail -f something.log | rg foo --line-buffered | rg bar

-n, --line-number

-N, --no-line-number

-M NUM, --max-columns=NUM

--max-columns-preview

-0, --null

-o, --only-matching

--path-separator=SEPARATOR

--passthru

-p, --pretty

-q, --quiet

-r REPLACEMENT, --replace=REPLACEMENT

--sort=SORTBY

--sortr=SORTBY

--trim

--vimgrep

-H, --with-filename

-I, --no-filename

--sort-files

-c, --count

--count-matches

-l, --files-with-matches

--files-without-match

--json

پرچم --debug عموماً برای یافتن دلیل نادیده گرفتن یک فایل خاص توسط ripgrep مفید است. پیام‌های اشکال‌زدایی باید تمام فایل‌های نادیده‌گرفته‌شده و دلیل آن را ذکر کنند.

برای دریافت خروجی اشکال‌زدایی با جزئیات بیشتر، از پرچم --trace استفاده کنید که شامل --debug به همراه داده‌های ردگیری تکمیلی است.

این پرچم را می‌توان با --ignore-messages غیرفعال کرد.

این پرچم را می‌توان با --messages غیرفعال کرد.

این مجموعه از آمارهای تجمیعی ممکن است در طول زمان گسترش یابد.

این پرچم هنگام استفاده از --json همواره به‌طور ضمنی فعال است.

توجه داشته باشید که این پرچم در صورت استفاده از --files، -l/--files-with-matches یا --files-without-match هیچ تأثیری ندارد.

این پرچم را می‌توان با --no-stats غیرفعال کرد.

این گزینه --type-list را لغو می‌کند.

man

یک صفحهٔ راهنما (man page) را برای ripgrep در قالب roff تولید می‌کند.

complete-bash

یک اسکریپت تکمیل خودکار برای پوستهٔ bash تولید می‌کند.

complete-zsh

یک اسکریپت تکمیل خودکار برای پوستهٔ zsh تولید می‌کند.

complete-fish

یک اسکریپت تکمیل خودکار برای پوستهٔ fish تولید می‌کند.

complete-powershell

یک اسکریپت تکمیل خودکار برای PowerShell تولید می‌کند.

خروجی در stdout نوشته می‌شود. فهرست بالا ممکن است در طول زمان گسترش یابد.

اگر زمانی قابلیتی به ripgrep افزوده شود که فایل‌های پیکربندی را به‌طور خودکار در مکان‌های از پیش تعریف‌شده بخواند، این پرچم آن رفتار را نیز غیرفعال خواهد کرد.