1. 修改输入参数支持类库

2. 修改配置文件配置方式
3. 添加其他三方库支持
4. 添加banner输出
5. 修改git全局代理为临时代理
6. 修改常见问题的特定输出
7. 修复git以及github api代理问题

Author: kelvinBen

README.md

@@ -2,24 +2,26 @@
 
 ## AutoRedTools
 
-AutoRedTools是一款轻量级一站式自动下载/自动更新安全从业人员常用开源工具的工具，帮助安全从业者快速进行渗透工具的下载以及更新，节约大量环境安装和更新时间。
+AutoRedTools是一款轻量级一站式自动下载/自动更新常用开源软件的工具，主要帮助安全从业者/安全开发人员快速进行环境搭建以及常用软件的更新，节约软件的更新或者安
+的时间，提升生产或工作效率。
 
 (注：本工具使用GitHub API能力，需要配置GitHub Token，未配置GitHub Token会被GitHub限制IP访问)
 
 ## 前言
 
 - 本项目的开发者目前为个人开发者同时有自己的工作，新的功能或者需求会在闲暇时间进行开发，BUG会优先进行处理。
-- 如果在使用中遇到问题或者有新的需求，请在提交BUG反馈，提交BUG前请先阅读最后的"常见问题"。
+- 如果在使用中遇到问题或者有新的需求，请提交issus进行反馈，提交issus前请先阅读文后的"常见问题"。
 - 如果您觉得这个项目对您有用，请点击本项目右上角的"star"按钮。
 - 如果您想持续跟进新的版本情况，请点击本项目右上角的"Watch"按钮。
-- 如果您想参与本项目的开发，请点击本项目右上角的"Fork"按钮,否则请勿点击"Fork"按钮。
+- 如果您想参与本项目的开发，请点击本项目右上角的"Fork"按钮，否则请勿点击"Fork"按钮。
 
 ## 免责声明
 
 请勿将本项目技术或代码应用在恶意软件制作、软件著作权/知识产权盗取或不当牟利等非法用途中。实施上述行为或利用本项目对非自己著作权所有的程序进行数据嗅探将涉嫌违反《中华人民共和国刑法》第二百一十七条、第二百八十六条，《中华人民共和国网络安全法》《中华人民共和国计算机软件保护条例》等法律规定。本项目提及的技术仅可用于私人学习测试等合法场景中，任何不当利用该技术所造成的刑事、民事责任均与本项目作者无关。
 
 ## 适用场景
 
+- 开发环境需要重装时
 - 渗透测试环境重装时
 - CTF比赛前需要环境安装时
 - 攻防比赛时特定系统的环境安装
@@ -36,34 +38,24 @@ AutoRedTools是一款轻量级一站式自动下载/自动更新安全从业人
 
 ```bash
     git clone https://github.com/kelvinBen/AutoRedTools
+    cd AutoRedTools
+    python -m pip install -r requirements.txt
     python app.py -o ~/Documents/tools
 ```
 
 ### 参数说明（app.py）
 
 ```TXT
-    -o 指定工具安装路径
-    -p 指定代理，用于加速工具下载
-    -t 设置GitHub Token，未登录GitHub时，每小时只能请求60次，可能会导致部分工具下载失败，建议配置
-```
-
-### 配置文件（config.py）
-
-```python
-    # 本工具基于GitHub API，未配置GitHub Token会被GitHub限制，导致部分软件下载失败
-    # 配置GitHub Token
-    # 配置方法：https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
-    github_token=None
-
-    # 配置代理, 由于某些原因GitHub访问速度较慢，配置代理用于加速GitHub的访问
-    proxy=None
+    -o 指定需要安装的软件的目录，必填项
+    -p 指定代理地址，用于加速GitHub下载效率，支持http/https/sockt5模式，配置全局代理可忽略
+    -t 指定GitHub Token，未登录GitHub时，每小时只能请求60次，可能会导致部分工具下载失败，建议配置
 ```
 
 ### 其他使用方法
 
 ```TXT
     1. 设置GitHub Token
-    python app.py -o ~/Documents/tools -t xxxxxxxxx
+    python app.py -o ~/Documents/tools -t "xxxxxxxxx"
 
     2. 使用http代理的方式启动
     python app.py -o ~/Documents/tools -p http://127.0.0.1:7890
@@ -73,6 +65,29 @@ AutoRedTools是一款轻量级一站式自动下载/自动更新安全从业人
 
     4. 使用socks5代理的方式启动
     python app.py -o ~/Documents/tools -p socks5://127.0.0.1:7890
+    
+```
+
+### 配置文件（~/Documents/AutoRedTools/config.yml）
+
+```yml
+    # 请修改用户目录下的~/Documents/AuoRedTools/config.yml文件，修改脚本下的config.yml文件无效。
+
+    # AutoRedTools基于GitHub API，未配置github_token会被GitHub限制速率，会导致部分软件下载失败!!!
+    # 注意：yaml配置文件要求，所有的“:”后面都需要跟随一个空格
+    # 此配置文件优先级低于命令行配置
+
+    # 配置GitHub Token，如不设置请留空
+    # 配置方法：https://docs.github.com/cn/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token
+    github_token: 
+
+    # 配置三方代理, 由于某些原因GitHub访问速度较慢，配置代理用于加速GitHub的访问，如不设置请留空
+    # 目前支持ghproxy/http/https/socks5
+        # ghproxy配置方法: proxy: https://ghproxy.com/
+        # http配置方法: proxy: http://127.0.0.1:7890/
+        # https配置方法: proxy: https://127.0.0.1:7890/
+        # socks5配置方法: proxy: socks5://127.0.0.1:7890/
+    proxy: 
 ```
 
 ## 已支持工具列表
