Skip to main content

Sniff out secrets in arbitrary text using the ClassiFinder API

Project description

cfsniff

A good dog that sniffs out leaked secrets in files, directories, and text — powered by the ClassiFinder API.

Install

pipx install cfsniff

Or with pip:

pip install cfsniff

Quick Start

# 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

cfsniff secrets.txt

Scan a directory

cfsniff ./src

Pipe text in

echo "token=ghp_abc123..." | cfsniff

Scan your clipboard

cfsniff --clipboard

Audit current directory

cfsniff audit

Audit with extra paths

cfsniff audit --include logs

Audit and open an HTML report

cfsniff audit --report report.html --open

Output Formats

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.

cfsniff audit --report report.html --open

API Key

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

Set it via environment variable:

export CLASSIFINDER_API_KEY=cf_live_...

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cfsniff-0.1.3.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cfsniff-0.1.3-py3-none-any.whl (13.9 kB view details)

Uploaded Python 3

File details

Details for the file cfsniff-0.1.3.tar.gz.

File metadata

  • Download URL: cfsniff-0.1.3.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for cfsniff-0.1.3.tar.gz
Algorithm Hash digest
SHA256 67d6f4a28282a2a04ad681957fb97738fd1bb1818fc65f6efae6e9f6c6b5517a
MD5 4a6bccbda86786fa8a6bd9eceaa367d0
BLAKE2b-256 8276913290b6adc9fd8639cc8d5b1e3e54ed9f810418856d0c4d246064b1ea0a

See more details on using hashes here.

File details

Details for the file cfsniff-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: cfsniff-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for cfsniff-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ffefe4e984cdb6b8373f5441eb5b3f5e3948f91d60d18a403579d6ce05afd3d7
MD5 804c7237135cba02558a96b522402293
BLAKE2b-256 98e1d0772319f1bd592027e7b3f89d1c0db5e89e9b3c64d114b6d4ef0a8a95bd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page