CLI Tool to gather System Information, IP Address, and device location.

Explore the docs »

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Features
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

HackIP is 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.

Features

HackIP 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 Started

To install HackIP, follow these steps:

Prerequisites

1. Python >=3.9
2. OpenAI Key
3. Cuttly API key (optional)

Installation

With pip:

pip install hack-ip

Next, run:

hackip

Usage

You can run the HackIp using the following command:

hackip run [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 Usage

Run HackIp with Advanced Scanning and Chat:

hackip run --details --chat --cuttly_api_key YOUR_CUTTLY_API_KEY --openai_key YOUR_OPENAI_API_KEY

Run HackIp with Chat Feature Only:

hackip run --chat --openai_key YOUR_OPENAI_API_KEY

Note: Replace YOUR_CUTTLY_API_KEY and YOUR_OPENAI_API_KEY with your actual API keys.

Star History

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/<feature>)
3. Commit your Changes (git commit -m 'Add some <feature>')
4. Push to the Branch (git push origin feature/<feature>)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Subhomoy Roy Choudhury - SDE at Fynd - Github - Linkedin - Twitter

Project Link: https://github.com/subhomoy-roy-choudhury/Hack_IP

Acknowledgements

• Open AI
• Poetry
• Nmap
• Beautify Github Readme