what-rs
| Crates.io | what-rs |
| lib.rs | what-rs |
| version | 0.2.3 |
| source | src |
| created_at | 2024-11-05 18:55:35.003715 |
| updated_at | 2024-11-05 18:55:35.003715 |
| description | Identify what something is! A pyWhat reimplementation in Rust. |
| homepage | https://github.com/jannikgohr/What-rs |
| repository | https://github.com/jannikgohr/What-rs |
| max_upload_size | |
| id | 1436915 |
| size | 830,668 |
Jannik Gohr (jannikgohr)
documentation
README
🤔 What is this?
Imagine this: You come across some mysterious text 🧙♂️ 0x52908400098527886E0F7030069857D2E4169EE7 or dQw4w9WgXcQ and you wonder what it is. What do you do?
Well, with what-rs all you have to do is ask what-rs "0x52908400098527886E0F7030069857D2E4169EE7" and what-rs will tell you!
what-rs's job is to identify what something is. Whether it be a file or text! Or even the hex of a file! What about text within files? We have that too! what-rs is recursive, it will identify everything in text and more!
⚠️ The project is under active development and not yet feature complete with pyWhat ⚠️
⚙ Usage
🌌 Other Features
Anytime you have a file, and you want to find structured data in it that's useful, what-rs is for you.
Or if you come across some piece of text, and you don't know what it is, what-rs will tell you.
📁 File & Directory Handling
File Opening You can pass in a file path by what-rs 'this/is/a/file/path'. what-rs is smart enough to figure out it's a file!
What about a whole directory? what-rs can handle that too! It will recursively search for files and output everything you need!
🔍 Filtering your output
Sometimes, you only care about seeing things which are related to AWS. Or bug bounties, or cryptocurrencies!
You can filter output by using what-rs --rarity 0.2:0.8 "thing/to/identify"". Use what-rs --help to get more information.
👽 Sorting, Exporting, and more!
Sorting You can sort the output by using what-rs -k rarity --reverse INPUT.
Use what-rs --help to get more information.
Exporting You can export to json using what-rs --format json and results can be sent directly to a file using what-rs --format json > outport.json.
Borderless mode What-rs has a special mode to match identifiable information within strings.
By default, it is enabled in CLI but can be disabled using what-rs --disable-borderless INPUT or what-rs -d INPUT.
Use what --help for more information.
[!IMPORTANT] Filtering by tags (by using --include etc.) and is not yet fully implemented but will come in the next releases.
💖 Acknowledgement
Big thanks to bee-san and everyone who worked on pyWhat for their amazing work on! Without them this project wouldn't exist.