From 8ebf9ae0c79e5794317a35dafb7c75a4edf7bcd3 Mon Sep 17 00:00:00 2001 From: Justman100 <149507651+Justman100@users.noreply.github.com> Date: Tue, 8 Jul 2025 13:49:36 +0200 Subject: [PATCH 1/2] Cleaned up --- README.md | 158 +++++++++++++++++++++++------------------------------- 1 file changed, 68 insertions(+), 90 deletions(-) diff --git a/README.md b/README.md index cda98b0f..5c98e896 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,18 @@ # [IPinfo](https://ipinfo.io/) IPinfo CLI -This is the official CLI for the [IPinfo.io](https://ipinfo.io) IP address API, -allowing you to: - -- Look up IP details in bulk or one-by-one. -- Look up ASN details. -- Summarize the details of up to 1000 IPs at a time. -- Open a map of IP locations for any set of IPs. -- Filter IPv4 & IPv6 addresses from any input. -- Print out IP lists for any CIDR or IP range. +This is the official CLI for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to: + +- Look up IP details in bulk or one-by-one +- Look up ASN details +- Summarize the details of up to 1000 IPs at a time +- Open a map of IP locations for any set of IPs +- Filter IPv4 & IPv6 addresses from any input +- Print out IP lists for any CIDR or IP range - And more! ## Installation -The `ipinfo` CLI is available for download via multiple mechanisms. +The `ipinfo` CLI is available for download via multiple mechanisms ### macOS @@ -29,7 +28,7 @@ curl -Ls https://github.com/ipinfo/cli/releases/download/ipinfo-3.3.1/macos.sh | ### Ubuntu PPA -_Note_: this installs our full suite of binaries and keeps them up-to-date. +_Note_: this installs our full suite of binaries and keeps them up-to-date ```bash echo "deb [trusted=yes] https://ppa.ipinfo.net/ /" | sudo tee "/etc/apt/sources.list.d/ipinfo.ppa.list" @@ -39,8 +38,7 @@ sudo apt install ipinfo ### Debian / Ubuntu -_Note_: this is a one-time installation; updates are not automatic. Use the PPA -for automatic updates. +_Note_: this is a one-time installation; updates are not automatic. Use the PPA for automatic updates ```bash curl -Ls https://github.com/ipinfo/cli/releases/download/ipinfo-3.3.1/deb.sh | sh @@ -53,7 +51,7 @@ curl -LO https://github.com/ipinfo/cli/releases/download/ipinfo-3.3.1/ipinfo_3.3 sudo dpkg -i ipinfo_3.3.1_linux_{arch}.deb ``` -where `{arch}` can be 386, amd64, arm, or arm64. +where `{arch}` can be `386`, `amd64`, `arm`, or `arm64` ### FreeBSD @@ -64,13 +62,14 @@ cd /usr/ports/net/ipinfo-cli && make install clean ### Arch linux ```bash -git clone https://aur.archlinux.org/ipinfo-cli.git +git init +git pull https://aur.archlinux.org/ipinfo-cli.git makepkg -si ``` ### Windows Powershell -_Note_: run powershell as administrator before executing this command. +_Note_: run powershell as administrator before executing this command ```bash iwr -useb https://github.com/ipinfo/cli/releases/download/ipinfo-3.3.1/windows.ps1 | iex @@ -88,9 +87,7 @@ scoop install ipinfo-cli docker run --rm -it ipinfo/ipinfo:3.3.1 ``` -To save the CLI's config, add `-v "/path_to_config:/root/.config/ipinfo"`. For -example, the following command saves the config to the `ipinfo` directory in -the current working directory. +To save the CLI's config, add `-v "/path_to_config:/root/.config/ipinfo"`. For example, the following command saves the config to the `ipinfo` directory in the current working directory ```bash docker run --rm -it -v "$PWD/ipinfo:/root/.config/ipinfo" ipinfo/ipinfo:3.3.1 @@ -98,8 +95,7 @@ docker run --rm -it -v "$PWD/ipinfo:/root/.config/ipinfo" ipinfo/ipinfo:3.3.1 ### Using `go install` -Make sure that `$GOPATH/bin` is in your `$PATH`, because that's where this gets -installed: +Make sure that `$GOPATH/bin` is in your `$PATH`, because that's where this gets installed: ```bash go install github.com/ipinfo/cli/ipinfo@latest @@ -107,12 +103,9 @@ go install github.com/ipinfo/cli/ipinfo@latest ### Using `curl`/`wget` -The pre-built binaries for all platforms are available on GitHub via artifacts -in releases. You need to simply download, unpack and move them to your shell's -binary search path. +The pre-built binaries for all platforms are available on GitHub via artifacts in releases. You need to simply download, unpack and move them to your shell's binary search path -The following OS & arch combinations are supported (if you use one not listed -on here, please open an issue): +The following OS & arch combinations are supported (if you use one not listed on here, please open an issue): ``` darwin_amd64 @@ -155,63 +148,67 @@ sudo mv ipinfo_3.3.1_${PLAT} /usr/local/bin/ipinfo ### Using `git` -Installing from source requires at least the Golang version specified in -`go.mod`. You can install the Golang toolchain from -[the official site](https://golang.org/doc/install). +Installing from source requires at least the Golang version specified in `go.mod`. You can install the Golang toolchain from [the official site](https://golang.org/doc/install) -Once the correct Golang version is installed, simply clone the repository and -install the binary: +Once the correct Golang version is installed, simply clone the repository and install the binary: ```bash -git clone https://github.com/ipinfo/cli ipinfo-cli -cd ipinfo-cli +git init +git pull https://github.com/ipinfo/cli go install ./ipinfo/ $GOPATH/bin/ipinfo ``` -You can add `$GOPATH/bin` to your `$PATH` to access `ipinfo` directly from -anywhere. +You can add `$GOPATH/bin` to your `$PATH` to access `ipinfo` directly from anywhere -Alternatively, you can do the following to output the binary somewhere -specific: +Alternatively, you can do the following to output the binary somewhere specific: ```bash -git clone https://github.com/ipinfo/cli ipinfo-cli -cd ipinfo-cli +git init +git pull https://github.com/ipinfo/cli go build -o ./ipinfo/ ``` -Replace `` with the required location. +Replace `` with the required location, e.g `/usr/bin` (so you do not to have to put it into the `$PATH`) ## Additional CLIs -The `ipinfo` CLI has some subcommands like `grepip`, `grepdomain`, `matchip`, -`prips`, `cidr2range`, `cidr2ip`, `range2cidr`, `range2ip`, `splitcidr`, -`randip` and `mmdb` which are also shipped as standalone binaries. +The `ipinfo` CLI has some subcommands like: +- `grepip` +- `grepdomain` +- `matchip` +- `prips` +- `cidr2range` +- `cidr2ip` +- `range2cidr` +- `range2ip` +- `splitcidr` +- `randip` +- `mmdb` -These binaries are available via all the **same installation methods** as -mentioned above for `ipinfo`, except you must change only the name to the name -of the subcommand, and choose the appropriate version. +This are also shipped as standalone binaries! + +These binaries are available via all the **same installation methods** as mentioned above for `ipinfo`, except you must change only the name to the name of the subcommand, and choose the appropriate version Currently these subcommands are separately shipped: | CLI | Version | -| ---------- | --------------------------------------------------------------------- | -| grepip | [1.2.3](https://github.com/ipinfo/cli/releases/tag/grepip-1.2.3) | +|------------|-----------------------------------------------------------------------| +| cidr2range | [1.2.0](https://github.com/ipinfo/cli/releases/tag/cidr2range-1.2.0) | +| cidr2ip | [1.0.0](https://github.com/ipinfo/cli/releases/tag/cidr2ip-1.0.0) | | grepdomain | [1.0.0](https://github.com/ipinfo/cli/releases/tag/grepdomain-1.0.0) | +| grepip | [1.2.3](https://github.com/ipinfo/cli/releases/tag/grepip-1.2.3) | | matchip | [1.0.0](https://github.com/ipinfo/cli/releases/tag/matchip-1.0.0) | +| mmdb | [1.4.2](https://github.com/ipinfo/mmdbctl/releases/tag/mmdbctl-1.4.2) | | prips | [1.0.0](https://github.com/ipinfo/cli/releases/tag/prips-1.0.0) | -| cidr2range | [1.2.0](https://github.com/ipinfo/cli/releases/tag/cidr2range-1.2.0) | -| cidr2ip | [1.0.0](https://github.com/ipinfo/cli/releases/tag/cidr2ip-1.0.0) | +| randip | [1.1.0](https://github.com/ipinfo/cli/releases/tag/randip-1.1.0) | | range2cidr | [1.3.0](https://github.com/ipinfo/cli/releases/tag/range2cidr-1.3.0) | | range2ip | [1.0.0](https://github.com/ipinfo/cli/releases/tag/range2ip-1.0.0) | -| randip | [1.1.0](https://github.com/ipinfo/cli/releases/tag/randip-1.1.0) | | splitcidr | [1.0.0](https://github.com/ipinfo/cli/releases/tag/splitcidr-1.0.0) | -| mmdb | [1.4.2](https://github.com/ipinfo/mmdbctl/releases/tag/mmdbctl-1.4.2) | ## Quick Start -This will help you quickly get started with the `ipinfo` CLI. +This will help you quickly get started with the `ipinfo` CLI ### Default Help Message @@ -225,10 +222,7 @@ ipinfo ### Login -If you have a token, log in with it first. You can continue without a token, -but there will be limited data output and some features (like bulk lookups) -will not be available. Get your token for free at -[https://ipinfo.io/signup](https://ipinfo.io/signup?ref=cli). +If you have a token, log in with it first. You can continue without a token, but there will be limited data output and some features (like bulk lookups) will not be available. Get your token for free at [https://ipinfo.io/signup](https://ipinfo.io/signup?ref=cli) ```bash ipinfo init @@ -284,8 +278,7 @@ cat ips.txt | ipinfo -f hostname ### Bulk -The above commands implicitly run the `bulk` subcommand on the input. You can -manually specify bulk and input IPs on the command line: +The above commands implicitly run the `bulk` subcommand on the input. You can manually specify bulk and input IPs on the command line: ```bash ipinfo bulk 1.1.1.0/30 8.8.8.0/30 9.9.9.0/30 | less @@ -295,8 +288,7 @@ ipinfo bulk 1.1.1.0/30 8.8.8.0/30 9.9.9.0/30 | less ### Summarize -IP details can be summarized similar to what's provided by -https://ipinfo.io/tools/summarize-ips: +IP details can be summarized similar to what's provided by https://ipinfo.io/tools/summarize-ips: ```bash cat lk-ips.txt | ipinfo summarize @@ -304,8 +296,7 @@ cat lk-ips.txt | ipinfo summarize ![ipinfo summarize](gif/summarize.gif) -There are many more features available, so for full details, consult the `-h` -or `--help` message for each command. For example: +There are many more features available, so for full details, consult the `-h` or `--help` message for each command. For example: ```bash ipinfo 8.8.8.8 --help @@ -321,21 +312,17 @@ zsh fish ``` -NOTE: it may work for other shells as well because the implementation is in -Golang and is not necessarily shell-specific. +NOTE: it may work for other shells as well because the implementation is in Golang and is not necessarily shell-specific ### Installation -Installing auto-completions is as simple as running one command (works for -`bash`, `zsh` and `fish` shells): +Installing auto-completions is as simple as running one command (works for `bash`, `zsh` and `fish` shells): ```bash ipinfo completion install ``` -If you want to customize the installation process (e.g. in case the -auto-installation doesn't work as expected), you can request the actual -completion script for each shell: +If you want to customize the installation process (e.g. in case the auto-installation doesn't work as expected), you can request the actual completion script for each shell: ```bash # get bash completion script @@ -350,36 +337,27 @@ ipinfo completion fish ### Shell not listed? -If your shell is not listed here, you can open an issue. +If your shell is not listed here, you can open an issue -Note that as long as the `COMP_LINE` environment variable is provided to the -binary itself, it will output completion results. So if your shell provides a -way to pass `COMP_LINE` on auto-completion attempts to a binary, then have your -shell do that with the `ipinfo` binary itself (or any of our binaries). +Note that as long as the `COMP_LINE` environment variable is provided to the binary itself, it will output completion results. So if your shell provides a way to pass `COMP_LINE` on auto-completion attempts to a binary, then have your shell do that with the `ipinfo` binary itself (or any of our binaries) ## Data -The amount of data you get back per lookup depends upon how much data you have -enabled on your token via the https://ipinfo.io site. +The amount of data you get back per lookup depends upon how much data you have enabled on your token via the https://ipinfo.io site -If you have an account, see our -[plans](https://ipinfo.io/account/billing/upgrade) and -[addons](https://ipinfo.io/account/addons). +If you have an account, see our [plans](https://ipinfo.io/account/billing/upgrade) and [addons](https://ipinfo.io/account/addons) -All examples in this document use a token with all data enabled. +All examples in this document use a token with all data enabled ## Color Output ### Disabling Color Output -All our CLIs respect either the `--nocolor` flag or the -[`NO_COLOR`](https://no-color.org/) environment variable to disable color -output. +All our CLIs respect either the `--nocolor` flag or the [`NO_COLOR`](https://no-color.org/) environment variable to disable color output ### Color on Windows -To enable color support for the Windows command prompt, run the following to -enable [`Console Virtual Terminal Sequences`](https://docs.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences). +To enable color support for the Windows command prompt, run the following to enable [`Console Virtual Terminal Sequences`](https://docs.microsoft.com/en-us/windows console/console-virtual-terminal-sequences) ```cmd REG ADD HKCU\CONSOLE /f /v VirtualTerminalLevel /t REG_DWORD /d 1 @@ -393,12 +371,12 @@ REG DELETE HKCU\CONSOLE /f /v VirtualTerminalLevel ## Other IPinfo Tools -There are official IPinfo client libraries available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API. +There are official IPinfo client libraries available for many languages including PHP, Python, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API -See [https://ipinfo.io/developers/libraries](https://ipinfo.io/developers/libraries) for more details. +See [Libraries](https://ipinfo.io/developers/libraries) for more details ## About IPinfo -Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers. +Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier, VPN detection, hosted domains, and IP type data sets. Our API handles over 40 billion requests a month for 100,000 businesses and developers -[![image](https://avatars3.githubusercontent.com/u/15721521?s=128&u=7bb7dde5c4991335fb234e68a30971944abc6bf3&v=4)](https://ipinfo.io/) +[![image](https://avatars3.githubusercontent.com/u/15721521?s=128&u=7bb7dde5c4991335fb234e68a30971944abc6bf3&v=4)](https://ipinfo.io/) \ No newline at end of file From 55e797d644787f459e79ec95147c548aeec2bd40 Mon Sep 17 00:00:00 2001 From: Justman100 <149507651+Justman100@users.noreply.github.com> Date: Thu, 10 Jul 2025 13:02:15 +0200 Subject: [PATCH 2/2] Adding build script for all CLIs --- build.sh | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 build.sh diff --git a/build.sh b/build.sh new file mode 100644 index 00000000..fc14e87d --- /dev/null +++ b/build.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +for dir in $(ls); do + [[ -d $dir ]] && [[ -f $dir/dir.go ]] && cd $(pwd)/$dir && go build -o $dir && mv $dir /usr/bin && cd .. +done \ No newline at end of file