#cli #geolocation

app geolocate

A CLI for geolocation data providers

12 releases (stable)

5.3.1 Mar 7, 2023
5.3.0 Feb 26, 2023
4.0.1 Feb 20, 2023
3.0.1 Feb 20, 2023
0.2.5 Sep 6, 2022

#168 in Command line utilities

Download history 4/week @ 2022-11-20 1/week @ 2022-11-27 1/week @ 2022-12-04 1/week @ 2022-12-11 4/week @ 2022-12-18 1/week @ 2022-12-25 1/week @ 2023-01-01 5/week @ 2023-01-08 6/week @ 2023-01-15 11/week @ 2023-01-22 9/week @ 2023-01-29 6/week @ 2023-02-05 11/week @ 2023-02-12 129/week @ 2023-02-19 52/week @ 2023-02-26 24/week @ 2023-03-05

216 downloads per month

MIT license

18KB
448 lines

Geolocate

Geolocate is a CLI app to fetch geolocation data from various providers. Currently, we support ip2location and ipgeolocation. If you'd like others to be supported, you're welcome to create a feature request.

Installation

Geolocate compiles on stable. There are multiple ways to install it:

Usage

You should start with getting some API tokens for at least one of the supported providers. Both ip2location and ipgeolocation have a free tier. You can save them with geolocate config --edit. This command will open the configuration file with you favourite editor where you will have to add the tokens. IMPORTANT: The key of the token has to be name of the provider. For example:

ip2location = "yourtokengoeshere"
ipgeolocation = "yourothertokengoeshere"

If you don't do this, geolocate will not recognise them and won't be very useful. Be sure you write correct toml data, but

A subcommand exists for each provider. For example, to fetch geo data for an IP address of 1.2.3.4 from the ipgeolocation provider, you would run the following:

geolocate ipgeolocation 1.2.3.4

The IP addresses may be IPv4 or IPv6. Geolocate will accept either so long they're correct, but makes no guarantees that the provider accepts them.

Dependencies

~6–14MB
~292K SLoC