Whispers 开源项目使用教程

Whispers 开源项目使用教程

whispersIdentify hardcoded secrets in static structured text项目地址:https://gitcode.com/gh_mirrors/wh/whispers

1. 项目的目录结构及介绍

Whispers 项目的目录结构如下：

whispers/
├── .github/
│   └── workflows/
├── whispers/
│   ├── __init__.py
│   ├── cli.py
│   ├── config.py
│   ├── detectors/
│   │   ├── __init__.py
│   │   ├── aws.py
│   │   ├── azure.py
│   │   └── ...
│   ├── formatters/
│   │   ├── __init__.py
│   │   ├── json.py
│   │   ├── text.py
│   │   └── ...
│   ├── rules/
│   │   ├── __init__.py
│   │   ├── aws.py
│   │   ├── azure.py
│   │   └── ...
│   └── utils.py
├── tests/
│   ├── __init__.py
│   ├── test_cli.py
│   ├── test_config.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• whispers/: 项目的主要代码目录。
  • __init__.py: 初始化文件。
  • cli.py: 命令行接口文件。
  • config.py: 配置文件处理模块。
  • detectors/: 包含各种检测器的实现。
  • formatters/: 包含各种输出格式的实现。
  • rules/: 包含各种规则的实现。
  • utils.py: 工具函数模块。
• tests/: 包含项目的测试代码。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

项目的启动文件是 whispers/cli.py。这个文件定义了命令行接口，用户可以通过命令行运行 Whispers 项目。

启动文件内容概述

• cli.py 文件中定义了命令行参数解析、配置加载、检测器和格式器的调用等逻辑。
• 用户可以通过命令行参数指定要检测的文件或目录、输出格式等。

3. 项目的配置文件介绍

项目的配置文件处理模块是 whispers/config.py。这个模块负责加载和解析配置文件。

配置文件内容概述

• 配置文件通常是一个 YAML 文件，定义了各种检测规则和输出格式。
• config.py 模块中包含了加载配置文件、解析配置文件内容的逻辑。
• 用户可以通过配置文件自定义检测规则和输出格式。

以上是 Whispers 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 Whispers 项目。

whispersIdentify hardcoded secrets in static structured text项目地址:https://gitcode.com/gh_mirrors/wh/whispers