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

pip install cfsniff

Clipboard support:

pip install "cfsniff[clipboard]"

Quick Start

# 1. Install
pip 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.1.tar.gz (16.3 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.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cfsniff-0.1.1.tar.gz
  • Upload date:
  • Size: 16.3 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.1.tar.gz
Algorithm Hash digest
SHA256 02ea21be8e247c72c377b15805b86db33b7565a493a8669b4a96a317d679feda
MD5 3f925310b0d86bbdb5e52aa4a56e37e2
BLAKE2b-256 3532aba08159766183cc801a8936ba16a2b5db303fd75ed2b7b002d3c0163741

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cfsniff-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 13.0 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f0fe99ba73732d25095b7bae32b442f7ba014843f7abaaf676378c68d9b83123
MD5 505fa68f88834a9a33811776c89155f9
BLAKE2b-256 9a3a3b4e861e38c561b1515e594dcacb61bca7369fe39a9471636ff3537586ea

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