Skip to content

Commit

Permalink
fileUpdate:Readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
sinspired committed Sep 21, 2024
1 parent 03a6b9a commit 42723e1
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ CloudflareBestIP 采用go编写的小工具。能够自动下载知名的几个i
```bash
git clone https://github.com/sinspired/CloudflareBestIP.git
cd CloudflareBestIP
go build -o BestipTest.exe main.go update.go
go build -o BestipTest.exe main.go
```

这将编译可执行文件 BestipTest.exe。
Expand All @@ -24,6 +24,7 @@ go build -o BestipTest.exe main.go update.go

**CloudflareBestIP** 可以接受以下参数:

* -ip 直接检测ip地址
* -file IP地址文件名称(*.txt或*.zip) (default "txt.zip")
* -outfile 输出文件名称(自动设置) (default "result.csv")
* -port 默认端口 (default 443)
Expand All @@ -34,17 +35,17 @@ go build -o BestipTest.exe main.go update.go
* -speedtest 下载测速协程数量,设为0禁用测速 (default 5)
* -tcplimit TCP最大延迟(ms) (default 1000)
* -httplimit HTTP最大延迟(ms) (default 1000)
* -iplab 为true时检查ip库中的文件并依次下载 (default false)
* -iplib 为true时检查ip库中的文件并依次下载 (default false)
* -mulnum 多协程测速造成测速不准,可进行倍数补偿 (default 1)
* -tls 是否启用TLS (default true)
* -url 测速文件地址 (default "speed.cloudflare.com/__down?bytes=500000000")
* -country 国家代码(US,SG,JP,DE...),以逗号分隔,留空时检测所有
* -not 排除的国家代码(US,SG,JP,DE...)
* -domain 上传地址,默认为空,用Text2KV项目建立的简易文件存储storage.example.com (default "")
* -token 上传地址的token(default "")
* -token 上传地址的Text2KV项目token(default "")
* -api ip信息查询api,免费申请,api.ipapi.is,如留空则使用免费接口 (default "")

命令行键入 `-h` `help` 获取帮助 `./CloudflareBestIP.exe -h`
命令行键入 `-h` `help` 获取帮助 `./BestipTest.exe -h`

# 运行

Expand All @@ -61,16 +62,16 @@ go build -o BestipTest.exe main.go update.go
### 设置参数

```powershell
./BestipTest.exe -tcplimit=300 -httplimit=300 -speedlimit=5 -tls=true -port=443 -iplab=false -max=1000 -speedtest=5 -file="txt.zip" -outfile="result.csv" -num=10 -dlall=false -countries="US,Sg,DE" -not="HK" -domain="" -token="" -api=""
./BestipTest.exe -tcplimit=300 -httplimit=300 -speedlimit=5 -tls=true -port=443 -iplib=false -max=1000 -speedtest=5 -file="txt.zip" -outfile="result.csv" -num=10 -dlall=false -countries="US,Sg,DE" -not="HK" -domain="" -token="" -api=""
```

请替换参数值以符合您的实际需求。

**注意:**

`-domain="x.xxx.com"``-token="password"`,当优选结果>0时会提示是否上传优选ip结果到云端,需要输入域名和token。可以参考<https://github.com/sinspired/CF-Workers-TEXT2KV> 自行搭建文件存储服务
`-domain="x.xxx.com"``-token="password"`,当优选结果 >0 时会提示是否上传优选ip结果到云端,需要输入域名和token。可以参考<https://github.com/sinspired/CF-Workers-TEXT2KV> 自行搭建文件存储服务

`api`请自行申请
`api` 请自行至 <https://ipapi.is/> 申请,用于获取优选IP的ASN信息

**文件格式:**

Expand All @@ -80,6 +81,7 @@ go build -o BestipTest.exe main.go update.go
* `ip:port` 格式的txt文件,程序会识别ip和端口号
* CIDR 格式的ip文件
* 如果是从FOFA等网站下载的文件,可以把文件名设置为`ASN-Tls-PORT.txt`,把多个文件打包成一个`zip`文件,程序可以直接识别解压,然后根据文件名的tls状态和端口号检测。Tls 的值为0或1,对应false/true。
* 使用参数 `-ip=""` 检测 `ip``ip:port` 格式的ip,多个IP使用 `,` 分割

**命名规范:**

Expand All @@ -90,7 +92,7 @@ go build -o BestipTest.exe main.go update.go

**输出结果:**

优化了命令行界面输出,可以直观查看程序执行情况,最终会把优选ip结果存入 `result_"源文件名".csv` 中。
优化了命令行界面输出,可以直观查看程序执行情况,优选ip结果存入 `result_"源文件名".csv` 中。

# 最新发行版下载

Expand Down

0 comments on commit 42723e1

Please sign in to comment.