# hyper-scan

A multi-threaded port scanner and service detection utility.

## Demo

<a title="Click to view ASCII" href="https://asciinema.org/a/lo2tV34u0qddzYcd2WENUGYoC?autoplay=1">
  <img width=40% src="https://github.com/iTranscend/hyper-scan/raw/master/media/demo.gif" alt="ASCII Demo">
</a>

## Installation

- Install [Rust](https://rustup.rs/) (Installs `cargo`)
- Install hyper-scan via cargo
  ```bash
    cargo install hyper-scan
  ```

## Usage

```bash
hs [-h host] [-s startPort] [-e endPort] [-j threads] [-v verbose] [-t timeout]
```

See full help information with the `--help` flag.

## Examples

- Scan all ports on your localhost `127.0.0.1`:

  ```console
  hs
  ```

- Scan all open ports on `128.2.3.5`:

  ```console
  hs 128.2.3.5
  ```

- Scan all ports on `128.2.3.5` between `200` and `50300`:

  ```console
  hs 128.2.3.5 -s 200 -e 50300
  ```

- Scan all ports on `128.2.3.5` between `200` and `50300` using `8` threads:
  ```console
  hs 128.2.3.5 -s 200 -e 50300 -j 8
  ```

## Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as below, without any additional terms or conditions.

## License

Licensed under either of

- Apache License, Version 2.0
  ([LICENSE-APACHE](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT license
  ([LICENSE-MIT](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)

at your option.