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.4rc1.tar.gz (24.2 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.4rc1-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file cfsniff-0.1.4rc1.tar.gz.

File metadata

  • Download URL: cfsniff-0.1.4rc1.tar.gz
  • Upload date:
  • Size: 24.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for cfsniff-0.1.4rc1.tar.gz
Algorithm Hash digest
SHA256 d907d866de32f273aabc8481b4fb441bd092baed0f25c5c9e2ab726763aad27b
MD5 37fca190fda1e7c24739bd00b5af3917
BLAKE2b-256 75871eb7a12a7703543d365dde61815244cb68fea9835be33fa6d29df8a36731

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfsniff-0.1.4rc1.tar.gz:

Publisher: release.yml on ClassiFinder/cfsniff

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cfsniff-0.1.4rc1-py3-none-any.whl.

File metadata

  • Download URL: cfsniff-0.1.4rc1-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for cfsniff-0.1.4rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc4c2ee02c2443a6afb5f775d92ea8718e20ff8cb59bb04e42b70afe4c51f312
MD5 1c24d3d95acb3e403841cb9743e1ee75
BLAKE2b-256 c7632c6ebe4a299471105c70105fd7f8c522a3b2ae04ca891ac862b86a304b06

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfsniff-0.1.4rc1-py3-none-any.whl:

Publisher: release.yml on ClassiFinder/cfsniff

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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