Package: hack-ip
CLI Tool to gather System Information, IP Address, and device location.Explore the docs »View Demo.Report Bug.Request FeatureTable Of ContentsAbout the ProjectFeaturesGetting StartedPrerequisitesInstallationUsageRoadmapContributingLicenseContactAcknowledgementsAbout The ProjectHackIPis an innovative system information and network analysis tool that combines the power of system diagnostics with advanced natural language processing capabilities provided by GPT. HackIP fetches detailed system information, scans for open network ports, identifies public IP addresses, and leverages GPT to provide insightful analysis and interaction with the gathered data.FeaturesHackIP comes with a multitude of features:System Information Gathering: Retrieves comprehensive details about your system's hardware and software configuration.Network Port Scanning: Efficiently scans and reports open network ports, providing crucial information for network security analysis.Public IP Geolocation: Identifies the geolocation of your public IP address, offering valuable context for network traffic analysis.GPT-Enabled Data Interaction: Uses the latest GPT models to interpret, analyze, and interact with the collected data, offering a user-friendly interface and actionable insights.Getting StartedTo install HackIP, follow these steps:PrerequisitesPython >=3.9OpenAI KeyCuttly API key(optional)InstallationWith pip:pipinstallhack-ipNext, run:hackipUsageYou can run the HackIp using the following command:hackiprun[OPTIONS]Each option for the hackip run command is detailed below:--details: Enables advanced detailed scanning using Nmap. This option is suitable for comprehensive network scanning.--chat: Activates a chat interface for interactive communication with the tool.--no_fetch: If set, the tool will chat without fetching system information. Ideal for chat-only interactions.--cuttly_api_key: Specify your Cuttly URL shortener API key with this option, necessary for URL shortening features.--openai_key: Your OpenAI API key. This is required for functionalities that utilize OpenAI services, such as chat response generation.Example UsageRun HackIp with Advanced Scanning and Chat:hackiprun--details--chat--cuttly_api_keyYOUR_CUTTLY_API_KEY--openai_keyYOUR_OPENAI_API_KEYRun HackIp with Chat Feature Only:hackiprun--chat--openai_keyYOUR_OPENAI_API_KEYNote: Replace YOUR_CUTTLY_API_KEY and YOUR_OPENAI_API_KEY with your actual API keys.Star HistoryRoadmapSee theopen issuesfor a list of proposed features (and known issues).ContributingContributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make aregreatly appreciated.If you have suggestions for adding or removing projects, feel free toopen an issueto discuss it, or directly create a pull request after you edit theREADME.mdfile with necessary changes.Please make sure you check your spelling and grammar.Create individual PR for each suggestion.Creating A Pull RequestFork the ProjectCreate your Feature Branch (git checkout -b feature/<feature>)Commit your Changes (git commit -m 'Add some <feature>')Push to the Branch (git push origin feature/<feature>)Open a Pull RequestLicenseDistributed under the MIT License. SeeLICENSEfor more information.ContactSubhomoy Roy Choudhury-SDE at Fynd-Github-Linkedin-TwitterProject Link:https://github.com/subhomoy-roy-choudhury/Hack_IPAcknowledgementsOpen AIPoetryNmapBeautify Github Readme