chx

command module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 27, 2024 License: MIT Imports: 1 Imported by: 0

README ΒΆ

πŸ› οΈ CHX

πŸ“˜ Introduction

CHX is a Golang based CLI 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

βš™οΈ 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.

configure chx with json

🌐 Domain Analysis
chx domain example.com

domain checks

πŸ”‘ 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.

using chx with pipes

πŸ“‘ IP Lookup
chx ip 8.8.8.8

Basic IP lookups (uses alientvault) basic ip checks

πŸ”§ 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

πŸ“œ License

MIT

πŸ“£ Release Announcments

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

telegram channel QR Code

Documentation ΒΆ

The Go Gopher

There is no documentation for this package.

Directories ΒΆ

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL