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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cfsniff-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 d17daefcc0f164de583893289049f372bc1cd9e1c90f8539aacf93638b9cc9a3
MD5 13705894c8f5f0ccb11ed987d638988d
BLAKE2b-256 6d9aee4d6ee1043b49f943d626473695f3755f9d1d21268cde7a0e4ae0ca4975

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cfsniff-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c8327e972353a81d8347f5efb91c8160ac73eb46afe0a991811e2350bd3dd842
MD5 7e4d6601257e67495ecf423bfbadad21
BLAKE2b-256 130a1f33aecb1bbb1aac40fb7c4ed3a4cc0e9f60908184aa85cf2f899e8dceb9

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