learnbyexample / learn_gnugrep_ripgrep

Example based guide to mastering GNU grep and ripgrep

CLI text processing with GNU grep and ripgrep

Example based guide to mastering GNU grep and ripgrep. Visit https://youtu.be/MSbGokwHm-A for a short video about the book.

The book also includes exercises to test your understanding, which are presented together as a single file in this repo — Exercises.md

For solutions to the exercises, see Exercise_solutions.md.

You can also use this interactive TUI app to practice some of the exercises from the book.

See Version_changes.md to keep track of changes made to the book.

E-book

• You can purchase the pdf/epub versions of the book using these links:
  • https://learnbyexample.gumroad.com/l/gnugrep_ripgrep
  • https://leanpub.com/gnugrep_ripgrep
• You can also get the book as part of these bundles:
  • All books bundle bundle from https://learnbyexample.gumroad.com/l/all-books
    • Includes all my programming books
  • Magical one-liners bundle from https://learnbyexample.gumroad.com/l/oneliners or https://leanpub.com/b/oneliners
  • Awesome Regex bundle from https://learnbyexample.gumroad.com/l/regex or https://leanpub.com/b/regex
• See https://learnbyexample.github.io/books/ for a list of other books

For a preview of the book, see sample chapters.

The book can also be viewed as a single markdown file in this repo. See my blogpost on generating pdfs from markdown using pandoc if you are interested in the ebook creation process.

For the web version of the book, visit https://learnbyexample.github.io/learn_gnugrep_ripgrep/

Feedback and Contributing

⚠️ ⚠️ Please DO NOT submit pull requests. Main reason being any modification requires changes in multiple places.

I would highly appreciate if you'd let me know how you felt about this book. It could be anything from a simple thank you, pointing out a typo, mistakes in code snippets, which aspects of the book worked for you (or didn't!) and so on. Reader feedback is essential and especially so for self-published authors.

You can reach me via:

• Issue Manager: https://github.com/learnbyexample/learn_gnugrep_ripgrep/issues
• E-mail: echo 'bGVhcm5ieWV4YW1wbGUubmV0QGdtYWlsLmNvbQo=' | base64 --decode
• Twitter: https://twitter.com/learn_byexample

Table of Contents

1. Preface
2. Introduction
3. Frequently used options
4. BRE/ERE Regular Expressions
5. Context matching
6. Recursive search
7. Miscellaneous options
8. Perl Compatible Regular Expressions
9. Gotchas and Tricks
10. ripgrep
11. Further Reading

Acknowledgements

• GNU grep documentation — manual and examples
• ripgrep — user guide and examples
• stackoverflow and unix.stackexchange — for getting answers to pertinent questions on grep and related commands
• tex.stackexchange — for help on pandoc and tex related questions
• /r/commandline/, /r/linux4noobs/, /r/linuxquestions/ and /r/linux/ — helpful forums
• canva — cover image
• oxipng, pngquant and svgcleaner — optimizing images
• Warning and Info icons by Amada44 under public domain
• carbon — creating terminal screenshots with highlighted text
• Andrew Gallant (author of ripgrep), mikeblas and Pound-Hash for critical feedback
• mdBook — for web version of the book
  • mdBook-pagetoc — for adding table of contents for each chapter
  • minify-html — for minifying html files

Special thanks to all my friends and online acquaintances for their help, support and encouragement, especially during difficult times.

License

The book is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

The code snippets are licensed under MIT, see LICENSE file.