chx

🛠️ CHX

📘 Introduction

⚠️ Until v1.x.x chx is subject to breaking changes ⚠️

CHX is a Go-based project providing command-line utilities for domain research, hashing, IP analysis, and other functions. The project includes various commands and integrates with different sources like VirusTotal and CrowdSec.

📑 Table of Contents

• 📘 Introduction
• ⚙️ Installation
• 📝 Usage
• ✨ Features
• 📦 Dependencies
• 🛠️ Configuration
• 📚 Documentation
• 💡 Examples
• 🔧 Troubleshooting
• 👥 Contributors
• 📜 License

⚙️ Installation

To install CHX, ensure you have Go installed on your machine and run the following commands:

go install github.com/EpykLab/chx@latest

Prebuilt binaries are also available under releases.

📝 Usage

After installing the project, you can use the CHX command-line tool as follows:

chx <command> [options]

Example Commands

• chx domain <domain-name>
• chx hash <file-path>
• chx ip <ip-address>

✨ Features

• 🌐 Domain analysis
• 🔑 File hashing
• 📡 IP address lookup
• 🔗 Integration with VirusTotal, CrowdSec, AlientVault, and AbuseIPDB
• ⚙️ Configurable via JSON
• 🖥️ Can take input as argument or stdin

📦 Dependencies

• 🐹 Go (version 1.18 or higher)
• 🌐 External APIs for certain functionalities (e.g., VirusTotal, CrowdSec)

🛠️ Configuration

Configuration is managed through a json file. The config file is stored in $HOME/.config/chx/conf.json.

To configure chx, use chx config.

🌐 Domain Analysis

chx domain example.com

🔑 File Hashing

chx hash <hash>

Chx can work with pipes to take hash values from standard input. In order to be as unix friendly as possible, chx also outputs to stdout so that output can be piped into other tools.

📡 IP Lookup

chx ip 8.8.8.8

Basic IP lookups (uses alientvault)

🔧 Troubleshooting

If you encounter any issues, please check the following:

• Ensure you have the correct API keys in your configuration file.
• Verify your internet connection for API integrations.
• Refer to the logs for any error messages.

👥 Contributors

• David Hoenisch

📜 License

MIT

📣 Release Announcments

Follow our Telegram channel to stay up to date with the latest news and tool releases from EpykLab!