https://github.com/ramprasathmk/keylogger
A simple python based Key-Logger project in Cyber Security
https://github.com/ramprasathmk/keylogger
cybersecurity cybersecurity-projects keylogger keylogger-python keylogger-stealer python python3 tool
Last synced: 4 months ago
JSON representation
A simple python based Key-Logger project in Cyber Security
- Host: GitHub
- URL: https://github.com/ramprasathmk/keylogger
- Owner: ramprasathmk
- License: mit
- Created: 2024-04-04T04:38:17.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-30T14:22:24.000Z (11 months ago)
- Last Synced: 2025-06-27T19:47:35.444Z (6 months ago)
- Topics: cybersecurity, cybersecurity-projects, keylogger, keylogger-python, keylogger-stealer, python, python3, tool
- Language: Python
- Homepage:
- Size: 2.53 MB
- Stars: 8
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Keylogger
**Keylogger** is a Python-based project designed to capture and log keystrokes. It demonstrates how key-logging can be used for various purposes, such as monitoring typing activity for research, troubleshooting keyboard issues, or learning how keyloggers work for cybersecurity education.
⚠️ **Note**: This project is for **educational purposes only**. Please use responsibly and only on systems you have permission to monitor.
---
## 🚀 Features
- **Capture Keystrokes**: Records every keystroke made on the keyboard.
- **Logs to File**: Saves keystrokes into a log file for later analysis.
- **Hidden Execution**: Runs in the background without user interference.
- **Modular Design**: Built with functions that can be easily customized or extended.
---
## 📦 Project Structure
The project contains the following main files:
- **`keylogger.py`** - The main script that initiates the keylogger.
- **`requirements.txt`** - Lists all the Python libraries needed for this project.
---
## > Technologies Used
[](https://skillicons.dev)
---
## 🛠️ Setup and Installation
Follow these steps to get the project up and running on your local machine.
### Prerequisites
- **Python 3.x**: Make sure you have Python installed. You can download it from [python.org](https://www.python.org/downloads/).
- **Git**: (Optional) To clone the repository from GitHub.
### Installation
#### 1. Clone the Repository
```bash
git clone https://github.com/ramprasathmk/keylogger.git
cd keylogger
```
#### 2. Set Up Virtual Environment
Run this command to create and activate a virtual environment (recommended):
```bash
python -m venv env
```
#### 3. Activate the Virtual Environment
- Windows:
```bash
env\Scripts\activate
```
- MacOS/Linux:
```bash
source env/bin/activate
```
#### 4. Install Requirements
Install the required dependencies:
```bash
pip install -r requirements.txt
```
## 🔍 Usage
Once you've set up the environment, you're ready to run the keylogger.
#### 1. Run the Keylogger
- To start logging keystrokes, run:
```bash
python keylogger.py
```
#### 2. Check Logs
- Keystrokes are saved in a file (specified within the script). Open this file to view the logged keystrokes.
#### 3. How it works?
- Refer [Code.md](./Code.md)
## ⚠️ Disclaimer
- This keylogger is intended for educational and research purposes only. Unauthorized keylogging is illegal and unethical. Only run this on systems you have permission to monitor.
## 💡 Customization and Expansion
- Logging Format: You can adjust how keystrokes are logged (timestamps, formatting, etc.) within the script.
- Additional Features: Try adding email reporting, screenshots, or encryption to further enhance functionality.
## 🧑💻 Contributing
- Contributions are welcome! Feel free to open issues or submit pull requests to improve the project. Always ensure compliance with ethical guidelines and project goals.
## 📄 License
- This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
## 🙋♂️ Questions?
- If you have any questions or need clarification, feel free to reach out via the GitHub Issues section.
- This **README** provides a friendly, clear, and ethical overview, and ensures users understand both setup and legal considerations.
## ✨ Show your support
Give a ⭐ if you like this repository!
Happy Logging! 🔍