rapid7 / metasploit-framework

# Metasploit Framework
The Metasploit Framework is an open-source tool released under a BSD-style license. For detailed licensing information, refer to the `COPYING` file.
## Latest Version
Access the latest version of Metasploit from the Nightly Installers page.
## Documentation
Comprehensive documentation, including usage guides, is available at Metasploit Docs.
## Development Environment
To set up a development environment, visit the Development Setup Guide.
## Bug and Feature Requests
Submit bugs and feature requests via the GitHub Issues tracker. New submissions can be made through the MSF-BUGv1 form.
## API Documentation
For information on writing modules, refer to the API Documentation.
## Support and Communication
For questions and suggestions, you can:
- Join our GitHub Discussions for community support and general questions
- Join the Metasploit Slack for real-time chat
- Submit GitHub 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.
## Installing Metasploit
### Recommended Installation
We recommend installation with the official Metasploit installers on Linux or macOS. Metasploit is also pre-installed with Kali.
For a manual setup, consult the Dev Environment Setup guide.
## Using Metasploit
To get started with Metasploit:
1. **Start `msfconsole`:** This is the primary interface for interacting with Metasploit.
2. **Explore Resources:** 
 - Visit the Using Metasploit section of the documentation.
## Contributing
To contribute to Metasploit:
1. **Setup Development Environment:** Follow the instructions in the Development 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 the Contributing Guide.