Mirror of metasploit
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Brendan Coles 163c66b5ba Update tested versions 7 months ago
..
api/v1 Land #10675, DB manager for payloads: Resolve conflicts, add 'create!' to trigger database write 9 months ago
cli Typo fix 9 months ago
modules Update tested versions 7 months ago
README.md Squashed commit of the following: 5 years ago
developers_guide.pdf remove svn:executable from various files 9 years ago

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.