National Pest Management

    ggip

    1.0.9 • Public • Published

    GRE GeoIP CLI

    The official CLI for GRE GeoIP API


    Report Issue · Request Feature · API Home Page · API Docs




    npm version    GitHub code size in bytes    License: MIT    API Status

    Installation

    npm install --global ggip
    

    Usage

    $ ggip -h
    
        The official CLI for GRE GeoIP API.
    
        ー Usage:
            geoip <command> [arguments] [options]
    
        ー Commands:
            me          Used to fetch your IP Address information.
            lookup      Retrieves the information of a specific IP Address.
            country     Retrieves the information of a specific Country.
    
    
        ー Options:
            -h          Show information about the current command.
            -v          Show the current CLI version.
    
    
        ー Tips:
            Each comand has specific optins. Please use
            '-h' after the command for more information
    
            Examples:
                geoip -h
                geoip me -h
                geoip country -h
                geoip lookup -h
    



    Configuration

    After installing the CLI, you need to set your API Key in order to use it's funcitonalities. This step can be done just by typeing the main CLI name in your terminal.

    $ ggip
    
        The official CLI for GRE GeoIP API.
    
        ―   Hello 👋, it looks like this is the first time you use the tool.
            First of all,  you need to set your API Key.  If you don't have
            one yet, Please obtain a new one by creating a new  account  at:
            https://www.gredev.io/en/portal/register
    
            Note: This is a one-time step.
    
        Paste your API Key ⨠
    

    Just paste your API Key and hit Enter.

    NOTE: You can obtain an API Key just by creating an account at https://www.gredev.io/en/portal/register.


    Examples

    $ ggip -h                           # Show usage information.
    $ ggip me -h                        # Show usage information for `me` command.
    $ ggip me                           # Used to get the current IP Address info.
    $ ggip me -o JSON                   # Get the current IP Address in `JSON`
                                        # format.
    $ ggip me -i                        # Get only the current IP Address.
    $ ggip lookup 1.1.1.1               # Fetch the information of a specific IP
                                        # Address.
    $ ggip lookup 1.1.1.1 -m timezone   # Fetch the information of a specific IP 
                                        # Address with the timezone information.
    $ ggip country US                   # Fetch the information of a country code.



    Credits



    License

    The MIT License (MIT). Please see License File for more information.

    Install

    npm i ggip

    DownloadsWeekly Downloads

    0

    Version

    1.0.9

    License

    MIT

    Unpacked Size

    285 kB

    Total Files

    33

    Last publish

    Collaborators

    • ghadeer.r.majeed