docs: update report manual (#266)

chaitin · Sep 1, 2023 · 18b392c · 18b392c
1 parent 825e339
commit 18b392c
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 1 deletion.
diff --git a/README.en.md b/README.en.md
@@ -58,6 +58,16 @@ wget -q https://download.veinmind.tech/scripts/veinmind-runner-parallel-containe
 > Note: When using openAI, please ensure that the current network can access openAI
 > When starting a parallel container, you need to manually use docker run -e http_proxy=xxxx -e https_proxy=xxxx Set proxy (in non global proxy scenarios)
 
+
+### 6. generate <html> <cli> <json> report
+
+```
+./run.sh scan [image/container] --format=html,cli
+```
+
+> this will generate a file at path which name `report.html` or `report.json`
+> you can use `,` to generate different reports，like `--format=html,cli,json` will output both  `report.html` and `report.json` and cli table。
+
 ## 🔨 Toolset
 
 | Tool                                                                      | Description                                            | 

diff --git a/README.md b/README.md
@@ -17,36 +17,57 @@
 <p align="center"> 中文文档 | <a href="README.en.md">English</a> </p>
 
 ## 🔥 Demo
+
 ![](https://veinmind-cache.oss-cn-hangzhou.aliyuncs.com/img/scan.gif)
 
 问脉已接入 openai, 可以使用 openai 对扫描的结果进行人性化分析，让您更加清晰的了解本次扫描发现了哪些风险。
 
 ![](https://veinmind-cache.oss-cn-hangzhou.aliyuncs.com/img/ai.png)
 
 ## 🕹️ 快速开始
+
 ### 1. 确保机器上正确安装 docker
+
 ```
 docker info
 ```
+
 ### 2. 安装 [veinmind-runner](https://github.com/chaitin/veinmind-tools/tree/master/veinmind-runner) 镜像
+
 ```
 docker pull registry.veinmind.tech/veinmind/veinmind-runner:latest
 ```
+
 ### 3. 下载 [veinmind-runner](https://github.com/chaitin/veinmind-tools/tree/master/veinmind-runner) 平行容器启动脚本
+
 ```
 wget -q https://download.veinmind.tech/scripts/veinmind-runner-parallel-container-run.sh -O run.sh && chmod +x run.sh
 ```
+
 ### 4. 快速扫描本地镜像/容器
+
 ```
 ./run.sh scan [image/container]
 ```
+
 ### 5. 使用 openAI 智能分析
+
 ```
 ./run.sh scan [image/container] --enable-analyze --openai-token  <your_openai_token>
 ```
+
 > 注: 使用 openAI 时，请确保当前网络能够访问openAI
 > 平行容器启动时，需要手动通过 docker run -e http_proxy=xxxx -e https_proxy=xxxx 设置代理（非全局代理的场景下）
 
+### 6. 生成 <html> <cli> <json> 报告
+
+```
+./run.sh scan [image/container] --format=html,cli
+```
+
+> 报告将在当前目录下生成一个`report.html`或`report.json`
+> 可以通过`,`来传入多个报告格式，如`--format=html,cli,json`将输出三份不同的报告。
+
 ## 🔨 工具列表
 
 | 工具                                                                        | 功能                | 
@@ -71,9 +92,10 @@ PS: 目前所有工具均已支持平行容器的方式运行
 
 ## 🧑‍💻 编写插件
 
-可以通过 example 快速创建一个 veinmind-tools 插件, 具体查看 [veinmind-example](example/)  
+可以通过 example 快速创建一个 veinmind-tools 插件, 具体查看 [veinmind-example](example/)
 
 ## ☁️ 云原生设施兼容性
+
 | 名称                                                          | 类别    | 是否兼容 |
 |-------------------------------------------------------------|-------|------|
 | [Jenkins](https://github.com/chaitin/veinmind-jenkins)      | CI/CD | ✔️   |
@@ -87,20 +109,24 @@ PS: 目前所有工具均已支持平行容器的方式运行
 | Kubernetes                                                  | 集群    | ✔️   |
 
 ## 🛴 工作原理
+
 ![](docs/architecture.png)
 
 ## 🏘️ 联系我们
+
 1. 您可以通过 GitHub Issue 直接进行 Bug 反馈和功能建议。
 2. 扫描下方二维码可以通过添加问脉小助手，以加入问脉用户讨论群进行详细讨论
 
 ![](docs/veinmind-group-qrcode.jpg)
 
 ## ✨ CTStack
+
 <img src="https://ctstack-oss.oss-cn-beijing.aliyuncs.com/CT%20Stack-2.png" width="30%" />
 
 veinmind-tools 现已加入 [CTStack](https://stack.chaitin.com/tool/detail?id=3) 社区
 
 ## ✨ 404星链计划
+
 <img src="https://github.com/knownsec/404StarLink-Project/raw/master/logo.png" width="30%">
 
 veinmind-tools 现已加入 [404星链计划](https://github.com/knownsec/404StarLink)