ronin 2.0.4 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18a3d5cc32bca9292acddc0c00ed1114bc8c8cd406c014c7053143fc3eea7cce
-  data.tar.gz: 81baac7a55017d8086a3dff34a808910a735547468a98bf8f86b7269ce8ec8f2
+  metadata.gz: 83080c43d17f502c2eeffc66cba98644fe2c6d3f8a33cd5230f64c66ced7a375
+  data.tar.gz: 25893b73f24ca08634df9ff76dc994e5453d8d98c45f792208cd0826fc9d8c49
 SHA512:
-  metadata.gz: 5066a3912ddb0da16d305ba983f8a346196a50496e2ebb95bb5a3550b7cb03d868550550aab3c27a4b13ae399af452cf923bf54ab2d1faf44279de6736ecac30
-  data.tar.gz: 92cbf11e7b07149825cf1e97ed5fd153ae2e77ea1f1fc4092120b1a57b2beea7e79648d7eea111abd8a467db2c8968ad4d808643b5594e6529c9e6ddbbb700c7
+  metadata.gz: b8032e44bf301b21b5937581b3df2a910469e6697ec6f61c7867e6b8499c55afbdf4766465d1858df5d09ba011b4a4f61313ca9d0d8e2ab16578de497e77862f
+  data.tar.gz: adec05b8a2355ef4eac10e735705fd24f4e123e67d4bbcf90b384126a8820482d07f337b35a6e433335177f73e21ba979b0398d8a5c3f81d7a6cb6e375f3eeb8

data/.github/workflows/ruby.yml

@@ -9,14 +9,14 @@ jobs:
       fail-fast: false
       matrix:
         ruby:
-          - '3.0'
           - '3.1'
           - '3.2'
