🌍 IPCap

ipcap 0.1.1

 ▄█     ▄███████▄  ▄████████    ▄████████    ▄███████▄ 
███    ███    ███ ███    ███   ███    ███   ███    ███ 
███▌   ███    ███ ███    █▀    ███    ███   ███    ███ 
███▌   ███    ███ ███          ███    ███   ███    ███ 
███▌ ▀█████████▀  ███        ▀███████████ ▀█████████▀  
███    ███        ███    █▄    ███    ███   ███        
███    ███        ███    ███   ███    ███   ███        
█▀    ▄████▀      ████████▀    ███    █▀   ▄████▀      

🌍 IPCAP CLI
============

Perform IP lookup from the command line without internet access. Retrieve information
about IP addresses, including details such as city, region, country, location, etc.

📖 Table of Contents

• Installation
• Features
• Usage
• Options
• Contributing
• License

🚀 Installation

To install ipcap, use the following Cargo command:

cargo install --locked ipcap --all-features

📖 Download the dataset

Download the city database from the repository using this command:

curl -LS https://raw.githubusercontent.com/wiseaidev/ipcap/main/data/geo_ip_city.dat --create-dirs -o ~/ipcap/geo_ip_city.dat

This will download the data/geo_ip_city.dat from the repository and put it under ~/ipcap/geo_ip_city.dat.

If, for some reason, you decide to change this file location, just set this environment variable to help the CLI read this file. To set the environment variable before running your Rust program, you can do something like:

export IPCAP_FILE_PATH=/your/custom/path/geo_ip_city.dat

Replace /your/custom/path/geo_ip_city.dat with the desired file path. If the environment variable is not set, the program will use the default path (/home/username/ipcap/geo_ip_city.dat).

[!NOTE] The dataset was shamelessly taken from the fedora website at https://src.fedoraproject.org/repo/pkgs/GeoIP-GeoLite-data/GeoLiteCity.dat.gz.

✨ Features

• IP address lookup without internet access.
• Zero API calls for decoding IP addresses.
• Dataset download and customizable file path.

⌨ Usage as CLI

Perform IP lookup:

ipcap -t 8.8.8.8

💻 Usage as Dep

[dependencies]
ipcap = "0.1.1"

use ipcap::geo_ip_reader::GeoIpReader;
use std::fs::File;

fn fn main() {
    let mut geo_ip = GeoIpReader::<File>::new().unwrap();
    let record = geo_ip.get_record("8.8.8.8");

    println!("{:?}", record);
}

🎨 Options

🤝 Contributing

Contributions and feedback are welcome! If you'd like to contribute, report an issue, or suggest an enhancement, please engage with the project on GitHub. Your contributions help improve this CLI for the community.

📄 License

This project is licensed under the MIT License.