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.0.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.0-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cfsniff-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 41ee7fe83b63d0113f458a029b997b96449bcc23e16020f0ccc34109223fa611
MD5 8a8b480cc79496200c881a30811a400d
BLAKE2b-256 37fdcb7e2720b8d7da5ba8392c2332ba1f1998c0b7a5acdacd3c592c0f85db7c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cfsniff-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 98a0441a929b7cb1a6360bce92d3d4a28572777d278730a5db49652596125eed
MD5 31de38418f71d021c16953dbf858bdf7
BLAKE2b-256 3a528102696d6eed8e40767f20c3fda2116151dbfe03ac6a4b3f4e92a3c37378

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