Class: Ronin::CLI::Commands::Completion Private

Inherits:
Core::CLI::CompletionCommand
  • Object
show all
Defined in:
lib/ronin/cli/commands/completion.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Manages the shell completion rule for ronin and all other ronin-* commands.

Usage

ronin 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 completion --print
ronin completion --install
ronin completion --uninstall

Since:

  • 2.1.0

Constant Summary collapse

COMPLETION_FILES =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

All shell completion files for ronin and the other ronin-* commands.

Since:

  • 2.1.0

[
  File.join(ROOT,'data','completions','ronin'),

  Repos::CLI::Commands::Completion.completion_file,
  Wordlists::CLI::Commands::Completion.completion_file,
  DB::CLI::Commands::Completion.completion_file,
  Fuzzer::CLI::Commands::Completion.completion_file,
  Web::CLI::Commands::Completion.completion_file,
  Vulns::CLI::Commands::Completion.completion_file,
  Payloads::CLI::Commands::Completion.completion_file,
  Exploits::CLI::Commands::Completion.completion_file,
  Listener::CLI::Commands::Completion.completion_file,
  Nmap::CLI::Commands::Completion.completion_file,
  Masscan::CLI::Commands::Completion.completion_file,
  Recon::CLI::Commands::Completion.completion_file
]

Instance Method Summary collapse

Instance Method Details

#install_completion_file ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Installs all completion files.

Since:

  • 2.1.0



98
99
100
101
102
 
# File 'lib/ronin/cli/commands/completion.rb', line 98

def install_completion_file
  COMPLETION_FILES.each do |completion_file|
    super(completion_file)
  end
end

#print_completion_file ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Prints all completion files.

Since:

  • 2.1.0



89
90
91
92
93
 
# File 'lib/ronin/cli/commands/completion.rb', line 89

def print_completion_file
  COMPLETION_FILES.each do |completion_file|
    super(completion_file)
  end
end

#uninstall_completion_file ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Uninstall all completion files.

Since:

  • 2.1.0



107
108
109
110
111
 
# File 'lib/ronin/cli/commands/completion.rb', line 107

def uninstall_completion_file
  COMPLETION_FILES.each do |completion_file|
    super(completion_file)
  end
end