13 releases (stable)

5.3.2 May 13, 2023
5.3.1 Mar 7, 2023
5.3.0 Feb 26, 2023
4.0.1 Feb 20, 2023
0.2.5 Sep 6, 2022

#1755 in Command line utilities

Download history 5/week @ 2024-02-26 4/week @ 2024-03-11 221/week @ 2024-04-01

225 downloads per month

MIT license

19KB
454 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–19MB
~290K SLoC