A simple Command-Line Interface (CLI) tool to fetch geolocation data for an IP address using the ipstack API. This tool supports commands for fetching geolocation for a single IP, bulk IP addresses, and even your own IP address.
- Fetch geolocation for a single IP address.
- Fetch geolocation for multiple IP addresses in bulk.
- Check geolocation for your own IP address.
- Store the API key in environment variables for secure usage.
To install the tool globally on your system, run the following command:
npm install -g ipstack-cli
After installation, you'll be able to run ipstack
commands from anywhere on your terminal.
Before using the CLI, you need to provide an API key from ipstack. You can set your API key using the following command:
ipstack add <your_api_key>
This will save your API key for future use in the environment variables as IPSTACK_API_KEY
.
Use the add
command to set your ipstack API key:
ipstack add <your_api_key>
This will save your API key for future use.
Fetch geolocation data for a single IP address:
ipstack standard <ip_address>
Example:
ipstack standard 134.201.250.155
Fetch geolocation data for multiple IP addresses:
ipstack bulk <ip_address_1> <ip_address_2> <ip_address_3> ...
Example:
ipstack bulk 134.201.250.155 72.229.28.185 110.174.165.78
Get the geolocation for your current IP address:
ipstack check
This will automatically fetch the geolocation data for your own IP.
This CLI tool uses the IPSTACK_API_KEY
environment variable to store your ipstack API key.
If you want to set it permanently, add the following line to your shell profile (~/.bashrc
, ~/.zshrc
, etc.):
export IPSTACK_API_KEY=<your_api_key>
After adding it, make sure to reload your shell configuration:
source ~/.bashrc # or source ~/.zshrc
Feel free to fork, modify, and submit pull requests. For any issues or feature requests, please create an issue in the GitHub repository.
This project is open-source and available under the MIT License.