Repository files navigation

The Metasploit Framework is an open-source tool released under a BSD-style license. For detailed licensing information, refer to theCOPYING file.

Access the latest version of Metasploit from theNightly Installers page.

Comprehensive documentation, including usage guides, is available atMetasploit Docs.

To set up a development environment, visit theDevelopment Setup Guide.

Submit bugs and feature requests via theGitHub Issues tracker. New submissions can be made through theMSF-BUGv1 form.

For information on writing modules, refer to theAPI Documentation.

For questions and suggestions, you can:

• Join ourGitHub Discussions for community support and general questions
• Join theMetasploit Slack for real-time chat
• SubmitGitHub Issues for bug reports and feature requests
• Follow@metasploit on X or@metasploit@infosec.exchange on Mastodon for updates

Note: Some community members may still use IRC channels and the metasploit-hackers mailing list, though the primary support channels are now GitHub Discussions and Slack.

We recommend installation with theofficial Metasploit installers on Linux or macOS. Metasploit is also pre-installed with Kali.

For a manual setup, consult theDev Environment Setup guide.

To get started with Metasploit:

1. Startmsfconsole: This is the primary interface for interacting with Metasploit.
2. Explore Resources:
   • Visit theUsing Metasploit section of the documentation.

To contribute to Metasploit:

1. Setup Development Environment: Follow the instructions in theDevelopment Setup Guide on GitHub.
2. Clone the Repository: Obtain the source code from the official repository.
3. Submit a Pull Request: After making changes, submit a pull request for review. Additional details can be found in theContributing Guide.