mirror of
https://github.com/zu1k/nali.git
synced 2025-01-22 21:29:02 +08:00
faf39c246f
Signed-off-by: zu1k <i@zu1k.com>
334 lines
8.1 KiB
Markdown
334 lines
8.1 KiB
Markdown
<h1 align="center">
|
||
<br>Nali<br>
|
||
</h1>
|
||
|
||
<h4 align="center">An offline tool for querying IP geographic information and CDN provider.</h4>
|
||
|
||
<p align="center">
|
||
<a href="https://github.com/zu1k/nali/actions">
|
||
<img src="https://img.shields.io/github/workflow/status/zu1k/nali/Go?style=flat-square" alt="Github Actions">
|
||
</a>
|
||
<a href="https://goreportcard.com/report/github.com/zu1k/nali">
|
||
<img src="https://goreportcard.com/badge/github.com/zu1k/nali?style=flat-square">
|
||
</a>
|
||
<a href="https://github.com/zu1k/nali/releases">
|
||
<img src="https://img.shields.io/github/release/zu1k/nali/all.svg?style=flat-square">
|
||
</a>
|
||
</p>
|
||
|
||
#### [中文文档](https://github.com/zu1k/nali/blob/master/README.md)
|
||
|
||
## Feature
|
||
|
||
- Multi database support
|
||
- Chunzhen qqip database
|
||
- ZX ipv6 database
|
||
- Geoip2 city database
|
||
- IPIP free database
|
||
- ip2region database
|
||
- db-ip database
|
||
- IP2Location DB3 LITE database
|
||
- Pipeline support
|
||
- Interactive query
|
||
- Offline query
|
||
- Both ipv4 and ipv6 supported
|
||
- Multilingual support
|
||
- CDN provider query
|
||
- Full platform support
|
||
- Color print
|
||
|
||
## Install
|
||
|
||
### Install from source
|
||
|
||
Nali Requires Go >= 1.18. You can build it from source:
|
||
|
||
```sh
|
||
$ go install github.com/zu1k/nali@latest
|
||
```
|
||
|
||
### Install pre-build binariy
|
||
|
||
Pre-built binaries are available here: [release](https://github.com/zu1k/nali/releases)
|
||
|
||
Download the binary compatible with your platform, unpack and copy to the directory in path
|
||
|
||
### Arch Linux
|
||
|
||
We have published 3 package in Aur:
|
||
|
||
- `nali-go`: release version, compile when installing
|
||
- `nali-go-bin`: release version, pre-compiled binary
|
||
- `nali-go-git`: the latest master branch version, compile when installing
|
||
|
||
## Usage
|
||
|
||
### Query a simple IP address
|
||
|
||
```
|
||
$ nali 1.2.3.4
|
||
1.2.3.4 [澳大利亚 APNIC Debogon-prefix网络]
|
||
```
|
||
|
||
#### or use `pipe`
|
||
|
||
```
|
||
$ echo IP 6.6.6.6 | nali
|
||
IP 6.6.6.6 [美国 亚利桑那州华楚卡堡市美国国防部网络中心]
|
||
```
|
||
|
||
### Query multiple IP addresses
|
||
|
||
```
|
||
$ nali 1.2.3.4 4.3.2.1 123.23.3.0
|
||
1.2.3.4 [澳大利亚 APNIC Debogon-prefix网络]
|
||
4.3.2.1 [美国 新泽西州纽瓦克市Level3Communications]
|
||
123.23.3.0 [越南 越南邮电集团公司]
|
||
```
|
||
|
||
### Interactive query
|
||
|
||
use `exit` or `quit` to quit
|
||
|
||
```
|
||
$ nali
|
||
123.23.23.23
|
||
123.23.23.23 [越南 越南邮电集团公司]
|
||
1.0.0.1
|
||
1.0.0.1 [美国 APNIC&CloudFlare公共DNS服务器]
|
||
8.8.8.8
|
||
8.8.8.8 [美国 加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器]
|
||
quit
|
||
```
|
||
|
||
### Use with dig
|
||
|
||
```
|
||
$ dig nali.zu1k.com +short | nali
|
||
104.28.2.115 [美国 CloudFlare公司CDN节点]
|
||
104.28.3.115 [美国 CloudFlare公司CDN节点]
|
||
172.67.135.48 [美国 CloudFlare节点]
|
||
```
|
||
|
||
### Use with nslookup
|
||
|
||
```
|
||
$ nslookup nali.zu1k.com 8.8.8.8 | nali
|
||
Server: 8.8.8.8 [美国 加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器]
|
||
Address: 8.8.8.8 [美国 加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器]#53
|
||
|
||
Non-authoritative answer:
|
||
Name: nali.zu1k.com
|
||
Address: 104.28.3.115 [美国 CloudFlare公司CDN节点]
|
||
Name: nali.zu1k.com
|
||
Address: 104.28.2.115 [美国 CloudFlare公司CDN节点]
|
||
Name: nali.zu1k.com
|
||
Address: 172.67.135.48 [美国 CloudFlare节点]
|
||
```
|
||
|
||
### Use with any other program
|
||
|
||
Because nali can read the contents of the `stdin` pipeline, it can be used with any program
|
||
|
||
```
|
||
bash abc.sh | nali
|
||
```
|
||
|
||
Nali will insert ip information after ip
|
||
|
||
### IPV6 support
|
||
|
||
Use like ipv4
|
||
|
||
```
|
||
$ nslookup google.com | nali
|
||
Server: 127.0.0.53 [局域网 IP]
|
||
Address: 127.0.0.53 [局域网 IP]#53
|
||
|
||
Non-authoritative answer:
|
||
Name: google.com
|
||
Address: 216.58.211.110 [美国 Google全球边缘网络]
|
||
Name: google.com
|
||
Address: 2a00:1450:400e:809::200e [荷兰Amsterdam Google Inc. 服务器网段]
|
||
```
|
||
|
||
### Query CDN provider
|
||
|
||
```
|
||
$ nslookup www.gov.cn | nali
|
||
Server: 127.0.0.53 [局域网 IP]
|
||
Address: 127.0.0.53 [局域网 IP]#53
|
||
|
||
Non-authoritative answer:
|
||
www.gov.cn canonical name = www.gov.cn.bsgslb.cn [白山云 CDN].
|
||
www.gov.cn.bsgslb.cn [白山云 CDN] canonical name = zgovweb.v.bsgslb.cn [白山云 CDN].
|
||
Name: zgovweb.v.bsgslb.cn [白山云 CDN]
|
||
Address: 103.104.170.25 [新加坡 ]
|
||
Name: zgovweb.v.bsgslb.cn [白山云 CDN]
|
||
Address: 2001:428:6402:21b::5 [美国Louisiana州Monroe Qwest Communications Company, LLC (CenturyLink)]
|
||
Name: zgovweb.v.bsgslb.cn [白山云 CDN]
|
||
Address: 2001:428:6402:21b::6 [美国Louisiana州Monroe Qwest Communications Company, LLC (CenturyLink)]
|
||
```
|
||
|
||
## Interface
|
||
|
||
After nali runs for the first time, a configuration file `config.yaml` will be generated in the working directory (default `~/.nali/config.yaml`), the configuration file defines the database information.
|
||
|
||
A database is defined as the follows:
|
||
|
||
```yaml
|
||
- name: geoip
|
||
name-alias:
|
||
- geolite
|
||
- geolite2
|
||
format: mmdb
|
||
file: GeoLite2-City.mmdb
|
||
languages:
|
||
- ALL
|
||
types:
|
||
- IPv4
|
||
- IPv6
|
||
```
|
||
|
||
### Help
|
||
|
||
```
|
||
$ nali --help
|
||
Usage:
|
||
nali [flags]
|
||
nali [command]
|
||
|
||
Available Commands:
|
||
completion generate the autocompletion script for the specified shell
|
||
help Help about any command
|
||
update update chunzhen ip database
|
||
|
||
Flags:
|
||
--gbk Use GBK decoder
|
||
-h, --help help for nali
|
||
|
||
Use "nali [command] --help" for more information about a command.
|
||
```
|
||
|
||
### Update database
|
||
|
||
Update all databases if avaliable:
|
||
|
||
```
|
||
$ nali update
|
||
2020/07/17 12:53:46 正在下载最新纯真 IP 库...
|
||
2020/07/17 12:54:05 已将最新的纯真 IP 库保存到本地 /root/.nali/qqwry.dat
|
||
```
|
||
|
||
Updata selected databases:
|
||
|
||
```
|
||
$ nali update --db qqwry,cdn
|
||
2020/07/17 12:53:46 正在下载最新纯真 IP 库...
|
||
2020/07/17 12:54:05 已将最新的纯真 IP 库保存到本地 /root/.nali/qqwry.dat
|
||
```
|
||
|
||
### Select database
|
||
|
||
Users can specify which database to use, set environment variables `NALI_DB_IP4`, `NALI_DB_IP6` or both.
|
||
|
||
supported database:
|
||
|
||
- Geoip2 `['geoip', 'geoip2']`
|
||
- Chunzhen `['chunzhen', 'qqwry']`
|
||
- IPIP `['ipip']`
|
||
- Ip2Region `['ip2region', 'i2r']`
|
||
- DBIP `['dbip', 'db-ip']`
|
||
- IP2Location `['ip2location']`
|
||
|
||
#### Windows
|
||
|
||
##### Use geoip db
|
||
|
||
```
|
||
set NALI_DB_IP4=geoip
|
||
|
||
or use powershell
|
||
|
||
$env:NALI_DB_IP4="geoip"
|
||
```
|
||
|
||
##### Use ipip db
|
||
|
||
```
|
||
set NALI_DB_IP6=ipip
|
||
|
||
or use powershell
|
||
|
||
$env:NALI_DB_IP6="ipip"
|
||
```
|
||
|
||
#### Linux
|
||
|
||
##### Use geoip db
|
||
|
||
```
|
||
export NALI_DB_IP4=geoip
|
||
```
|
||
|
||
##### Use ipip db
|
||
|
||
```
|
||
export NALI_DB_IP6=ipip
|
||
```
|
||
|
||
### Multilingual support
|
||
|
||
Specify the language to be used by modifying the environment variable `NALI_LANG`, when using a non-Chinese language only the GeoIP2 database is supported
|
||
|
||
The values that can be set for this parameter can be found in the list of supported databases for GeoIP2
|
||
|
||
```
|
||
# NALI_LANG=en nali 1.1.1.1
|
||
1.1.1.1 [Australia]
|
||
```
|
||
|
||
### Change database directory
|
||
|
||
If the database directory is not specified, the database will be placed in `~/.nali`
|
||
|
||
Set environment variables `NALI_HOME` to specify the working directory
|
||
|
||
```
|
||
set NALI_HOME=D:\nalidb
|
||
|
||
or
|
||
|
||
export NALI_HOME=/home/nali
|
||
```
|
||
|
||
## Thanks
|
||
|
||
- [纯真QQIP离线数据库](http://www.cz88.net)
|
||
- [qqwry纯真数据库解析](https://github.com/yinheli/qqwry)
|
||
- [ZX公网ipv6数据库](https://ip.zxinc.org/ipquery/)
|
||
- [Geoip2 city数据库](https://www.maxmind.com/en/geoip2-precision-city-service)
|
||
- [geoip2-golang解析器](https://github.com/oschwald/geoip2-golang)
|
||
- [CDN provider数据库](https://github.com/SukkaLab/cdn)
|
||
- [IPIP数据库](https://www.ipip.net/product/ip.html)
|
||
- [IPIP数据库解析](https://github.com/ipipdotnet/ipdb-go)
|
||
- [ip2region数据库](https://github.com/lionsoul2014/ip2region)
|
||
- [IP2Location DB3 LITE](https://lite.ip2location.com/database/db3-ip-country-region-city) *use the IPv6 BIN as it contains both IPv4 & IPv6*
|
||
- [Cobra CLI库](https://github.com/spf13/cobra)
|
||
|
||
Thanks to JetBrains for the Open Source License
|
||
|
||
<a href="https://www.jetbrains.com/?from=nali">
|
||
<img src="assets/GoLand.svg">
|
||
</a>
|
||
|
||
## Author
|
||
|
||
**Nali** © [zu1k](https://github.com/zu1k), Released under the [MIT](./LICENSE) License.<br>
|
||
|
||
> Blog [zu1k.com](https://zu1k.com) · GitHub [@zu1k](https://github.com/zu1k) · Twitter [@zu1k_lv](https://twitter.com/zu1k_lv) · Telegram Channel [@peekfun](https://t.me/peekfun)
|
||
|
||
|
||
## Stargazers over time
|
||
|
||
[![Stargazers over time](https://starchart.cc/zu1k/nali.svg)](https://starchart.cc/zu1k/nali) |