Introduction

Cyberclip is designed to detect and extract recognizable data from text inputs, enabling data transformation and enrichment for cybersecurity professionals. Tailored for cyber threat analysts and SOC operators, Cyberclip helps investigate and pivot around technical indicators such as domains, URLs, IP addresses, and file hashes. It features a simple terminal interface (TUI) that integrates with tools like UrlScan, OpenCTI, and VirusTotal. It can also be used to extract data from JSON, defang IoCs, and encode or decode data in formats like Hex, Base64, and URL encode and much more... In short, Cyberclip empowers investigators to perform quick checks and make informed decisions during investigations!

User documentation: https://bongoknight.github.io/cyberclip/Features%20tour/

.env file and variables

Variables that allows Cyberclip to authenticate itself against third-party API should be written in /src/cyberclip/.env:

DATALAKE_EMAIL="<DATALAKE EMAIL>"
DATALAKE_PASSWORD="<DATALAKE PASSWORD>"
DEEPL_API_KEY="<DEEPL API_KEY>"
SHODAN_API_KEY="<SHODAN API KEY>"
URLSCAN_API_KEY="<URLSCAN API KEY>"
VIRUSTOTAL_API_KEY="<VIRUS TOTAL API KEY>"

Installation

Requirements

• Python 3.10+ (up to 3.13)
• Git (for source installation)
• Docker (for docker deployment)

Quick Start

Basic Installation (TUI only)

pip install cyberclip

With Optional Features

# With GUI (Radial Menu - Qt-based)
pip install cyberclip[gui]

# With Web Interface (Flask-based)
pip install cyberclip[web]

# With all optional features
pip install cyberclip[all]

📖 See INSTALL.md for detailed installation options and platform-specific notes.

With uv

# Basic installation
uv tool install git+https://github.com/BongoKnight/cyberclip

# With all features
uv tool install "git+https://github.com/BongoKnight/cyberclip[all]"

# For trying (temporary)
uv tool run git+https://github.com/BongoKnight/cyberclip

# Run
cyberclip

With pipx

# Basic installation
pipx install "cyberclip @ git+https://github.com/BongoKnight/cyberclip"

# With all features
pipx install "cyberclip[all] @ git+https://github.com/BongoKnight/cyberclip"

With Docker

git clone https://github.com/BongoKnight/cyberclip
cd cyberclip
docker build -t cyberclip .
docker run --env-file .env -p 8000:8000 cyberclip web --host 0.0.0.0 --port 8000

Generate documentation

pip install mkdocs mkdocs-gen-files mkdocs-material mkdocs-autorefs mkdocstrings-python
mkdocs gh-deploy

Thanks to and similar project:

• Textual
• Textual-pandas
• CyberChef
• Visidata
• Cheepy
• Cyberbro