Use GNU fmt to format files

ARCHITECTURE.md

@@ -1,16 +1,36 @@
-**maid_api**: This is a Rust-based API project that offers a straightforward way to execute remote commands and retrieve logs from the MaidRunner log system. It serves as a critical component for interfacing with the core application.
-
-**maid_build**: The MaidBuild system plays a pivotal role in the MaidRunner Monorepo. It's responsible for creating builds tailored for Linux, including executable binaries and Snap packages designed for Ubuntu. This system streamlines the distribution and deployment of the software.
-
-**maid_docs**: MaidDocs is the documentation folder, a valuable resource containing images, banners, logos, sample source code, and partial test files. It helps developers and users understand and work with the project more effectively.
-
-**maid_lists**: MaidLists is a cybersecurity repository that includes a wide range of lists, such as exploits, XSS lists, SQL injection data, malware signatures, and simple wordlists. It's an essential resource for security and threat intelligence.
-
-**maid_runner**: The core of the entire project, MaidRunner, consolidates all the modules for cybersecurity and system administration. It has evolved from its predecessors and offers the following modules:
+**maid_api**: This is a Rust-based API project that offers a
+straightforward
+way to execute remote commands and retrieve logs from the MaidRunner log
+system. It serves as a critical component for interfacing with the core
+application.
+
+**maid_build**: The MaidBuild system plays a pivotal role in the
+MaidRunner
+Monorepo. It's responsible for creating builds tailored for Linux,
+including
+executable binaries and Snap packages designed for Ubuntu. This system
+streamlines the distribution and deployment of the software.
+
+**maid_docs**: MaidDocs is the documentation folder, a valuable resource
+containing images, banners, logos, sample source code, and partial test
+files. It helps developers and users understand and work with the project
+more effectively.
+
+**maid_lists**: MaidLists is a cybersecurity repository that includes
+a wide
+range of lists, such as exploits, XSS lists, SQL injection data, malware
+signatures, and simple wordlists. It's an essential resource for security
+and threat intelligence.
+
+**maid_runner**: The core of the entire project, MaidRunner, consolidates
+all the modules for cybersecurity and system administration. It has
+evolved
+from its predecessors and offers the following modules:
 
 - Attack: Includes modules for web, wireless, and radio attacks.
 
-- Botnet: Deals with micro VM-based botnets, especially for web-related tasks.
+- Botnet: Deals with micro VM-based botnets, especially for web-related
+tasks.
 
 - Curl: Provides bindings and automations for the Curl utility.
 
@@ -24,18 +44,44 @@
 
 - Scanner: Provides a web scanner for general use.
 
