https://github.com/darkceptor44/superwhich
Cross-platform smart which alternative
https://github.com/darkceptor44/superwhich
alternatives cli rust rust-lang which
Last synced: 4 months ago
JSON representation
Cross-platform smart which alternative
- Host: GitHub
- URL: https://github.com/darkceptor44/superwhich
- Owner: DarkCeptor44
- License: gpl-3.0
- Created: 2024-11-04T16:05:43.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-01-16T03:09:26.000Z (over 1 year ago)
- Last Synced: 2025-04-05T05:35:35.550Z (about 1 year ago)
- Topics: alternatives, cli, rust, rust-lang, which
- Language: Rust
- Homepage: https://crates.io/crates/superwhich
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# superwhich
`superwhich` is a cross-platform CLI tool and library that was initially meant to be a faster drop-in replacement for Windows' `where` command but since it uses [Jaro-Winkler distance](https://en.wikipedia.org/wiki/Jaro%E2%80%93Winkler_distance) to calculate the similarity between the strings it can be called a sort of "smart" which, it can handle some typos and highlights the section of the executables that matches the search pattern.
## Installation
## CLI
- From [crates.io](https://crates.io/crates/superwhich): `cargo install superwhich`
- From [GitHub](https://github.com/DarkCeptor44/superwhich): `cargo install --git https://github.com/DarkCeptor44/superwhich`
- Manually (after cloning the repo locally): `cargo install --path .`
- From [releases](https://github.com/DarkCeptor44/superwhich/releases/latest).
## Library
```bash
cargo add superwhich
```
Or you can add this to your `Cargo.toml` file:
```toml
[dependencies]
superwhich = "^2"
```
## Usage
```sh
$ swhich -h
Cross-platform smart which alternative
Usage: swhich.exe [OPTIONS]
Arguments:
The search pattern
Options:
-c, --color Color of the highlighted text (off or set `NO_COLOR` env var to disable) [default: blue]
-T, --threshold String similarity threshold (0.0 to 1.0) [default: 0.7]
-t, --print-time Print time elapsed
-h, --help Print help
-V, --version Print version
```
## Todo
- Make it faster (currently at `~221ms` on Windows).
- Find a better way to match the pattern to the name when printing the result so it highlights similar strings as well.
## Tests
You can run the tests with `cargo test`.
## Benchmarks
### Library
The library benchmarks can be ran with `cargo bench`.
| Benchmark | Min Mean Max | Outliers |
| --------- | ------------ | -------- |
| `find_executables/fake binaries` | 73.288 µs 73.486 µs 73.725 µs | 4 (4.00%) high mild, 6 (6.00%) high severe |
| `find_executables/real PATH` | 210.48 ms 211.14 ms 211.84 ms | 4 (4.00%) high mild, 1 (1.00%) high severe |
| `highlight_text` | 1.4787 µs 1.4829 µs 1.4872 µs | 2 (2.00%) low mild, 1 (1.00%) high mild, 3 (3.00%) high severe |
### CLI
The CLI was benchmarked using [Hyperfine](https://github.com/sharkdp/hyperfine).
#### Windows
- AMD64, 32GB RAM, Ryzen 7 3800X, Windows 10.
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|:---|---:|---:|---:|---:|
| `where pnpm` | 94.7 ± 1.1 | 93.5 | 98.7 | 1.00 |
| `swhich pnpm` | 221.8 ± 3.5 | 215.7 | 229.2 | 2.34 ± 0.05 |
#### Linux
- ARM64, 1GB RAM, Orange Pi Zero2, Debian 12.
| Command | Mean [ms] | Min [ms] | Max [ms] | Relative |
|:---|---:|---:|---:|---:|
| `which lookfor` | 3.0 ± 0.2 | 2.6 | 4.7 | 1.00 |
| `swhich lookfor` | 17.6 ± 0.3 | 17.0 | 19.8 | 5.93 ± 0.43 |
## License
This project is licensed under the terms of the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.html).