dnrops
/
metasploit-framework
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
metasploit-framework/documentation
History
bcoles de8a6e1445
Move fortra_goanywhere_rce_cve_2023_0669 module documentation to documentation directory 		2023-02-09 23:12:45 +11:00
..
cli Typo fix 2019-03-01 10:43:36 -06:00
modules Move fortra_goanywhere_rce_cve_2023_0669 module documentation to documentation directory 2023-02-09 23:12:45 +11:00
README.md Fix the remaining references to the old wiki site. 2023-02-01 21:25:06 -06:00
developers_guide.pdf Restore the hallowed developer's guide 2014-12-03 16:50:18 -06:00

README.md

Metasploit Developer Documentation

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://docs.metasploit.com/. 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.