-- Core/Mod.rs: Allows for the download of entire web servers (if linked) and offers automations for tools like Exif and common ports for Nmap.
-
-- This core application serves as the foundation for the entire project, offering a wide array of cybersecurity and system administration capabilities.
-
-**maid_ui**: MaidUI is the user interface (UI) repository, containing HTML, CSS, JavaScript, and more. It's closely related to the Tauri app, MaidVisual, and ensures that the user experience is top-notch.
-
-**maid_visual**: MaidVisual is a native Linux application designed for log and data analysis visualization. The src/ folder is a symbolic link to maid_ui/src, which means it leverages the resources and assets from the MaidUI repository. It provides a user-friendly interface for visualizing log and data analysis, enhancing the project's usability.
-
-**Monorepos**: The project follows a monorepo (monolithic repository) structure, where multiple related projects or components are stored in a single repository. This approach simplifies code sharing, dependency management, and overall project organization, making it easier to maintain and collaborate on different parts of the project.
-
-**CI/CD** (Continuous Integration/Continuous Deployment): The project employs a robust CI/CD pipeline that automates the build, testing, and deployment processes. This ensures that code changes are continuously integrated and tested, and new releases can be deployed swiftly and reliably.
-
-**Build System**: The build system is a crucial part of the project, responsible for compiling code and packaging it for deployment. It generates Linux executables and Snap packages for Ubuntu, streamlining the distribution and installation of the software.
-
-These enhancements aim to provide a more detailed and comprehensive understanding of each component and the overall project structure while highlighting the importance of monorepos, CI/CD, and the build system.
+- Core/Mod.rs: Allows for the download of entire web servers (if linked)
+and offers automations for tools like Exif and common ports for Nmap.
+
+- This core application serves as the foundation for the entire project,
+offering a wide array of cybersecurity and system administration
+capabilities.
+
+**maid_ui**: MaidUI is the user interface (UI) repository, containing
+HTML,
+CSS, JavaScript, and more. It's closely related to the Tauri app,
+MaidVisual,
+and ensures that the user experience is top-notch.
+
+**maid_visual**: MaidVisual is a native Linux application designed for log
+and data analysis visualization. The src/ folder is a symbolic link to
+maid_ui/src, which means it leverages the resources and assets from the
+MaidUI repository. It provides a user-friendly interface for visualizing
+log and data analysis, enhancing the project's usability.
+
+**Monorepos**: The project follows a monorepo (monolithic repository)
+structure, where multiple related projects or components are stored in
+a single repository. This approach simplifies code sharing, dependency
+management, and overall project organization, making it easier to maintain
+and collaborate on different parts of the project.
+
+**CI/CD** (Continuous Integration/Continuous Deployment): The project
+employs
+a robust CI/CD pipeline that automates the build, testing, and deployment
+processes. This ensures that code changes are continuously integrated and
+tested, and new releases can be deployed swiftly and reliably.
+
+**Build System**: The build system is a crucial part of the project,
+responsible for compiling code and packaging it for deployment. It
+generates
+Linux executables and Snap packages for Ubuntu, streamlining the
+distribution
+and installation of the software.
+
+These enhancements aim to provide a more detailed and comprehensive
+understanding of each component and the overall project structure while
+highlighting the importance of monorepos, CI/CD, and the build system.

CODE_OF_CONDUCT.md

@@ -1,6 +1,10 @@
-# Copy on FreeBSD Community Code of Conduct
+# From FreeBSD Code of Conduct
 
-The MaidRunner community has always worked to be a welcoming and respectful community, and we want to ensure that doesn’t change as we grow and evolve. To that end, we have a few ground rules that we ask people to adhere to:
+The MaidRunner community has always worked to be a welcoming and
+respectful
+community, and we want to ensure that doesn’t change as we grow and
+evolve. To that end, we have a few ground rules that we ask people to
+adhere to:
 
 - be friendly and patient,
 - be welcoming,
@@ -9,31 +13,87 @@ The MaidRunner community has always worked to be a welcoming and respectful comm
 - be careful in the words that you choose and be kind to others,
 - when we disagree, try to understand why.
 
-This isn’t an exhaustive list of things that you can’t do. Rather, take it in the spirit in which it’s intended - a guide to make it easier to communicate and participate in the community.
+This isn’t an exhaustive list of things that you can’t do. Rather,
+take it in the spirit in which it’s intended - a guide to make it easier
+to communicate and participate in the community.
 
-This code of conduct applies to all spaces managed by the MaidRunner project. This includes online chat, mailing lists, bug trackers, MaidRunner events such as the developer meetings and socials, and any other forums created by the project that the community uses for communication. It applies to all of your communication and conduct in these spaces, including emails, chats, things you say, slides, videos, posters, signs, or even t-shirts you display in these spaces. In addition, violations of this code outside these spaces may, in rare cases, affect a person’s ability to participate within them, when the conduct amounts to an egregious violation of this code.
+This code of conduct applies to all spaces managed by the MaidRunner
+project. This includes online chat, mailing lists, bug trackers,
+MaidRunner
+events such as the developer meetings and socials, and any other forums
+created
+by the project that the community uses for communication. It applies
+to all
+of your communication and conduct in these spaces, including emails,
+chats,
+things you say, slides, videos, posters, signs, or even t-shirts you
+display
+in these spaces. In addition, violations of this code outside these spaces
+may, in rare cases, affect a person’s ability to participate within
+them,
+when the conduct amounts to an egregious violation of this code.
 
-If you believe someone is violating the code of conduct, we ask that you report it by emailing [email protected]. For more details please see our Reporting Guide.
+If you believe someone is violating the code of conduct, we ask that you
+report it by emailing [email protected]. For more details please see
+our Reporting Guide.
 
 **Be friendly and patient.**
 
