README.md

November 19, 2022 ยท View on GitHub

lemmeknow

โšก ๐Ÿฆ€ ๐Ÿ”
Just ask "lemmeknow"!
The fastest way to identify anything

@_swanandx GitHub issues GitHub stars GitHub forks GitHub license
Built with โค๏ธŽ by swanandx and contributors

lemmeknow can be used for identifying mysterious text or to analyze hard-coded strings from captured network packets, malwares, or just about anything.

Try it online here

Watch the video on YouTube

๐Ÿงฐ Usage

lemmeknow [OPTIONS] <TEXT/FILENAME>
demo
JSON Output

If you want output in JSON format, then pass -j / --json flag. e.g.

lemmeknow UC11L3JDgDQMyH8iolKkVZ4w --json
demo

Run lemmeknow --help for all options!


๐Ÿ”ญ Installation


Download executable ๐Ÿ“ˆ

You can directly download executable and run it. No need for any installation.

Check releases here.


Using cargo ๐Ÿฆ€

cargo install lemmeknow

Using Nix โ„๏ธ

nix-env -iA nixpkgs.lemmeknow

Build it from source ๐ŸŽฏ

Clone repository

git clone https://github.com/swanandx/lemmeknow && cd lemmeknow

then build and run

cargo run -- <TEXT/FILENAME> [OPTIONS]

OR

cargo build --release
cd target/release/
./lemmeknow <TEXT/FILENAME> [OPTIONS]


๐Ÿš€ API

Want to use this as a crate in your project? or make a web api for it? No worries! Just add a entry in your Cargo.toml

[dependencies]
lemmeknow = { version = "0.7", default-features = false }

OR

[dependencies]
lemmeknow = { git = "https://github.com/swanandx/lemmeknow", default-features = false }

Refer to documentation for more info.

lemmeknow supports webassembly, that is, it can be compiled for wasm32-unknown-unknown target! e.g. lemmeknow-frontend


โš”๏ธ Benchmarks

lemmeknow is around 33x faster than pywhat for a file of 8.7MB, and it is 3x faster for a single string!

A file of 8.7MBA single string
Summary: lemmeknow.exe floss.exe ran 33.13 ยฑ 9.74 times faster than pywhat floss.exeSummary: lemmeknow.exe 3FZ..Zc5 ran 3.29 ยฑ 0.77 times faster than pywhat 3FZ..Zc5
File benchmarkString benchmark

Thanks to SkeletalDemise for the benchmarks and the whisker plots โœจ


๐Ÿšง Contributing

You can contribute by adding new regex, improving current regex, improving code performance or fixing minor bugs! Just open a issue or submit a PR.


๐Ÿ’– Acknowledgement

This project is inspired by PyWhat! Thanks to developer of it for the awesome idea <3 .