@@ -124,7 +139,7 @@ AutoRedTools是一款轻量级一站式自动下载/自动更新安全从业人
 - [x] AntSword
 - [x] AntSword-Loader
 
-## 自定义工具列表(tools.json)
+## 自定义工具列表(~/Documents/AutoRedTools/tools.json)
 
 tools.json 为常用开源软件的下载配置文件。
 
@@ -177,11 +192,36 @@ platform: 为需要下载的系统平台，当type为source时需要为{}
 
 ![效果展示](%E6%95%88%E6%9E%9C%E5%B1%95%E7%A4%BA.png)
 
+## 常见问题
+
+```TXT
+问题1: fatal: unable to access 'https://github.com/xxxxx': LibreSSL SSL_connect: SSL_ERROR_SYSCALL in connection to github.com:443 
+解决：使用v2ray/ssr等代理工具的全局代理模式，或者使用-p参数添加代理或者修改~/Documents/AutoRedTools/config.yml文件中的proxy参数
+
+问题2：fatal: unable to access 'https://github.com/xxxxx': LibreSSL SSL_read: error:xxxxx:system library:func(4095):Operation timed out, errno 60
+解决：使用v2ray/ssr等代理工具的全局代理模式，或者使用-p参数添加代理或者修改~/Documents/AutoRedTools/config.yml文件中的proxy参数
+
+问题3：error: RPC failed; curl 56 LibreSSL SSL_read: error:02FFF03C:system library:func(4095):Operation timed out, errno 60
+解决：使用v2ray/ssr等代理工具的全局代理模式，或者使用-p参数添加代理或者修改~/Documents/AutoRedTools/config.yml文件中的proxy参数
+
+问题4：fatal: unable to access 'https://github.com/xxxxx': Could not resolve proxy: None
+解决：
+1. 编辑~/.gitconfig文件
+2. 删除http.proxy,https.proxy,http.https://github.com.proxy,https.https://github.com.proxy相关的配置信息
+3. 保存即可
+
+问题5：下载失败或者各种报错
+解决： 开启全局代理模式解决各种错误
+
+问题6：其他问题
+解决: 提交issus或者添加微信群进行问题反馈
+```
+
 ## 联系作者
 
 微信：bromomo (添加好友请备注：ART)
 微信群：(如过期请通过以上方式添加微信)
-![加群](%E5%8A%A0%E7%BE%A4.jpeg)
+![加群](WechatIMG274.jpeg)
 
 需求提交、BUG反馈、软件新增、分类建议均可添加好友或者入群交流。
 

UPDATE.md

@@ -0,0 +1,18 @@
+## V1.0.2
+
+1. 修改输入参数支持类库
+2. 修改配置文件配置方式
+3. 添加其他三方库支持
+4. 添加banner输出
+5. 修改git全局代理为临时代理
+6. 修改常见问题的特定输出
+7. 修复git以及github api代理问题
+
+## V1.0.1
+
+1. 添加ghproxy代理支持
+2. 修复文件下载编码问题
+
+## V1.0.0
+
+1. 基础版本能够自动下载以及自动更新