Metadata-Version: 2.1
Name: trufflehog3
Version: 3.0.0rc3
Summary: Find secrets in your codebase
Home-page: https://github.com/feeltheajf/trufflehog3
Author: Ilya Radostev
Author-email: feeltheajf@gmail.com
License: GNU
Description: [![Package Version](https://img.shields.io/pypi/v/trufflehog3.svg)](https://pypi.org/project/trufflehog3)
        ![Python Version](https://img.shields.io/badge/python-3.7-informational.svg)
        [![Downloads](https://pepy.tech/badge/trufflehog3)](https://pepy.tech/project/trufflehog3)
        [![Build Status](https://travis-ci.com/feeltheajf/trufflehog3.svg?branch=master)](https://travis-ci.com/feeltheajf/trufflehog3)
        [![Code Coverage](https://codecov.io/gh/feeltheajf/trufflehog3/branch/master/graph/badge.svg)](https://codecov.io/gh/feeltheajf/trufflehog3)
        
        # trufflehog3
        
        This is an enhanced version of the [truffleHog](https://github.com/dxa4481/truffleHog) scanner
        
        <p align="middle">
          <a href="https://feeltheajf.github.io/trufflehog3/examples/report" target="_blank">
            <img src="https://feeltheajf.github.io/trufflehog3/examples/preview_desktop.png" alt="report preview dekstop" width="80%" />
            <img src="https://feeltheajf.github.io/trufflehog3/examples/preview_mobile.png" alt="report preview mobile" width="19%" />
          </a>
        </p>
        
        ## Usage
        
        Full API documentation is available at <a href="https://feeltheajf.github.io/trufflehog3/" target="_blank">feeltheajf.github.io/trufflehog3</a>.
        
        You can always check available options by running
        
        ```
        trufflehog3 --help
        ```
        
        Here are some basic examples to get you started
        
        ```bash
        # clone remote Git repository, scan 10 latest commits and output to stdout
        $ trufflehog3 --max-depth 10 https://github.com/feeltheajf/trufflehog3
        
        # disable Git history search, scan current directory and save report as JSON
        $ trufflehog3 --no-history --format json --output report.json
        
        # render HTML report from JSON
        $ trufflehog3 -R report.json --output report.html
        ```
        
        ## New
        
        v3 was heavily updated both under the hood and from API perspective. See below for more details on new features.
        
        ### Automatic Config Detection
        
        `.trufflehog3.yml` is automatically detected in the root of the scanned directory. However, you can still specify custom path using `-c/--config` CLI argument. Do not forget to check out the updated [.trufflehog3.yml](.trufflehog3.yml) config file format.
        
        ### HTML Reports
        
        HTML reports are now much prettier and more useful than ever. You can filter out specific rules or paths on the fly without fiddling with raw data. Have a look at a sample <a href="https://feeltheajf.github.io/trufflehog3/examples/report" target="_blank">HTML report</a> and try it on your own.
        
        ### Inline Exclude
        
        Inline `nosecret` comments are now supported for excluding false positives
        
        ```python
        # skip all rules
        password = ""  # nosecret
        
        # only skip rule with specific id
        password = ""  # nosecret: generic.password
        ```
        
        If for some reason you would like to avoid such behavior, there is a new `--ignore-nosecret` CLI flag which will tell trufflehog3 to ignore all inline comments.
        
        ### Incremental Scan
        
        You can now run an incremental scan by specifying the path to the baseline JSON report as `-i/--incremental` CLI argument. In this case, only the new issues compared to the baseline will be reported.
        
        ## Thanks
        
        Special thanks to Dylan Ayrey ([@dxa4481](https://github.com/dxa4481)), developer of the original [truffleHog](https://github.com/dxa4481/truffleHog) scanner
        
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
