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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cfsniff-0.1.4.tar.gz
  • Upload date:
  • Size: 24.3 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.4.tar.gz
Algorithm Hash digest
SHA256 68ae8c40eae2da30b5dcc7803b1c0934205f4dec579f248fb2b315f23c2e84ff
MD5 618ac67a482123383d91cccb99e4fbcb
BLAKE2b-256 633012ae53fdc6c94dcb7bfebd6d694dcb0d484b4654016cc11be8e7ea384da0

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfsniff-0.1.4.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.4-py3-none-any.whl.

File metadata

  • Download URL: cfsniff-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 16.7 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0edcb112dcae31630a6f1597d2d17ce7256dc6f4f4a2674186da0db9d9539394
MD5 11cb0dadff3e2cc0d8b296e690043116
BLAKE2b-256 9666c12821b1fcfac52f61f212d19070930192f7c39fa0c620686cdb1212f7b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for cfsniff-0.1.4-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