https://github.com/postmodern/ruby-rustscan
A Ruby interface to rustscan, the Modern Port Scanner.
https://github.com/postmodern/ruby-rustscan
command-mapper ruby rustscan
Last synced: 3 months ago
JSON representation
A Ruby interface to rustscan, the Modern Port Scanner.
- Host: GitHub
- URL: https://github.com/postmodern/ruby-rustscan
- Owner: postmodern
- License: mit
- Created: 2022-04-21T01:08:35.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T04:41:50.000Z (over 2 years ago)
- Last Synced: 2024-05-01T22:03:27.774Z (almost 2 years ago)
- Topics: command-mapper, ruby, rustscan
- Language: Ruby
- Homepage:
- Size: 9.77 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ruby-rustscan
[](https://github.com/postmodern/ruby-rustscan/actions/workflows/ruby.yml)
[](https://badge.fury.io/rb/ruby-rustscan)
* [Source](https://github.com/postmodern/ruby-rustscan/)
* [Issues](https://github.com/postmodern/ruby-rustscan/issues)
* [Documentation](http://rubydoc.info/gems/ruby-rustscan/frames)
## Description
A Ruby interface to [rustscan], the Modern Port Scanner.
## Features
* Provides a [Ruby interface][Rustscan::Command] for running the `rustscan`
command.
[Rustscan::Command]: https://rubydoc.info/gems/ruby-rustscan/Rustscan/Command
## Examples
Run `rustscan --addresses 127.0.0.1 -p 80,443` from Ruby:
```ruby
require 'rustscan/command'
Rustscan::Command.run(addresses: ['127.0.0.1'], ports: [80, 443])
```
## Requirements
* [ruby] >= 2.0.0
* [rustscan] >= 2.0.0
* [command_mapper] ~> 0.2, >= 0.2.1
[ruby]: https://www.ruby-lang.org/
[command_mapper]: https://github.com/postmodern/command_mapper.rb#readme
## Install
```shell
$ gem install ruby-rustscan
```
### gemspec
```ruby
gemspec.add_dependency 'ruby-rustscan', '~> 0.1'
```
### Gemfile
```ruby
gem 'ruby-rustscan', '~> 0.1'
```
## License
Copyright (c) 2022 Hal Brodigan
See {file:LICENSE.txt} for license information.
[rustscan]: https://github.com/RustScan/RustScan#readme