README.md

   1 # hotformathCLI
   2 This is a CLI version of the [HOTFORMATH](https://hotformath.com) project.
   3
   4 This tool is a google advanced index search helper, mainly intended at helping people find archives of videos, pictures, documents,
   5 zips, or executables by scrapping google and using it advance search futures.
   6
   7 _this project does not intend to be a piracy tool, this is a tool that i maintain and use personally for research and as a medium_
   8 _to get content that can be used under the fair use act_
   9
  10 # Install
  11 For instalation you just need to download and run the most recent release directly form github releases tab.
  12 ## Compile from source
  13 `go build hotformathCLI.go` should be enough
  14
  15 # How does this work?
  16 This project uses [rocketlaunchr's google-search module](github.com/rocketlaunchr/google-search) to search google for a term introduced by the user and then scraps the first 3 results
  17 the query sent to google shoul look a little something like `intext:"[YOUR SEARCH TERM]" -inurl:(jsp|pl|php|html|aspx|htm|cf|shtml) -inurl:(index_of|listen77|mp3raid|mp3toss|mp3drug|index_of|wallywashis) intitle:"index.of./" [specific modifier]`
  18 where the specific modifier depends on the flag you use
  19
  20 | Type             | Flag | Modifier                                                     |
  21 | ---------------- | ---- | ------------------------------------------------------------ |
  22 | Videos           | -v   | `(avi\|mkv\|mov\|mp4\|mpg\|wmv)`                             |
  23 | Audios           | -a   | `(ac3\|flac\|m4a\|mp3\|ogg\|wav\|wma)`                       |
  24 | Ebooks           | -e   | `(CBZ\|CBR\|CHM\|DOC\|DOCX\|EPUB\|MOBI\|ODT\|PDF\|RTF\|txt)` |
  25 | Pictures         | -p   | `(bmp\|gif\|jpg\|png\|psd\|tif\|tiff)`                       |
  26 | Software         | -s   | `(apk\|exe\|iso\|rar\|tar\|zip)`                             |
  27 | Compressed files | -c   | `(7z\|bz2\|gz\|iso\|rar\|zip)`                               |
  28
  29 You can read more about google's advance querying features [here](https://ahrefs.com/blog/google-advanced-search-operators/)
  30
  31 # Roamap
  32 In the future we plan to:
  33   - [x] scrap from google the results
  34   - [ ] integrate with fzf
  35   - [ ] open links into browser or copy to clipboard directly
  36   - [ ] advanced manual search with other flags
  37   - [ ] TUI with https://github.com/charmbracelet/ repos
  38
  39 # Credits
  40 ![HotForMath](./hotformath.png)
  41 [HOTFORMATH ON GITHUB](https://github.com/marcosfermin/hotformath)