lib/ronin/nmap/cli/commands/completion.rb
# frozen_string_literal: true
#
# ronin-nmap - A Ruby library for automating nmap and importing nmap scans.
#
# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
#
# ronin-nmap 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-nmap 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-nmap. If not, see <https://www.gnu.org/licenses/>.
#
require 'ronin/core/cli/completion_command'
require_relative '../../root'
module Ronin
module Nmap
class CLI
module Commands
#
# Manages the shell completion rules for `ronin-nmap`.
#
# ## Usage
#
# ronin-nmap 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-nmap completion --print
# ronin-nmap completion --install
# ronin-nmap completion --uninstall
#
class Completion < Core::CLI::CompletionCommand
completion_file File.join(ROOT,'data','completions','ronin-nmap')
man_dir File.join(ROOT,'man')
man_page 'ronin-nmap-completion.1'
description 'Manages the shell completion rules for ronin-nmap'
end
end
end
end
end