add zh doc

This commit is contained in:
zu1k 2020-07-19 07:59:42 +08:00
parent 69c33c9fdb
commit a74c9c72c4
2 changed files with 265 additions and 0 deletions

View File

@ -16,6 +16,8 @@
</a>
</p>
#### [中文文档](https://github.com/zu1k/nali/blob/master/README_sh-CN.md)
## Feature
- Chunzhen qqip database

263
README_zh-CN.md Normal file
View File

@ -0,0 +1,263 @@
<h1 align="center">
<br>Nali<br>
</h1>
<h4 align="center">一个查询IP地理信息和CDN提供商的离线终端工具.</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>
## 功能
- 纯真 IPv4 离线数据库
- ZX IPv6 离线数据库
- Geoip2 城市数据库 (可选)
- CDN 服务提供商查询
- 支持管道处理
- 支持交互式查询
- 同时支持IPv4和IPv6
- 查询完全离线
## 安装
### 从源码安装
Nali 需要预先安装 Go. 安装后可以从源码安装软件:
```sh
$ go get -u -v github.com/zu1k/nali
```
### 下载预编译的可执行程序
可以从Release页面下载预编译好的可执行程序: [Release](https://github.com/zu1k/nali/releases)
你需要选择适合你系统和硬件架构的版本下载,解压后可直接运行
### 使用 Docker 版本
```
docker pull docker.pkg.github.com//zu1k/nali/nali:latest
```
## 使用说明
### 查询一个IP的地理信息
```
$ nali 1.2.3.4
1.2.3.4 [澳大利亚 APNIC Debogon-prefix网络]
```
#### 或者 使用 `管道`
```
$ echo IP 6.6.6.6 | nali
IP 6.6.6.6 [美国 亚利桑那州华楚卡堡市美国国防部网络中心]
```
### 同时查询多个IP的地理信息
```
$ 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 [越南 越南邮电集团公司]
```
### 交互式查询
使用 `exit``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
```
### 与 `dig` 命令配合使用
需要你系统中已经安装好 dig 程序
```
$ dig nali.lgf.im +short | nali
104.28.2.115 [美国 CloudFlare公司CDN节点]
104.28.3.115 [美国 CloudFlare公司CDN节点]
172.67.135.48 [美国 CloudFlare节点]
```
### 与 `nslookup` 命令配合使用
需要你系统中已经安装好 nslookup 程序
```
$ nslookup nali.lgf.im 8.8.8.8 | nali
Server: 8.8.8.8 [美国 加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器]
Address: 8.8.8.8 [美国 加利福尼亚州圣克拉拉县山景市谷歌公司DNS服务器]#53
Non-authoritative answer:
Name: nali.lgf.im
Address: 104.28.3.115 [美国 CloudFlare公司CDN节点]
Name: nali.lgf.im
Address: 104.28.2.115 [美国 CloudFlare公司CDN节点]
Name: nali.lgf.im
Address: 172.67.135.48 [美国 CloudFlare节点]
```
### 与任意程序配合使用
因为 nali 支持管道处理,所以可以和任意程序配合使用
```
bash abc.sh | nali
```
Nali 将在 IP后面插入IP地理信息CDN域名后面插入CDN服务提供商信息
### 支持IPv6
和 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. 服务器网段]
```
### 查询 CDN 服务提供商
因为 CDN 服务通常使用 CNAME 的域名解析方式,所以推荐与 `nslookup` 或者 `dig` 配合使用,在已经知道 CNAME 后可单独使用
#### 只查询 CDN 服务提供商
```
$ nslookup www.gov.cn | nali cdn
Server: 127.0.0.53
Address: 127.0.0.53#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: 185.232.56.148
Name: zgovweb.v.bsgslb.cn [白山云 CDN]
Address: 185.232.56.147
Name: zgovweb.v.bsgslb.cn [白山云 CDN]
Address: 2001:428:6402:21b::6
Name: zgovweb.v.bsgslb.cn [白山云 CDN]
Address: 2001:428:6402:21b::5
```
#### 查询所有信息
```
$ 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)]
```
#### 单独使用
需要提前查询到 CNAME 域名
```
$ nali cdn cdn.somecdncname.com
```
## 用户交互
### 查看帮助
```
$ nali --help
Usage:
nali [flags]
nali [command]
Available Commands:
cdn Query cdn service provider
help Help about any command
parse Query IP information
update update chunzhen ip database
Flags:
-h, --help help for nali
-t, --toggle Help message for toggle
Use "nali [command] --help" for more information about a command.
```
### 更新纯真数据库
```
$ nali update
2020/07/17 12:53:46 正在下载最新纯真 IP 库...
2020/07/17 12:54:05 已将最新的纯真 IP 库保存到本地 /root/.nali/qqwry.dat
```
### 使用 Geoip2 数据库
需要设置环境变量: `NALI_DB`
支持的变量内容:
- Geoip2 `['geoip', 'geoip2', 'geo']`
- Chunzhen `['chunzhen', 'qqip', 'qqwry']`
#### Windows平台
```
set NALI_DB=geoip
```
#### Linux平台
```
export NALI_DB=geoip
```
## 感谢列表
- [纯真QQIP离线数据库](http://www.cz88.net/fox/ipdat.shtml)
- [qqwry mirror](https://qqwry.mirror.noc.one/)
- [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)
- [Cobra CLI库](https://github.com/spf13/cobra)
- [Nali-cli](https://github.com/SukkaW/nali-cli)
## 开源证书
MIT