RomanNum3ral
/
AutoRecon
mirror of https://github.com/Tib3rius/AutoRecon.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated API Documentation (markdown)

Tib3rius 2022-05-08 21:54:19 -04:00
parent 4b1a4b8859
commit 8fe78179f4
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
API-Documentation.md

@ -173,4 +173,16 @@ The `tags` attribute is a list of tags that apply to the plugin. By default, the
### Methods
#### add_option(name, default=None, help=None)
The `add_option` method sets a command-line option for the plugin to use, where the value set to the option is stored. The `name` argument is used as part of the command-line option. For example, if a plugin called "HTTP" added an option with the `name` "threads", the command-line option would be --http.threads. The `default` argument is optional, but if set, will return if the user does not specify the command-line option. The `help` argument is also optional, but recommended to let users know what the option is to be used for.
The `add_option` method sets a command-line option for the plugin to use, where the value set to the option is stored if the option is used. The `name` argument is used as part of the command-line option. For example, if a plugin called "Foo" added an option with the `name` "bar", the command-line option would be --foo.bar. The `default` argument is optional, but if set, will return if the user does not specify the command-line option. The `help` argument is also optional, but recommended to let users know what the option is to be used for.
#### add_constant_option(name, const, default=None, help=None)
The `add_constant_option` method sets a command-line option for the plugin to use, where the value set to the `const` argument is stored if the option is used. The `name` argument is used as part of the command-line option. For example, if a plugin called "Foo" added an option with the `name` "bar", the command-line option would be --foo.bar. The `default` argument is optional, but if set, will return if the user does not specify the command-line option. The `help` argument is also optional, but recommended to let users know what the option is to be used for.
#### add_true_option(name, help=None)
The `add_true_option` method sets a command-line option for the plugin to use, where the boolean `True` is stored if the option is used. The `name` argument is used as part of the command-line option. For example, if a plugin called "Foo" added an option with the `name` "bar", the command-line option would be --foo.bar. The `help` argument is also optional, but recommended to let users know what the option is to be used for.
#### add_false_option(name, help=None)
The `add_false_option` method sets a command-line option for the plugin to use, where the boolean `False` is stored if the option is used. The `name` argument is used as part of the command-line option. For example, if a plugin called "Foo" added an option with the `name` "bar", the command-line option would be --foo.bar. The `help` argument is also optional, but recommended to let users know what the option is to be used for.
#### add_list_option(name, default=None, help=None)
The `add_list_option` method sets a command-line option for the plugin to use, where multiple space separated values are stored in a list is stored if the option is used. The `name` argument is used as part of the command-line option. For example, if a plugin called "Foo" added an option with the `name` "bar", the command-line option would be --foo.bar. The `help` argument is also optional, but recommended to let users know what the option is to be used for.