metasploit-framework/documentation
Brendan Watters 9ea0b8f944
Land #6934, Adds exploit for op5 configuration command execution
2016-06-16 14:36:10 -05:00
..
modules Land #6934, Adds exploit for op5 configuration command execution 2016-06-16 14:36:10 -05:00
README.md
developers_guide.pdf

README.md

Metasploit Developer Documentation

*(last updated December 1, 2014)

Metasploit is actively supported by a community of hundreds of contributors and thousands of users world-wide. As a result, the accompanying documentation moves quite quickly.

The best source of documentation on Metasploit development is https://github.com/rapid7/metasploit-framework/wiki. There are many treasures there, such as:

...and many, many more.

API Documentation

If you are looking for API documentation, you may run rake yard to generate a navigatable view of the comment documentation used throughout Metasploit, or visit https://rapid7.github.io/metasploit-framework/api for a recently generated online version.

Contributing

If you would like to contribute to the documentation effort, please see http://yardoc.org/ for details on how to write YARD-compatible comments, and send us a Pull Request with your contribution.