Added the ronin-wordlists available command (closes #19).

* Removed the `--available` option.

Author: postmodern

README.md

@@ -39,6 +39,7 @@ Arguments:
     [ARGS ...]                       Additional arguments for the command
 
 Commands:
+    available
     completion
     download
     help
@@ -48,10 +49,10 @@ Commands:
     update, up
 ```
 
-List popular wordlists available for download:
+List popular wordlists available for download or installation:
 
 ```shell
-$ ronin-wordlists list --available
+$ ronin-wordlists available
 [ alexa-top-1000 ]
 
   * URL: https://github.com/urbanadventurer/WhatWeb/blob/master/plugin-development/alexa-top-1000.txt

gemspec.yml

@@ -21,6 +21,7 @@ metadata:
 generated_files:
  - data/completions/ronin-wordlists
  - man/ronin-wordlists.1
+ - man/ronin-wordlists-available.1
  - man/ronin-wordlists-completion.1
  - man/ronin-wordlists-download.1
  - man/ronin-wordlists-list.1

lib/ronin/wordlists/cli/commands/available.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+#
+# ronin-wordlists - A library and tool for managing wordlists.
+#
+# Copyright (c) 2023 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-wordlists is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-wordlists is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-wordlists.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/wordlists/cli/command'
+
+require 'yaml'
+
+module Ronin
+  module Wordlists
+    class CLI
+      module Commands
+        #
+        # Lists wordlists available for download or installation.
+        #
+        # ## Usage
+        #
+        #     ronin-wordlists available [options]
+        #
+        # ## Options
+        #
+        #     -h, --help                       Print help information
+        #
+        class Available < Command
+
+          usage '[options]'
+
+          description 'Lists wordlists available for download or installation'
+
+          man_page 'ronin-wordlists-available.1'
+
+          #
+          # Runs the `ronin-wordlists available` command.
+          #
+          def run
+            wordlists = YAML.load_file(File.join(ROOT,'data','wordlists.yml'))
+
+            wordlists.each do |name,attributes|
+              puts "[ #{name} ]"
+              puts
+              puts "  * URL: #{attributes[:url]}"
+              puts "  * Categories: #{attributes[:categories].join(', ')}"
+              puts "  * Summary: #{attributes[:summary]}"
+              puts
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

lib/ronin/wordlists/cli/commands/list.rb

@@ -22,8 +22,6 @@
 require 'ronin/wordlists/cli/wordlist_dir_option'
 require 'ronin/wordlists'
 
-require 'yaml'
-
 module Ronin
   module Wordlists
     class CLI
@@ -38,7 +36,6 @@ module Commands
         # ## Options
         #
         #     -d, --wordlist-dir DIR           The wordlist directory
-        #     -a, --available                  List all wordlists available for download
         #     -h, --help                       Print help information
         #
         # ## Arguments
@@ -51,9 +48,6 @@ class List < Command
 
           usage '[options] [NAME]'
 
-          option :available, short: '-a',
-                             desc:  'List all wordlists available for download'
-
           argument :name, required: false,
                           usage:    'NAME',
                           desc:     'Optional wordlist name to search for'
@@ -69,38 +63,6 @@ class List < Command
           #   The optional wordlist name.
           #
           def run(name=nil)
-            if options[:available]
-              list_available_wordlists
-            else
-              list_wordlists(name)
-            end
-          end
-
-          #
-          # Lists wordlists available for download.
-          #
-          # @see https://github.com/ronin-rb/ronin-wordlists/blob/main/data/wordlists.yml
-          #
-          def list_available_wordlists
-            wordlists = YAML.load_file(File.join(ROOT,'data','wordlists.yml'))
-
-            wordlists.each do |name,attributes|
-              puts "[ #{name} ]"
-              puts
-              puts "  * URL: #{attributes[:url]}"
-              puts "  * Categories: #{attributes[:categories].join(', ')}"
-              puts "  * Summary: #{attributes[:summary]}"
-              puts
-            end
-          end
-
-          #
-          # Lists downloaded wordlists.
-          #
-          # @param [String, nil] name
-          #   Optional wordlit name to list.
-          #
-          def list_wordlists(name=nil)
             wordlists = if name then wordlist_dir.list(name)
                         else         wordlist_dir.list
                         end

man/ronin-wordlists-available.1.md

@@ -0,0 +1,27 @@
+# ronin-wordlists-available 1 "2023-01-01" Ronin Wordlists "User Manuals"
+
+## NAME
+
+ronin-wordlists-available - Lists the available wordlists
+
+## SYNOPSIS
+
+`ronin-wordlists` `available` [*options*]
+
+## DESCRIPTION
+
+Lists popular wordlists that are available for download or installation,
+by the `ronin-wordlists download` or `ronin-wordlists install` commands.
+
+## OPTIONS
+
+`-h`, `--help`
+: Prints help information.
+
+## AUTHOR
+
+Postmodern <postmodern.mod3@gmail.com>
+
+## SEE ALSO
+
+[ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md)

man/ronin-wordlists-list.1.md

@@ -18,9 +18,6 @@ Lists the downloaded wordlists.
 `-d`, `--wordlist-dir` *DIR*
 : The alternative wordlist directory to search.
 
-`-a`, `--available`
-: Lists built-in wordlists that are available for download.
-
 `-h`, `--help`
 : Prints help information.
 
@@ -44,4 +41,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-[ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md)
+[ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md)

man/ronin-wordlists.1.md

@@ -20,6 +20,9 @@ Command suite that manages wordlists.
 
 ## COMMANDS
 
+`available`
+: Lists wordlists available for download or installation.
+
 `completion`
 : Manages the shell completion rules for `ronin-wordlists`.
 
@@ -58,4 +61,4 @@ Postmodern <postmodern.mod3@gmail.com>
 
 ## SEE ALSO
 
-[ronin-wordlists-completion](ronin-wordlists-completion.1.md) [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md) [ronin-wordlists-purge](ronin-wordlists-purge.1.md)
+[ronin-wordlists-available](ronin-wordlists-available.1.md) [ronin-wordlists-completion](ronin-wordlists-completion.1.md) [ronin-wordlists-download](ronin-wordlists-download.1.md) [ronin-wordlists-list](ronin-wordlists-list.1.md) [ronin-wordlists-remove](ronin-wordlists-remove.1.md) [ronin-wordlists-update](ronin-wordlists-update.1.md) [ronin-wordlists-purge](ronin-wordlists-purge.1.md)

spec/cli/commands/available_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+require 'ronin/wordlists/cli/commands/available'
+require_relative 'man_page_example'
+
+describe Ronin::Wordlists::CLI::Commands::Available do
+  include_examples "man_page"
+end