3 Usage

Introduction

Logicytics.py is a comprehensive tool designed to streamline and automate various tasks related to software development, system management, and data processing. It offers a wide range of functionalities through command-line flags, allowing users to customize their experience according to their needs.

Flags

General Usage

Flags are command-line arguments that modify the behaviour of the Logicytics.py script. They provide a flexible way to execute specific parts of the program or alter its default behaviour. To use a flag, include it after the script name when running it from the command line, preceded by two hyphens (--). For example:

cd Logicytics/CODE
python Logicytics.py --help

This command would run help menu of Logicytics.

Specific Flags

Logicytics.py [-h] [--default] [--threaded] [--modded] [--depth] [--nopy] [--vulnscan-ai] 
                    [--minimal] [--performance-check] [--debug] [--backup]
                     [--update] [--dev] [--reboot] [--shutdown] [--webhook] [--restore]

Click to expand for the Flag Explanation

Flag	Description	Additional Info
-h, --help	Show this help message and exit
--default	Runs Logicytics with its default settings and scripts	Recommended for most users
--threaded	Runs Logicytics using threads, where it runs in parallel, with default settings	Recommended for some users
--modded	Runs the normal Logicytics, as well as any file in the MODS directory	Used for custom scripts as well as default ones
--depth	Runs all default scripts in threading mode, useful for large code and data-heavy operations	Will take a long time
--nopy	Runs Logicytics using all non-Python scripts	Use if the device doesn't have Python installed; may be outdated
--vulnscan-ai	Run's Logicytics new Sensitive data Detection AI, its a new feature that will detect any files that are out of the ordinary, and logs their path. Runs threaded	Still in beta, and takes hours to finish, only runs vulnscan
--minimal	Runs Logicytics in minimal mode with only essential scraping	Quick scripts only
--performance-check	Run's Logicytics default while testing its performance and time, this then shows a table with the file names and time to executed.	Generates a special log file for performance reporting, Still in beta
--debug	Runs the debugger, checking for issues or warnings	Generates a special log file for bug reporting
--backup	Backs up Logicytics files to the ACCESS/BACKUPS directory	Use on your own device only
--update	Updates Logicytics from GitHub if downloaded via git	Use on your own device only
--dev	Runs Logicytics in developer mode	For those registering contributions; use on your own device
--reboot	Executes a flag to reboot the device afterward
--shutdown	Executes a flag to shut down the device afterward
--webhook	Executes a flag to send a zip file via webhook	Not yet implemented
--restore	Restores Logicytics files from the ACCESS/BACKUPS directory	Not yet implemented

Flags Compatibility and Restrictions

Standalone System flags (cannot be combined with others - Are part of the System tools of Logicytics):

• --backup
• --restore
• --update
• --dev
• --debug

Unique flags (cannot be combined with each other, but can be used with sub-action flags):

• --default
• --minimal
• --extra
• --nopy
• --modded
• --threaded
• --depth
• --vulnscan-ai
• --performance-check

Sub-action flags (cannot be used alone, must be paired with another flag):

• --webhook
• --reboot
• --shutdown

Choosing multiple incompatible flags will result in an error, emphasizing the need for specificity in how you wish to execute the script.

Understanding the nuances of flag compatibility and the strict requirement for a single run flag is crucial for effectively leveraging the full potential of Logicytics.py. By carefully selecting the appropriate flags based on your current needs and ensuring compatibility, you can tailor the script's behaviour to fit your specific requirements, whether for development, debugging, system management, or data processing tasks.

File Structure

The Logicytics project is organized into several directories, each serving a distinct purpose:

• ACCESS: If the software is used, these are generated; Contains the BACKUP zips, DATA zips, The DATA zips hashes AND the logs of both the main code and the debugger.

• CODE: Houses the core codebase, including the wrapper, system executables, and all source code files and the custom libraries.

• MODS: Features third-party tools or scripts that extend the functionality of Logicytics.

Click to expand for projects structure

/Logicytics
├─── /ACCESS # Generates after execution #
│    ├─── /BACKUP
│    │    └─── # Contains the backups of the project in case of restoration later on #
│    ├─── /DATA
│    │    ├─── /Hashes
│    │    │    └─── # Contains the hashes of the zipped files #
│    │    └─── /Zip
│    │         └─── # Contains the zipped extracted data - Sorted by time as well #
│    └─── /LOGS
│         ├─── /DEBUG
│         │    └─── # Contains your debug logs #
│         ├─── /PERFORMANCE
│         │    └─── # Contains your performance logs #
│         └─── # Contains your normal logs #
├─── /CODE
│    ├─── /logicytics [You may ignore this, includes libraries custom to Logicytics]
│    ├─── /SysInternal_Suite
│    │    ├─── # SYS INTERNAL EXE - ZIPPED #
│    │    └─── # You may add your .sys.ignore file here to not use the EXE/unzip it #
│    ├─── /VulnScan
│    │    ├─── /tools [Includes a bunch of tools to help train the models]
│    │    ├─── /v2-deprecated [Includes model trainer and generator, v2 deprecated]
│    │    ├─── /v3 [Includes model trainer and generator, v3]
│    │    └─── # Contains the actual vectorizer and model file's #
│    └─── # THE ACTUAL CODE #
└─── /MODS
     └─── # Contains the mods for the project [You can add your own mods here] #

Access Directory

The ACCESS directory is crucial for monitoring the progress and results of Logicytics operations.

The LOGS subdirectory contains the most recent debugger logs, which can be invaluable for diagnosing issues or understanding the behaviour of the script.

The DATA subdirectory holds all compressed files produced by Logicytics as well as hashes,

Finally, the subdirectory BACKUP has the backups required, providing a centralized location for managing these resources.

By thoroughly understanding and utilizing these sections and flags, users can maximize the efficiency and effectiveness of Logicytics.py, tailoring its capabilities to meet their specific needs and workflows.