ronin-rb/ronin-brute

# frozen_string_literal: true
#
# ronin-brute - A micro-framework and tool for bruteforcing credentials.
#
# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
#
# ronin-brute 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-brute 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-brute.  If not, see <https://www.gnu.org/licenses/>.
#

require 'ronin/brute/root'
require 'ronin/core/cli/completion_command'

module Ronin
  module Brute
    class CLI
      module Commands
        #
        # Manages the shell completion rules for `ronin-brute`.
        #
        # ## Usage
        #
        #     ronin-brute completion [options]
        #
        # ## Options
        #
        #         --print                      Prints the shell completion file
        #         --install                    Installs the shell completion file
        #         --uninstall                  Uninstalls the shell completion file
        #     -h, --help                       Print help information
        #
        # ## Examples
        #
        #     ronin-payloads brute --print
        #     ronin-payloads brute --install
        #     ronin-payloads brute --uninstall
        #
        class Completion < Core::CLI::CompletionCommand

          completion_file File.join(ROOT,'data','completions','ronin-brute')

          man_dir File.join(ROOT,'man')
          man_page 'ronin-brute-completion.1'

          description 'Manages the shell completion rules for ronin-brute'

        end
      end
    end
  end
end