1
0
mirror of https://github.com/calebstewart/pwncat.git synced 2024-11-28 11:24:14 +01:00
pwncat/docs/source/commands/load.rst
Caleb Stewart bcb1f77606 Updated documentation
- Added some last touches to module system.
- Modified connect syntax to allow more flexible parameters
- Still need to update enumeration API docs and connect command docs
2020-10-02 22:28:47 -04:00

30 lines
1.0 KiB
ReStructuredText

Load
====
This command allows you to load custom ``pwncat`` modules from a python package.
The only parameter is the local path to a directory containing python packages
to load as modules.
``pwncat`` will load all modules under that package and search for classes named
``Module`` implementing the ``BaseModule`` base class. These modules will be named
based on the python package name relative to the specified directory. For example,
if you had a directory called ``.pwncat-modules`` with this structure::
- .pwncat-modules/
- enumerate/
- __init__.py
- custom.py
- __init__.py
And a class named ``Module`` defined in ```custom.py`` then a new ``pwncat`` module
would be available under the name ``enumerate.custom``.
This command can be used in your configuration script to automatically load custom
modules at runtime.
.. code-block:: bash
# Load modules from /home/user/.pwncat-modules
(local) pwncat$ load /home/user/.pwncat-modules
(local) pwncat$ run enumerate.custom