Wrote the tool

This commit is contained in:
2026-05-13 12:03:39 -05:00
parent c9338feca7
commit 3f0f826f6b
2 changed files with 55 additions and 1 deletions
+5
View File
@@ -16,3 +16,8 @@ target/
# and can be added to the global gitignore or merged into this file. For a more nuclear # and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder. # option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/ #.idea/
# Added by cargo
/target
+50 -1
View File
@@ -1,3 +1,52 @@
# ferrisfind # ferrisfind
Find publicly available files given a company name, download them, and extract the metadata out of them. Find publicly available files given a company name, download them, and extract the metadata out of them.
# Usage:
```
ferrisfind [OPTIONS] --name <NAME> --key <KEY>
-n, --name <NAME>
company name
-k, --key <KEY>
serpapi key
-p, --pages <PAGES>
number of pages of results to get (note each page is a credit on your sperapi key, defaults to 10)
-t, --threads <THREADS>
the number of threads to use, will default to the rayon default
-d, --download-path <DOWNLOAD_PATH>
folder to download found files into defaults to ./found_files
-c, --csv <CSV>
save metadata as csv
-m, --markdown <MARKDOWN>
save metadata as csv
-h, --help
Print help (see a summary with '-h')
-V, --version
Print version
```
# Examples:
Find PDFs for google and print metadata to console without saving it to a file:
`ferrisfind -k {serpapi key} -n google`
find PDFs for google and save to a csv file:
`ferrisfind -k {serpapi key} -n google -c ./metadata.csv`
find PDFs for google and save to a markdwon file:
`ferrisfind -k {serpapi key} -n google -m ./metadata.md`
find PDFs for google and save to both a CSV and Markdown file:
`ferrisfind -k {serpapi key} -n google -c ./metadata.csv -m ./metadata.md`