Skip to content

Commit 26c8bf9

Browse files
Update README.md
1 parent 5aa6ae6 commit 26c8bf9

File tree

1 file changed

+61
-24
lines changed

1 file changed

+61
-24
lines changed

README.md

Lines changed: 61 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
# Logicytics: System Data Harvester 📎
22

3-
Welcome to **Logicytics**, a powerful tool designed to harvest and collect a wide range of Windows system data for forensics. It's an actively developed project that primarily uses Python. Its goal is to gather as much sensitive data as possible and output it into a ZIP file. This guide will help you get started with using Logicytics effectively.
3+
Welcome to Logicytics 🌐,
4+
a cutting-edge tool
5+
designed to meticulously harvest and collect a vast array of Windows system data for forensic analysis.
6+
Crafted with Python 🐍,
7+
it's an actively developed project
8+
aimed at gathering as much sensitive data as possible and packaging it neatly into a ZIP file 📦.
9+
This comprehensive guide is here to equip you with everything you need to use Logicytics effectively.
410

511
<div align="center">
612
<a href="https://github.com/DefinetlyNotAI/Logicytics/issues"><img src="https://img.shields.io/github/issues/DefinetlyNotAI/Logicytics" alt="GitHub Issues"></a>
@@ -12,42 +18,73 @@ Welcome to **Logicytics**, a powerful tool designed to harvest and collect a wid
1218
<a href="https://github.com/DefinetlyNotAI/Logicytics"><img src="https://img.shields.io/github/repo-size/DefinetlyNotAI/Logicytics" alt="GitHub Repo Size"></a>
1319
</div>
1420

15-
### ⚠️ Agree to the ToS ⚠
21+
## 🛠️ Installation and Setup 🛠
1622

17-
Due to the use of third-party applications, they come with their own set of Terms of Service. It's mandatory to read the `!! Important!!.md` file located in the CODE/sys directory.
23+
### Prerequisites
24+
Ensure your system meets these requirements:
25+
- Windows 10 or later.
26+
- Administrative rights.
27+
- Python installed (preferable version 3.11).
1828

19-
We also have our own ToS, it will prompt you when you first run Logicytics to agree to the ToS; don't worry as its small short and straightforward to read, and we don't attempt to trick you into selling your soul.
29+
### Step-by-Step Installation
30+
1. **Clone the Repository**: Use Git to clone Logicytics to your local machine. Open Command Prompt as an administrator and run:
31+
```powershell
32+
git clone https://github.com/DefinetlyNotAI/Logicytics.git
33+
```
34+
2. **Navigate to the Project Directory**: Change your current directory to the cloned Logicytics folder:
35+
```powershell
36+
cd Logicytics
37+
```
2038

21-
## 💻 Running Logicytics 💻
39+
## 🔧 Configuration 🔧
2240

23-
To run the main program, you need to execute `Logicytics.py` with administrative privileges. Follow these steps:
41+
Logicytics offers extensive customization options through flags while running.
2442

25-
1. Open Command Prompt as an administrator.
26-
2. Navigate to the directory where `Logicytics.py` is located.
27-
3. Run the script by typing the following command and pressing Enter:
43+
These flags allow you to:
44+
- Specify which types of data to collect.
45+
- Exclude certain files/data from the data collection process.
46+
- Adjust logging levels for detailed insights.
2847

29-
```powershell
30-
.\Logicytics.py
31-
```
48+
More info on the wiki.
3249

33-
This will show the available command flags to use, if you want the default experience execute the following command `.\Logicytics.py --run`
50+
## 🚀 Advanced Usage 🚀
3451

35-
## ⚠️ Important Notes ⚠️
52+
### Custom Scripts
53+
Extend Logicytics' functionality by creating custom Python scripts.
54+
Place these scripts in the `CODE` directory.
55+
(WIP) Logicytics will automatically execute these scripts during the data collection process,
56+
enabling tailored data extraction.
57+
For now, these scripts must be manually executed.
3658

37-
- **Do Not Remove or Delete Any Folders or Files:** The integrity of the data collection process depends on the presence of all necessary files and folders. Removing or deleting any part of the Logicytics package could lead to errors or incomplete data collection.
59+
## 🛑 Troubleshooting 🛑
3860

39-
- **Third-Party Tools:** For those interested in additional functionality, you can explore more third-party software in the EXTRA tab. This tool offers advanced memory analysis capabilities and more features.
61+
### Common Pitfalls
62+
- **Permission Denied**: Ensure you're running Logicytics with administrative privileges.
63+
- **Incomplete Data Collection**: Verify all necessary files and folders are intact and unmodified.
64+
- **Update Issues**: Use the `--update` flag to fetch the latest version of Logicytics.
4065

41-
- **Access Permissions:** The only files you should access after running Logicytics are the generated ZIP file and the `.md` log file (WIP). These files contain the collected data and log information, respectively, and are found in the CODE subdirectory; you can freely move them anywhere.
66+
### Support Resources
67+
Consult the `.md` log file in the `ACCESS/LOGS` directory for detailed error logs.
68+
Engage with the community through GitHub issues for assistance and feedback.
4269

43-
- **Releases:** Don't download files from there; that is just some sort of mini-update log. Download from the main branch; old versions won't be saved here and might not be supported.
70+
## 📊 Data Analysis 📊
4471

45-
- **Credits:** In the credits, you will find many people, firms, and projects whose code/software we used. If you are the creator of the project and don't want us to use your code, feel free to contact us, so we can remove it.
72+
Once Logicytics has completed its data collection,
73+
you'll find the results packaged neatly in a ZIP file within the `ACCESS/DATA` directory.
74+
This data can be analyzed using various tools and techniques, depending on your needs.
75+
Whether you're conducting forensic investigations, auditing system health,
76+
or analyzing performance metrics, Logicytics provides a solid foundation for your analysis.
4677

47-
- **Explore:** Check all the files and ReadMe to understand how and what the project does.
78+
## 🌟 Conclusion 🌟
4879

49-
## 📀 Conclusion 📀
80+
By exploring the depths of Logicytics, you've gained a deeper understanding of its capabilities,
81+
configuration options, and advanced features.
82+
This tool is a powerful asset in your arsenal for system data analysis,
83+
offering flexibility, customization, and ease of use.
84+
Remember, the key to unlocking its full potential lies in experimentation and continuous learning.
85+
Happy data mining 🎯
5086

51-
Logicytics is a powerful tool for system data analysis. By following the instructions above, you can ensure a smooth and effective data collection process. Remember, the key to successful data harvesting is patience and adherence to the guidelines provided. Happy data mining!
52-
53-
🪦 We are not responsible for any illegal usage of this product.
87+
This expanded guide aims to provide a thorough understanding of Logicytics,
88+
covering everything from installation and setup to advanced usage and troubleshooting.
89+
With this knowledge, you're well-equipped to utilize Logicytics to its fullest extent,
90+
enhancing your ability to analyze and understand system data.

0 commit comments

Comments
 (0)