From 62f5dcf081d6cf34a126f08ce678bdd4a983858c Mon Sep 17 00:00:00 2001 From: zu1k Date: Fri, 17 Jul 2020 13:24:05 +0800 Subject: [PATCH] update readme --- README.md | 134 ++++++++++++++++++++++++++++++++++++++++++++++++++-- cmd/root.go | 4 -- 2 files changed, 131 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8e208d6..6b5340d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@

-
nali
+
Nali

-

Something

+

An offline tool for querying IP geographic information.

@@ -16,14 +16,142 @@

+## Feature + +- Chunzhen qqip database +- Geoip2 city database +- Pipeline support +- Interactive query +- Offline query + ## Install -he Requires Go >= 1.14. You can build it from source: +### Install from source + +Nali Requires Go >= 1.14. You can build it from source: ```sh $ go get -u -v github.com/zu1k/nali ``` +### 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 + +### Install from docker + +``` +docker pull docker.pkg.github.com//zu1k/nali/nali:v0.0.2 +``` + ## 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.lgf.im +short | nali +104.28.2.115 [美国 CloudFlare公司CDN节点] +104.28.3.115 [美国 CloudFlare公司CDN节点] +172.67.135.48 [美国 CloudFlare节点] +``` + +#### Use with 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节点] +``` + +#### 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 + +## Interface + +#### Help + +``` +$ nali --help +Usage: + nali [flags] + nali [command] + +Available Commands: + 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. +``` + +#### Update chunzhen IP database + +``` +$ nali update +2020/07/17 12:53:46 正在下载最新纯真 IP 库... +2020/07/17 12:54:05 已将最新的纯真 IP 库保存到本地 /root/.nali/qqwry.dat +``` + +## License + +MIT + diff --git a/cmd/root.go b/cmd/root.go index 7c9db9d..fe4530a 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -42,7 +42,3 @@ func Execute() { os.Exit(1) } } - -func init() { - rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle") -}