Welcome to CredSweeper’s documentation!

CredSweeper is a tool to detect credentials in any directories or files. CredSweeper could help users to detect unwanted exposure of credentials (such as personal information, token, passwords, api keys and etc) in advance. By scanning lines, filtering, and using AI model as option, CredSweeper reports lines with possible credentials, where the line is, and expected type of the credential as a result.

How To Use

• How To Use
  • Run
  • Use as a python library
  • Configurations

Installation

• Installation
  • Via pip
  • Via git clone (dev install)
  • Pre-commit git hook

Develop

• Develop
  • Tests
  • Benchmark

How to Contribute

• Contributing
  • Process for contributing
  • DOs and DON’Ts

Overall architecture

• Overall Architecture
  • Pre-processing
  • Scan
  • Rule
  • Filter
  • ML validation

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

• API
  • Credsweeper package
  • credsweeper.common package
  • credsweeper.config package
  • credsweeper.credentials package
  • credsweeper.deep_scanner package
  • credsweeper.file_handler package
  • credsweeper.filters.group package
  • credsweeper.filters package
  • credsweeper.logger package
  • credsweeper.ml_model package
  • credsweeper.rules package
  • credsweeper.scanner package
  • credsweeper.scanner.scan_type package
  • credsweeper.utils package
  • credsweeper.validations package

Indices and tables

• Index

• Module Index

• Search Page