metasploit-framework/features/commands/help.feature

Feature: Help command

  Background:
    Given I run `msfconsole --defer-module-loads -q -x help -x exit`

  Scenario: The 'help' command's output
    Then the output should contain:
      """
      Core Commands
      =============

          Command       Description
          -------       -----------
          ?             Help menu
          banner        Display an awesome metasploit banner
          cd            Change the current working directory
          color         Toggle color
          connect       Communicate with a host
          exit          Exit the console
          get           Gets the value of a context-specific variable
          getg          Gets the value of a global variable
          grep          Grep the output of another command
          help          Help menu
          history       Show command history
          irb           Drop into irb scripting mode
          load          Load a framework plugin
          quit          Exit the console
          route         Route traffic through a session
          save          Saves the active datastores
          sessions      Dump session listings and display information about sessions
          set           Sets a context-specific variable to a value
          setg          Sets a global variable to a value
          sleep         Do nothing for the specified number of seconds
          spool         Write console output into a file as well the screen
          threads       View and manipulate background threads
          unload        Unload a framework plugin
          unset         Unsets one or more context-specific variables
          unsetg        Unsets one or more global variables
          version       Show the framework and console library version numbers


      Module Commands
      ===============

          Command       Description
          -------       -----------
          advanced      Displays advanced options for one or more modules
          back          Move back from the current context
          edit          Edit the current module with the preferred editor
          info          Displays information about one or more modules
          loadpath      Searches for and loads modules from a path
          options       Displays global options or for one or more modules
          popm          Pops the latest module off the stack and makes it active
          previous      Sets the previously loaded module as the current module
          pushm         Pushes the active or list of modules onto the module stack
          reload_all    Reloads all modules from all defined module paths
          search        Searches module names and descriptions
          show          Displays modules of a given type, or all modules
          use           Selects a module by name


      Job Commands
      ============

          Command       Description
          -------       -----------
          handler       Start a payload handler as job
          jobs          Displays and manages jobs
          kill          Kill a job
          rename_job    Rename a job


      Resource Script Commands
      ========================

          Command       Description
          -------       -----------
          makerc        Save commands entered since start to a file
          resource      Run the commands stored in a file


      Database Backend Commands
      =========================

          Command           Description
          -------           -----------
          db_connect        Connect to an existing database
          db_disconnect     Disconnect from the current database instance
          db_export         Export a file containing the contents of the database
          db_import         Import a scan result file (filetype will be auto-detected)
          db_nmap           Executes nmap and records the output automatically
          db_rebuild_cache  Rebuilds the database-stored module cache
          db_status         Show the current database status
          hosts             List all hosts in the database
          loot              List all loot in the database
          notes             List all notes in the database
          services          List all services in the database
          vulns             List all vulnerabilities in the database
          workspace         Switch between database workspaces


    Credentials Backend Commands
    ============================

          Command       Description
          -------       -----------
          creds         List all credentials in the database


      """