-**Be welcoming.** We strive to be a community that welcomes and supports people of all backgrounds and identities. This includes, but is not limited to members of any race, ethnicity, culture, national origin, color, immigration status, social and economic class, educational level, sex, sexual orientation, gender identity and expression, age, size, family status, political belief, religion or lack thereof, and mental and physical ability.
+**Be welcoming.** We strive to be a community that welcomes and supports
+people of all backgrounds and identities. This includes, but is not
+limited to
+members of any race, ethnicity, culture, national origin, color,
+immigration
+status, social and economic class, educational level, sex, sexual
+orientation,
+gender identity and expression, age, size, family status, political
+belief,
+religion or lack thereof, and mental and physical ability.
 
-**Be considerate.** Your work will be used by other people, and you in turn will depend on the work of others. Any decision you take will affect users and colleagues, and you should take those consequences into account. Remember that we’re a world-wide community, so you might not be communicating in someone else’s primary language.
+**Be considerate.** Your work will be used by other people, and you
+in turn
+will depend on the work of others. Any decision you take will affect users
+and colleagues, and you should take those consequences into
+account. Remember
+that we’re a world-wide community, so you might not be communicating in
+someone else’s primary language.
 
-**Be respectful.** Not all of us will agree all the time, but disagreement is no excuse for poor behavior and poor manners. We might all experience some frustration now and then, but we cannot allow that frustration to turn into a personal attack. It’s important to remember that a community where people feel uncomfortable or threatened is not a productive one. Members of the MaidRunner community should be respectful when dealing with other members as well as with people outside the MaidRunner community.
+**Be respectful.** Not all of us will agree all the time, but disagreement
+is no excuse for poor behavior and poor manners. We might all experience
+some frustration now and then, but we cannot allow that frustration
+to turn
+into a personal attack. It’s important to remember that a community
+where
+people feel uncomfortable or threatened is not a productive one. Members
+of the MaidRunner community should be respectful when dealing with other
+members as well as with people outside the MaidRunner community.
 
-**Be careful in the words that you choose and be kind to others.** Do not insult or put down other participants. Harassment and other exclusionary behavior aren’t acceptable. This includes, but is not limited to:
+**Be careful in the words that you choose and be kind to others.** Do not
+insult or put down other participants. Harassment and other exclusionary
+behavior aren’t acceptable. This includes, but is not limited to:
 
 - Violent threats or language directed against another person.
 - Discriminatory jokes and language.
 - Posting sexually explicit or violent material.
-- Posting (or threatening to post) other people’s personally identifying information ("doxing").
+- Posting (or threatening to post) other people’s personally identifying
+information ("doxing").
 - Personal insults, especially those using racist or sexist terms.
 - Unwelcome sexual attention.
 - Advocating for, or encouraging, any of the above behavior.
 
-**In general, if someone asks you to stop, then stop.** Persisting in such behavior after being asked to stop is considered harassment.
+**In general, if someone asks you to stop, then stop.** Persisting in such
+behavior after being asked to stop is considered harassment.
 
-**When we disagree, try to understand why.** Disagreements, both social and technical, happen all the time and MaidRunner is no exception. It is important that we resolve disagreements and differing views constructively. Remember that we’re different. The strength of MaidRunner comes from its varied community, people from a wide range of backgrounds. Different people have different perspectives on issues. Being unable to understand why someone holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that it is human to err and blaming each other doesn’t get us anywhere. Instead, focus on helping to resolve issues and learning from mistakes.
+**When we disagree, try to understand why.** Disagreements, both
+social and
+technical, happen all the time and MaidRunner is no exception. It is
+important
+that we resolve disagreements and differing views constructively. Remember
+that we’re different. The strength of MaidRunner comes from its varied
+community, people from a wide range of backgrounds. Different people have
+different perspectives on issues. Being unable to understand why someone
+holds a viewpoint doesn’t mean that they’re wrong. Don’t forget that
+it is human to err and blaming each other doesn’t get us
+anywhere. Instead,
+focus on helping to resolve issues and learning from mistakes.