gip 0.3.1

A library and command-line frontend to check global IP address
Documentation

gip

Build Status Crates.io Docs.rs codecov

gip is a command-line tool and Rust library to check global IP address.

Install

Download from release page, and extract to the directory in PATH.

Alternatively you can install by cargo.

cargo install gip

Usage

gip                    // show global IP address by plane text.
gip -s                 // show global IP address by plane text without line break.
gip -j                 // show global IP address by JSON.                        ( ex. {"ip", "xxx.xxx.xxx.xxx"} )
gip -j --json-key key  // show global IP address by JSON with the specified key. ( ex. {"key", "xxx.xxx.xxx.xxx"} )

Providers

Currently built-in service providers are the followings.

If you want to change providers, providers can be set by $HOME/.gip.toml like the following.

[[providers]]
    name    = "inet-ip.info"
    ptype   = "Plane"
    timeout = 1000
    url     = "http://inet-ip.info/ip"

[[providers]]
    name    = "httpbin.org"
    ptype   = "Json"
    timeout = 1000
    url     = "http://httpbin.org/ip"
    key     = ["origin"]

Library

gip is provided as Rust library.

gip = "*"

Documentation