Skip to content

Commit

Permalink
Added explanation about plugins
Browse files Browse the repository at this point in the history
Added explanation in readme about the smart usage of adding arguments in a plugins, rather from changing the main file.
  • Loading branch information
danielsagi committed Aug 17, 2018
1 parent 67abe91 commit ec8bb86
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion plugins/README.md
@@ -1,3 +1,14 @@
# Plugins

This folder contains modules that will load before any parsing of arguments by kubehunter's main module
This folder contains modules that will load before any parsing of arguments by kubehunter's main module

An example for using a plugin to add an argument:
```python
# example.py
from __main__ import parser

parser.add_argument('--exampleflag', action="store_true", help="enables active hunting")
```
What we did here was just add a file to the `plugins/` folder, import the parser, and adding an argument.

All plugins in this folder gets imported right after the main arguments are added, and right before they are getting parsed, so you can add an argument that will later be used in your [hunting/discovery module](../src/README.md).

0 comments on commit ec8bb86

Please sign in to comment.