Metadata-Version: 2.4
Name: cfsniff
Version: 0.1.3
Summary: Sniff out secrets in arbitrary text using the ClassiFinder API
Author: Thomas Paras
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: classifinder>=0.1.3
Requires-Dist: click>=8.0
Requires-Dist: rich>=13.0
Provides-Extra: clipboard
Requires-Dist: pyperclip>=1.8; extra == 'clipboard'
Provides-Extra: dev
Requires-Dist: httpx>=0.27; extra == 'dev'
Requires-Dist: pyperclip>=1.8; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Description-Content-Type: text/markdown

# cfsniff

A good dog that sniffs out leaked secrets in files, directories, and text — powered by the [ClassiFinder](https://classifinder.ai) API.

## Install

```bash
pipx install cfsniff
```

Or with pip:

```bash
pip install cfsniff
```

## Quick Start

```bash
# 1. Install
pipx install cfsniff

# 2. Set your API key (get one at https://classifinder.ai)
export CLASSIFINDER_API_KEY=cf_live_...

# 3. Sniff something
cfsniff audit
```

## Usage

**Scan a file**
```bash
cfsniff secrets.txt
```

**Scan a directory**
```bash
cfsniff ./src
```

**Pipe text in**
```bash
echo "token=ghp_abc123..." | cfsniff
```

**Scan your clipboard**
```bash
cfsniff --clipboard
```

**Audit current directory**
```bash
cfsniff audit
```

**Audit with extra paths**
```bash
cfsniff audit --include logs
```

**Audit and open an HTML report**
```bash
cfsniff audit --report report.html --open
```

## Output Formats

```bash
cfsniff audit                    # rich (default, color terminal output)
cfsniff audit --format plain     # plain text (CI-friendly)
cfsniff audit --format json      # machine-readable JSON
```

## HTML Reports

The `--report` flag writes a self-contained HTML file with a full findings summary — useful for sharing with teammates or attaching to tickets.

```bash
cfsniff audit --report report.html --open
```

## API Key

Get a free API key at **https://classifinder.ai**.

Set it via environment variable:

```bash
export CLASSIFINDER_API_KEY=cf_live_...
```

## License

MIT
