├── LICENSE └── README.md /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Sundeep Agarwal 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Command line text processing with Rust tools 2 | 3 | :information_source: :information_source: This is a **work-in-progress** book on text processing with command line Rust tools. 4 | 5 |
6 | 7 | ## E-book 8 | 9 | TODO: PDF/EPUB versions 10 | 11 | For web version of the book, visit https://learnbyexample.github.io/cli_text_processing_rust/ 12 | 13 |
14 | 15 | ## Planned list of tools 16 | 17 | * [ripgrep](https://github.com/BurntSushi/ripgrep) 18 | * [ripgrep-all](https://github.com/phiresky/ripgrep-all) 19 | * [sd](https://github.com/chmln/sd) 20 | * [frawk](https://github.com/ezrosent/frawk) 21 | * [hck](https://github.com/sstadick/hck) 22 | * [choose](https://github.com/theryangeary/choose) 23 | * [fd](https://github.com/sharkdp/fd) 24 | * [rnr](https://github.com/ChuckDaniels87/rnr) 25 | * [huniq](https://github.com/koraa/huniq) 26 | * [bat](https://github.com/sharkdp/bat) — for options like `-A`, `-n`, etc 27 | * [jql](https://github.com/yamafaktory/jql) 28 | * [xsv](https://github.com/BurntSushi/xsv) 29 | * [zet](https://github.com/yarrow/zet) 30 | * [htmlq](https://github.com/mgdm/htmlq) 31 | * [rq](https://github.com/dflemstr/rq) 32 | * Et cetera 33 | 34 | :information_source: [Rust coreutils](https://github.com/uutils/coreutils) won't be covered here. See also [Awesome Alternatives in Rust](https://github.com/TaKO8Ki/awesome-alternatives-in-rust). 35 | 36 |
37 | 38 | ## Feedback and Contributing 39 | 40 | Please open an [issue](https://github.com/learnbyexample/cli_text_processing_rust/issues) if you spot any typo/errors. 41 | 42 | **Please do not submit pull requests.** 43 | 44 | I'd also highly appreciate your feedback about the book. 45 | 46 | Twitter: https://twitter.com/learn_byexample 47 | 48 |
49 | 50 | ## Acknowledgements 51 | 52 | * [/r/commandline/](https://www.reddit.com/r/commandline) and [/r/rust/](https://www.reddit.com/r/rust/) — helpful forums 53 | * [stackoverflow](https://stackoverflow.com/) and [unix.stackexchange](https://unix.stackexchange.com/) — for getting answers on pertinent questions related to command line 54 | * [Warning](https://commons.wikimedia.org/wiki/File:Warning_icon.svg) and [Info](https://commons.wikimedia.org/wiki/File:Info_icon_002.svg) icons by [Amada44](https://commons.wikimedia.org/wiki/User:Amada44) under public domain 55 | * [Inkscape](https://inkscape.org/) for favicon 56 | * [pngquant](https://pngquant.org/) and [svgcleaner](https://github.com/RazrFalcon/svgcleaner) for optimizing images 57 | * [softwareengineering.stackexchange](https://softwareengineering.stackexchange.com/questions/39/whats-your-favourite-quote-about-programming) and [skolakoda](https://skolakoda.org/programming-quotes) for programming quotes 58 | * [mdBook](https://github.com/rust-lang/mdBook) — for web version of the book 59 | * [mdBook-pagetoc](https://github.com/JorelAli/mdBook-pagetoc) — for adding table of contents for each page 60 | * [minify-html](https://github.com/wilsonzlin/minify-html) — for minifying html files 61 | 62 |
63 | 64 | ## License 65 | 66 | This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/) 67 | 68 | Code snippets are available under [MIT License](https://github.com/learnbyexample/cli_text_processing_rust/blob/main/LICENSE) 69 | 70 | --------------------------------------------------------------------------------