+          - '3.3'
           # - jruby
           - truffleruby
     name: Ruby ${{ matrix.ruby }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -35,7 +35,7 @@ jobs:
   rubocop:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:

data/.gitignore

@@ -1,4 +1,5 @@
 /coverage
+/data/completions/ronin
 /doc
 /pkg
 /man/*.[1-9]

data/.rubocop.yml

@@ -15,7 +15,11 @@ Layout/ExtraSpacing:
   Exclude:
     - 'Gemfile'
 
+Layout/HeredocIndentation:
+  Exclude:
+    - 'lib/ronin/cli/commands/pack.rb'
+
 # no need to add `frozen_string_literal: true` to new scripts/projects
 Style/FrozenStringLiteralComment:
   Exclude:
-    - 'data/new/**/*'
+    - 'data/templates/**/*'

data/ChangeLog.md

@@ -1,3 +1,61 @@
+### 2.1.0 / 2024-XX-XX
+
+* Require [Ruby] >- 3.1.0.
+* Require [wordlist] ~> 1.1.
+* Require [ronin-core] ~> 0.2.
+* Require [ronin-dns-proxy] ~> 0.1.
+* Require [ronin-listener] ~> 0.1.
+* Require [ronin-masscan] ~> 0.1.
+* Require [ronin-nmap] ~> 0.1.
+* Require [ronin-recon] ~> 0.1.
+* Require [ronin-support] ~> 1.1.
+* Require [ronin-vulns] ~> 0.2.
+* Require [ronin-web] ~> 2.0.
+* Require [ronin-wordlists] ~> 0.2.
+* Removed unused `Ronin::Config` module.
+
+#### CLI
+
+* Added the `ronin archive` command.
+* Added the `ronin unarchive` command.
+* Added the `ronin bitsquat` command.
+* Added the `ronin completion` command to install shell completion files
+  for all `ronin` and `ronin-*` commands for Bash and Zsh shells.
+* Added the `ronin dns-proxy` command.
+* Added the `ronin new dns-proxy` command.
+* Added the `ronin pack` command.
+* Added the `ronin unpack` command.
+* Added the `--hex-octet`, `--octal-octet`, and `--ipv6-compat` options to the
+  `ronin ip` command.
+* Added more accepted values to the `ronin http --user-agent` option.
+* Added the `--cookie` and `--cookie-param` options to the `ronin http` command.
+* Added the `cookie` and `set-cookie` commands to the `ronin http` shell.
+* Added the `-s,--size` option to the `ronin iprange` command.
+* Added support for `ronin cert-gen --key-type dsa`.
+* All `--help` options and the `ronin irb` command now displays the Ronin logo
+  ASCII art.
+* Alias `ronin tlds` to the `ronin tld-list` command.
+* Alias `ronin public-suffixes` to the `ronin public-suffix-list` command.
+* Alias `ronin new exploit` to the `ronin-exploits new` command.
+* Alias `ronin new payload` to the `ronin-payloads new` command.
+* Alias `ronin new dns-listener` to the `ronin-listener new dns` command.
+* Alias `ronin new http-listener` to the `ronin-listener new http` command.
+* Alias `ronin new web-app` to the `ronin-web new app` command.
+* Alias `ronin new nokogiri` to the `ronin-web new nokogiri` command.
+* Alias `ronin new web-server` to the `ronin-web new server` command.
+* Alias `ronin new web-spider` to the `ronin-web new spider` command.
+
+### 2.0.5 / 2023-09-19
+
+* Require [wordlist] ~> 1.0, >= 1.0.3 for macOS fixes.
+* Require [ronin-support] ~> 1.0, >= 1.0.3.
+
+#### CLI
+
+* Fixed a bug in `ronin cert-gen` that prevented generating a new certificate
+  signed with an EC key (ex: `ronin cert-gen --key-type ec ...`).
+* Fixed the formatting of the `ronin cert-gen` man-page.
+
 ### 2.0.4 / 2023-07-18
 
 * Require [wordlist] ~> 1.0, >= 1.0.2 for bug fixes.
@@ -909,15 +967,21 @@
   * Auto-indentation enabled.
   * Pretty-Print loaded.
 
+[Ruby]: https://www.ruby-lang.org
 [open_namespace]: https://github.com/postmodern/open_namespace#readme
 [rouge]: https://github.com/rouge-ruby/rouge#readme
 [async-io]: https://github.com/socketry/async-io#readme
 [wordlist]: https://github.com/postmodern/wordlist.rb#readme
 
 [ronin-support]: https://github.com/ronin-rb/ronin-support#readme
-[ronin-repos]: https://github.com/ronin-rb/ronin-repos#readme
 [ronin-core]: https://github.com/ronin-rb/ronin-core#readme
+[ronin-repos]: https://github.com/ronin-rb/ronin-repos#readme
 [ronin-db]: https://github.com/ronin-rb/ronin-db#readme
+[ronin-dns-proxy]: https://github.com/ronin-rb/ronin-dns-proxy#readme
+[ronin-wordlists]: https://github.com/ronin-rb/ronin-wordlists#readme
+[ronin-listener]: https://github.com/ronin-rb/ronin-listener#readme
+[ronin-nmap]: https://github.com/ronin-rb/ronin-nmap#readme
+[ronin-masscan]: https://github.com/ronin-rb/ronin-masscan#readme
 [ronin-fuzzer]: https://github.com/ronin-rb/ronin-fuzzer#readme
 [ronin-web]: https://github.com/ronin-rb/ronin-web#readme
 [ronin-code-asm]: https://github.com/ronin-rb/ronin-code-asm#readme
@@ -925,3 +989,5 @@
 [ronin-payloads]: https://github.com/ronin-rb/ronin-payloads#readme
 [ronin-exploits]: https://github.com/ronin-rb/ronin-exploits#readme
 [ronin-vulns]: https://github.com/ronin-rb/ronin-vulns#readme
+[ronin-recon]: https://github.com/ronin-rb/ronin-recon#readme
+[ronin-app]: https://github.com/ronin-rb/ronin-app#readme

data/Gemfile

@@ -6,55 +6,89 @@ gemspec
 
 gem 'jruby-openssl',	'~> 0.7', platforms: :jruby
 
-gem 'net-telnet', '~> 0.1', group: :net
-if RUBY_VERSION >= '3.1.0'
-  gem 'net-ftp',    '~> 0.1', group: :net, platform: :mri
-  gem 'net-smtp',   '~> 0.1', group: :net, platform: :mri
-  gem 'net-pop',    '~> 0.1', group: :net, platform: :mri
-  gem 'net-imap',   '~> 0.1', group: :net, platform: :mri
+group :net do
+  gem 'net-telnet', '~> 0.1'
+
+  platform :mri do
+    if RUBY_VERSION >= '3.1.0'
+      gem 'net-ftp',  '~> 0.1'
+      gem 'net-smtp', '~> 0.1'
+      gem 'net-pop',  '~> 0.1'
+      gem 'net-imap', '~> 0.1'
+    end
+  end
 end
 
-# gem 'command_kit', '~> 0.4', github: 'postmodern/command_kit.rb',
-#                              branch: '0.4.0'
+# gem 'command_kit', '~> 0.5', github: 'postmodern/command_kit.rb',
+#                              branch: 'main'
 
 group :database do
-  gem 'sqlite3', '~> 1.0', platform: :mri
-  gem 'activerecord-jdbcsqlite3-adapter', '~> 70.0.pre', platform: :jruby
+  gem 'sqlite3', '~> 1.0', platforms: [:mri, :truffleruby]
+
+  platform :jruby do
+    gem 'activerecord-jdbcsqlite3-adapter', '~> 70.0'
+    gem 'activerecord', '< 7.1.0'
+  end
 end
 
 # Library dependencies
-# gem 'ronin-support',	       '~> 1.0', github: 'ronin-rb/ronin-support',
-#                                        branch: 'main'
-# gem 'ronin-core',            '~> 0.1', github: 'ronin-rb/ronin-core',
-#                                        branch: 'main'
-# gem 'ronin-repos',           '~> 0.1', github: 'ronin-rb/ronin-repos',
-#                                        branch: 'main'
-# gem 'ronin-db',              '~> 0.1', github: 'ronin-rb/ronin-db',
-#                                        branch: 'main'
-# gem 'ronin-db-activerecord', '~> 0.1', github: 'ronin-rb/ronin-db-activerecord',
-#                                        branch: 'main'
-# gem 'ronin-fuzzer',          '~> 0.1', github: 'ronin-rb/ronin-fuzzer',
-#                                        branch: 'main'
+# gem 'ronin-support',           '~> 1.1', github: "ronin-rb/ronin-support",
+#                                          branch: 'main'
+# gem 'ronin-core',              '~> 0.2', github: 'ronin-rb/ronin-core',
+#                                          branch: 'main'
+# gem 'ronin-repos',             '~> 0.1', github: 'ronin-rb/ronin-repos',
+#                                          branch: 'main'
+# gem 'ronin-db-activerecord',    '~> 0.2', github: "ronin-rb/ronin-db-activerecord",
+#                                           branch: 'main'
+# gem 'ronin-db',                 '~> 0.2', github: "ronin-rb/ronin-db",
+#                                           branch: 'main'
+# gem 'ronin-listener-dns',       '~> 0.1', github: "ronin-rb/ronin-listener-dns",
+#                                           branch: 'main'
+# gem 'ronin-listener-http',      '~> 0.1', github: "ronin-rb/ronin-listener-http",
+#                                           branch: 'main'
+# gem 'ronin-listener',           '~> 0.1', github: "ronin-rb/ronin-listener",
+#                                           branch: 'main'
+# gem 'ronin-fuzzer',             '~> 0.2', github: 'ronin-rb/ronin-fuzzer',
+#                                           branch: '0.2.0'
 # gem 'ronin-post_ex',         '~> 0.1', github: 'ronin-rb/ronin-post_ex',
 #                                        branch: 'main'
 # gem 'ronin-code-asm',        '~> 1.0', github: 'ronin-rb/ronin-code-asm',
 #                                        branch: 'main'
 # gem 'ronin-code-sql',        '~> 2.0', github: 'ronin-rb/ronin-code-sql',
 #                                        branch: 'main'
-# gem 'ronin-payloads',        '~> 0.1', github: 'ronin-rb/ronin-payloads',
+# gem 'ronin-payloads',        '~> 0.2', github: 'ronin-rb/ronin-payloads',
 #                                        branch: 'main'
-# gem 'ronin-exploits',        '~> 1.0', github: 'ronin-rb/ronin-exploits',
+# gem 'ronin-exploits',        '~> 1.1', github: 'ronin-rb/ronin-exploits',
 #                                        branch: 'main'
-# gem 'ronin-vulns',           '~> 0.1', github: 'ronin-rb/ronin-vulns',
+# gem 'ronin-vulns',           '~> 0.2', github: 'ronin-rb/ronin-vulns',
 #                                        branch: 'main'
 # gem 'ronin-web-server',      '~> 0.1', github: 'ronin-rb/ronin-web-server',
 #                                        branch: 'main'
-# gem 'ronin-web-spider',      '~> 0.1', github: 'ronin-rb/ronin-web-spider',
+# gem 'ronin-web-spider',      '~> 0.2', github: 'ronin-rb/ronin-web-spider',
 #                                        branch: 'main'
 # gem 'ronin-web-user_agents', '~> 0.1', github: 'ronin-rb/ronin-web-user_agents',
 #                                        branch: 'main'
-# gem 'ronin-web',             '~> 1.0', github: 'ronin-rb/ronin-web',
-#                                        branch: 'main'
+# gem 'ronin-support-web',        '~> 0.1', github: 'ronin-rb/ronin-support-web',
+#                                           branch: 'main'
+# gem 'ronin-web-browser',        '~> 0.1', github: 'ronin-rb/ronin-web-browser',
+#                                           branch: 'main'
+# gem 'ronin-web-session_cookie', '~> 0.1', github: 'ronin-rb/ronin-web-session_cookie',
+#                                           branch: 'main'
+# gem 'ronin-web',                '~> 2.0', github: 'ronin-rb/ronin-web',
+#                                           branch: 'main'
+
+# gem 'ronin-dns-proxy', '~> 0.1', github: 'ronin-rb/ronin-dns-proxy',
+#                                  branch: 'main'
+# gem 'ronin-nmap',      '~> 0.1', github: 'ronin-rb/ronin-nmap',
+#                                  branch: 'main'
+# gem 'ronin-masscan',   '~> 0.1', github: 'ronin-rb/ronin-masscan',
+#                                  branch: 'main'
+# gem 'ronin-wordlists', '~> 0.1', github: 'ronin-rb/ronin-wordlists',
+#                                  branch: 'main'
+# gem 'ronin-recon',     '~> 0.1', github: 'ronin-rb/ronin-recon',
+#                                  branch: 'main'
+# gem 'ronin-app',       '~> 0.1', github: 'ronin-rb/ronin-app',
+#                                  branch: 'main'
 
 group :development do
   gem 'rake'
@@ -63,7 +97,7 @@ group :development do
   gem 'simplecov',       '~> 0.20'
 
   gem 'kramdown',        '~> 2.0'
-  gem 'kramdown-man',    '~> 0.1'
+  gem 'kramdown-man',    '~> 1.0'
 
   gem 'redcarpet',       platform: :mri
   gem 'yard',            '~> 0.9'
@@ -74,4 +108,7 @@ group :development do
   gem 'stackprof',       require: false, platform: :mri
   gem 'rubocop',         require: false, platform: :mri
   gem 'rubocop-ronin',   require: false, platform: :mri
+  gem 'pry',             require: false
+
+  gem 'command_kit-completion', '~> 0.1', require: false
 end

data/README.md

@@ -9,7 +9,6 @@
 * [Issues](https://github.com/ronin-rb/ronin/issues)
 * [Documentation](https://ronin-rb.dev/docs/ronin/frames)
 * [Discord](https://discord.gg/6WAb3PsVX9) |
-  [Twitter](https://twitter.com/ronin_rb) |
   [Mastodon](https://infosec.exchange/@ronin_rb)
 
 ## Description
@@ -25,7 +24,8 @@ HTTP, [scanning for web vulnerabilities][ronin-vulns-synopsis],
 [payloads][ronin-payloads], [run exploits][ronin-exploits-synopsis],
 [write new exploits][ronin-exploits-examples],
 [managing local databases][ronin-db-synopsis],
-[fuzzing data][ronin-fuzzer], and much more.
+[fuzzing data][ronin-fuzzer],
+[perform recon][ronin-recon-synopsis], and much more.
 
 ### Who is Ronin for?
 
@@ -42,6 +42,7 @@ HTTP, [scanning for web vulnerabilities][ronin-vulns-synopsis],
 * A fully-loaded Ruby REPL.
 * An ecosystem of high-quality security related Ruby libraries, APIs, and
   commands.
+* A lightweight local web UI.
 
 ### What can you do with Ronin?
 
@@ -53,9 +54,11 @@ HTTP, [scanning for web vulnerabilities][ronin-vulns-synopsis],
   using [ronin-repos].
 * Import and query data using the [ronin-db] database.
 * Fuzz data using [ronin-fuzzer].
+* Perform recon using [ronin-recon].
 * Use common payloads or write your own using [ronin-payloads].
 * Write/run exploits using [ronin-exploits].
 * Scan for web vulnerabilities using [ronin-vulns].
+* Performs scans and browse the database in your browser using [ronin-app].
 
 ## Synopsis
 
@@ -70,15 +73,18 @@ Arguments:
     [ARGS ...]                       Additional arguments for the command
 
 Commands:
+    archive
     asn
     banner-grab
     bitflip
     cert-dump
     cert-gen
     cert-grab
+    completion
     decode, dec
     decrypt
     dns
+    dns-proxy
     email-addr
     encode, enc
     encrypt
@@ -99,6 +105,7 @@ Commands:
     md5
     netcat, nc
     new
+    pack
     proxy
     public-suffix-list
     quote
@@ -111,20 +118,27 @@ Commands:
     tips
     typo
     typosquat
+    unarchive
     unescape
     unhexdump
+    unpack
     unquote
     url
     xor
 
 Additional Ronin Commands:
     $ ronin-repos
+    $ ronin-wordlists
     $ ronin-db
     $ ronin-web
     $ ronin-fuzzer
+    $ ronin-masscan
+    $ ronin-nmap
+    $ ronin-recon
     $ ronin-payloads
     $ ronin-exploits
     $ ronin-vulns
+    $ ronin-app
 ```
 
 List ronin commands:
@@ -147,20 +161,35 @@ $ ronin tips
 
 Open the Ronin Ruby REPL:
 
-```shell
-$ ronin irb
 ```
+$ ronin irb
+                                                                   , Jµ     ▓▓█▓
+                                                  J▌      ▐▓██▌ ████ ██    ▐███D
+                                      ╓▄▓▓█████▌  ██µ     ████ ▄███ÖJ██▌   ███▌
+        ,╓µ▄▄▄▄▄▄▄▄µ;,            ,▄▓██████████  ▐███    ▐███▀ ███▌ ████µ ▄███
+¬∞MÆ▓███████████████████████▓M  ▄██████▀▀╙████▌  ████▌   ████ ▄███ J█████ ███▌
+           `█████▀▀▀▀▀███████  -████▀└    ████  ▐█████n ▄███O ███▌ ██████████
+           ▓████L       ████▀  ▓████     ▓███Ö  ███████ ███▌ ▓███ ▐█████████▀
+          ▄████▀  ,╓▄▄▄█████  J████Ü    ,███▌  ▄███████████ J███▀ ████ █████
+         J█████████████████─  ████▌     ████   ████`██████▌ ████ ▐███Ü ▐███Ü
+         ███████████▀▀▀╙└    ▐████     J███▌  ▓███▌ ²█████ J███Ü ███▌   ▀█▌
+        ▓██████████▌         ████▌     ████  ;████   ▀███▀ ███▌ J▀▀▀-    █
+       ▄█████▀ ▀█████µ      ▐████  ,▄▓████▀  ████▀    ███ J███           `
+      J█████-    ╙▀███▄     ████████████▀╙  J█▀▀▀      █U  ▀█▌
+      ████▀         ▀███   ▄████████▀▀                 ╨    █
+     ▓██▀             ²▀█▄ █▀▀▀╙└
+    ▄██╜                 ╙W
+   J█▀
+   ▌└
+  ┘
 
-Generate a new Ruby script with [ronin-support] preloaded:
-
-```shell
-$ ronin new script foo.rb
+irb(ronin)>
 ```
 
-Generate a new Ruby project with a `Gemfile`:
+Starts and opens the interactive Web UI for Ronin:
 
-```shell
-$ ronin new project foo
+```
+$ ronin-app
 ```
 
 ### Binary
@@ -781,9 +810,106 @@ Print the HTTP status of every URL in a file:
 $ ronin url --file urls.txt --status
 ```
 
+### Generators
+
+Generate a new Ruby script with [ronin-support] preloaded:
+
+```shell
+$ ronin new script foo.rb
+```
+
+Generate a new Ruby project with a `Gemfile`:
+
+```shell
+$ ronin new project foo
+```
+
+Generate a new [nokogiri] Ruby script for parsing HTML/XML:
+
+[nokogiri]: https://nokogiri.org/
+
+```shell
+$ ronin new nokogiri foo.rb
+```
+
+Generate a new [ronin-web-server] Ruby script:
+
+```shell
+$ ronin new web-server my_server.rb
+```
+
+Generate a new [ronin-web-server] based web app:
+
+```shell
+$ ronin new web-app my_app
+```
+
+Generate a new [ronin-web-spider] Ruby script:
+
+```shell
+$ ronin new web-spider --host=example.com my_spider.rb
+```
+
+Generate a [ronin-listener-dns] script:
+
+```shell
+$ ronin new dns-listener my_dns_listener.rb
+```
+
+Generate a [ronin-dns-proxy] script:
+
+```shell
+$ ronin new dns-proxy my_dns_proxy.rb
+```
+
+Generate a [ronin-listener-http] script:
+
+```shell
+$ ronin new http-listener my_http_listener.rb
+```
+
+Generate a [ronin-exploits] script:
+
+```shell
+$ ronin new exploit my_exploit.rb
+```
+
+Generate a [ronin-payloads] script:
+
+```shell
+$ ronin new payload my_payload.rb
+```
+
+### Archive
+
+Archive files:
+
+```shell
+$ ronin archive -o archive.zip file1.txt file2.txt
+```
+
+Archive files using tar format:
+
+```shell
+$ ronin archive -o archive.tar file1.txt file2.txt
+```
+
+Unarchive files:
+
+```shell
+$ ronin unarchive arch1.tar arch2.zip
+```
+
+Unarchive a file with explicit format:
+
+```shell
+$ ronin unarchive -f zip arch2.jar
+```
+
 ### See Also
 
 * [ronin-repos](https://github.com/ronin-rb/ronin-repos#synopsis)
+* [ronin-wordlists](https://github.com/ronin-rb/ronin-wordlists#synopsis)
 * [ronin-db](https://github.com/ronin-rb/ronin-db#synopsis)
 * [ronin-web](https://github.com/ronin-rb/ronin-web#synopsis)
 * [ronin-fuzzer](https://github.com/ronin-rb/ronin-fuzzer#synopsis)
@@ -797,22 +923,29 @@ $ ronin url --file urls.txt --status
 * [make]
 * [git]
 * [libsqlite3]
-* [Ruby] >= 3.0.0
+* [Ruby] >= 3.1.0
 * [open_namespace] ~> 0.4
 * [rouge] ~> 3.0
 * [async-io] ~> 1.0
-* [wordlist] ~> 1.0, >= 1.0.2
-* [ronin-support] ~> 1.0
-* [ronin-core] ~> 0.1, >= 0.1.2
+* [wordlist] ~> 1.1
+* [ronin-support] ~> 1.1
+* [ronin-dns-proxy] ~> 0.1
+* [ronin-core] ~> 0.2
 * [ronin-repos] ~> 0.1
+* [ronin-wordlists] ~> 0.1
 * [ronin-db] ~> 0.1
+* [ronin-listener] ~> 0.1
+* [ronin-nmap] ~> 0.1
+* [ronin-masscan] ~> 0.1
+* [ronin-recon] ~> 0.1
 * [ronin-fuzzer] ~> 0.1
-* [ronin-web] ~> 1.0
+* [ronin-web] ~> 2.0
 * [ronin-code-asm] ~> 1.0
 * [ronin-code-sql] ~> 2.0
 * [ronin-payloads] ~> 0.1
 * [ronin-exploits] ~> 1.0
-* [ronin-vulns] ~> 0.1
+* [ronin-vulns] ~> 0.2
+* [ronin-app] ~> 0.1
 
 ## Install
 
@@ -824,9 +957,10 @@ curl -o ronin-install.sh https://raw.githubusercontent.com/ronin-rb/scripts/main
 
 ### Manually
 
-```shell
-$ gem install ronin
-```
+See the [manual install][manual-instructions] instructions for how to install
+Ronin and it's additional dependencies on your platform.
+
+[manual-instructions]: https://ronin-rb.dev/install/#manual-instructions
 
 ### Docker
 
@@ -851,7 +985,7 @@ docker run --mount type=bind,source="$HOME",target=/home/ronin -it ronin
 1. [Fork It!](https://github.com/ronin-rb/ronin/fork)
 2. Clone It!
 3. `cd ronin`
-4. `bundle install`
+4. `./scripts/setup`
 5. `git checkout -b my_feature`
 6. Code It!
 7. `bundle exec rake spec`
@@ -889,11 +1023,21 @@ along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
 [wordlist]: https://github.com/postmodern/wordlist.rb#readme
 
 [ronin-support]: https://github.com/ronin-rb/ronin-support#readme
+[ronin-dns-proxy]: https://github.com/ronin-rb/ronin-dns-proxy#readme
 [ronin-repos]: https://github.com/ronin-rb/ronin-repos#readme
 [ronin-repos-synopsis]: https://github.com/ronin-rb/ronin-repos#synopsis
+[ronin-wordlists]: https://github.com/ronin-rb/ronin-wordlists#readme
+[ronin-wordlists-synopsis]: https://github.com/ronin-rb/ronin-wordlists#synopsis
 [ronin-core]: https://github.com/ronin-rb/ronin-core#readme
 [ronin-db]: https://github.com/ronin-rb/ronin-db#readme
 [ronin-db-synopsis]: https://github.com/ronin-rb/ronin-db#synopsis
+[ronin-listener]: https://github.com/ronin-rb/ronin-listener#readme
+[ronin-listener-dns]: https://github.com/ronin-rb/ronin-listener-dns#readme
+[ronin-listener-http]: https://github.com/ronin-rb/ronin-listener-http#readme
+[ronin-nmap]: https://github.com/ronin-rb/ronin-nmap#readme
+[ronin-masscan]: https://github.com/ronin-rb/ronin-masscan#readme
+[ronin-recon]: https://github.com/ronin-rb/ronin-recon#readme
+[ronin-recon-synopsis]: https://github.com/ronin-rb/ronin-recon#synopsis
 [ronin-fuzzer]: https://github.com/ronin-rb/ronin-fuzzer#readme
 [ronin-web]: https://github.com/ronin-rb/ronin-web#readme
 [ronin-web-server]: https://github.com/ronin-rb/ronin-web-server#readme
@@ -907,3 +1051,4 @@ along with Ronin.  If not, see <https://www.gnu.org/licenses/>.
 [ronin-exploits-examples]: https://github.com/ronin-rb/ronin-exploits#examples
 [ronin-vulns]: https://github.com/ronin-rb/ronin-vulns#readme
 [ronin-vulns-synopsis]: https://github.com/ronin-rb/ronin-vulns#synopsis
+[ronin-app]: https://github.com/ronin-rb/ronin-app#readme

data/Rakefile

@@ -41,3 +41,12 @@ task :docs => [:yard]
 
 require 'kramdown/man/task'
 Kramdown::Man::Task.new
+
+require 'command_kit/completion/task'
+CommandKit::Completion::Task.new(
+  class_file:  'ronin/cli',
+  class_name:  'Ronin::CLI',
+  output_file: 'data/completions/ronin'
+)
+
+task :setup => %w[man command_kit:completion]