lemmeknow
⚡ 🦀 🔍
Just ask "lemmeknow"!
The fastest way to identify anything
`lemmeknow` can be used for identifying mysterious text or to analyze hard-coded strings from captured network packets, malwares, or just about anything.
## 🧰 Usage
```shell
lemmeknow [OPTIONS]
```
JSON Output
If you want output in JSON format, then pass `-j / --json` flag.
*e.g.*
```shell
lemmeknow UC11L3JDgDQMyH8iolKkVZ4w --json
```
> 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](https://github.com/swanandx/lemmeknow/releases/).
---
### Using `cargo` 🦀
```shell
cargo install lemmeknow
```
---
### Using [Nix](https://nixos.org/nix) ❄️
```shell
nix-env -iA nixpkgs.lemmeknow
```
---
### Build it from source 🎯
Clone repository
```shell
git clone https://github.com/swanandx/lemmeknow && cd lemmeknow
```
then build and run
```shell
cargo run -- [OPTIONS]
```
OR
```shell
cargo build --release
cd target/release/
./lemmeknow [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`
```toml
[dependencies]
lemmeknow = { version = "0.7", default-features = false }
```
OR
```toml
[dependencies]
lemmeknow = { git = "https://github.com/swanandx/lemmeknow", default-features = false }
```
> Refer to [documentation](https://docs.rs/lemmeknow) for more info.
lemmeknow supports webassembly, that is, it can be compiled for `wasm32-unknown-unknown` target!
e.g. [lemmeknow-frontend](https://github.com/swanandx/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.7MB | A single string |
| --- | --- |
| *Summary*: `lemmeknow.exe floss.exe` ran **33.13 ± 9.74** times faster than `pywhat floss.exe` | *Summary*: `lemmeknow.exe 3FZ..Zc5` ran **3.29 ± 0.77** times faster than `pywhat 3FZ..Zc5` |
|  |  |
> Thanks to [SkeletalDemise](https://github.com/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](https://github.com/bee-san/pyWhat)!
Thanks to developer of it for the awesome idea <3 .
