SECRETSWEEP

Repo secret scanner + auto-rotator across providers

Developer / Supply Chain — secrets, SBOM, CI/CD, and license hygiene.

pip install cognis-secretsweep
secretsweep scan .            # → prioritized findings in seconds

Usage — step by step

secretsweep is a zero-install secret scanner with 50+ provider rules, Shannon-entropy detection, and allowlist/baseline support. Console script: secretsweep.

1. Install:

   pipx install secretsweep     # or: pip install secretsweep

2. Scan files, a directory, or stdin for secrets:

   secretsweep scan ./src --format json | jq '.summary'
   cat config.yml | secretsweep scan

   Exit 2 = secrets found, 0 = clean, 1 = error.
3. Record a baseline of currently-accepted findings so existing secrets don't block the build:

   secretsweep baseline . --output .secretsweep.baseline

4. Verify against the baseline in CI — fail only on new secrets at/above a severity floor:

   secretsweep verify . --baseline .secretsweep.baseline --severity high

5. Tune the scan with allowlists and the entropy detector, or list the bundled rule pack:

   secretsweep scan . --exclude '*/tests/*' --allow-regex 'AKIA_EXAMPLE_.*' --entropy-threshold 4.5
   secretsweep rules --format json

Contents

• Why secretsweep? · Features · Quick start · Example · Architecture · AI stack · How it compares · Integrations · Install anywhere · Related · Contributing

Why secretsweep?

Repo secret scanner + auto-rotator across providers — without standing up heavyweight infrastructure.

secretsweep is single-purpose, scriptable, and self-hostable: point it at a target, get prioritized results in the format your workflow already speaks (table · JSON · SARIF), gate CI on it, and let agents drive it over MCP.

↑ back to top

Features

• ✅ Shannon Entropy
• ✅ Redact
• ✅ Scan Text
• ✅ Scan Path
• ✅ Rotation Plan
• ✅ Runs on Linux/macOS/Windows · Docker · devcontainer
• ✅ Ports in Python, JavaScript, Go, and Rust (ports/)

↑ back to top

Quick start

pip install cognis-secretsweep
secretsweep --version
secretsweep scan .                       # scan current project
secretsweep scan . --format json         # machine-readable
secretsweep scan . --fail-on high        # CI gate (non-zero exit)

↑ back to top

Example

$ secretsweep scan .
  [HIGH    ] SEC-001  example finding             (./src/app.py)
  [MEDIUM  ] SEC-002  another signal              (./config.yaml)

  2 findings · risk score 5 · 38ms

↑ back to top

Architecture

flowchart LR
  IN[target / manifest] --> P[secretsweep<br/>checks + rules]
  P --> OUT[findings (JSON / SARIF)]

Loading

↑ back to top

Use it from any AI stack

secretsweep is interoperable with every popular way of using AI:

• MCP server — secretsweep mcp (Claude Desktop, Cursor, Cognis.Studio, uncensored-fleet)
• OpenAI-compatible / JSON — pipe secretsweep scan . --format json into any agent or LLM
• LangChain · CrewAI · AutoGen · LlamaIndex — wrap the CLI/JSON as a tool in one line
• CI / scripts — exit codes + SARIF for non-AI pipelines

↑ back to top

How it compares

	Cognis secretsweep	trufflesecurity
Self-hostable, no account	✅	varies
Single command, zero config	✅	⚠️
JSON + SARIF for CI	✅	varies
MCP-native (AI agents)	✅	❌
Polyglot ports (JS/Go/Rust)	✅	❌
Open license	✅ COCL	varies

Built in the spirit of trufflesecurity/trufflehog, re-framed the Cognis way. Missing a credit? Open a PR.

↑ back to top

Integrations

Pipes into your stack: SARIF for code-scanning, JSON for anything, an MCP server (secretsweep mcp) for AI agents, and a webhook forwarder for SIEM/Slack/Jira. See docs/INTEGRATIONS.md.

↑ back to top

Install — every way, every platform

pip install "git+https://github.com/cognis-digital/secretsweep.git"    # pip (works today)
pipx install "git+https://github.com/cognis-digital/secretsweep.git"   # isolated CLI
uv tool install "git+https://github.com/cognis-digital/secretsweep.git" # uv
pip install cognis-secretsweep                                          # PyPI (when published)
docker run --rm ghcr.io/cognis-digital/secretsweep:latest --help        # Docker
brew install cognis-digital/tap/secretsweep                             # Homebrew tap
curl -fsSL https://raw.githubusercontent.com/cognis-digital/secretsweep/main/install.sh | sh

Linux	macOS	Windows	Docker	Cloud
scripts/setup-linux.sh	scripts/setup-macos.sh	scripts/setup-windows.ps1	docker run ghcr.io/cognis-digital/secretsweep	DEPLOY.md (AWS/Azure/GCP/k8s)

↑ back to top

Related Cognis tools

• depgraph — Dependency risk visualizer — Scorecard + OSV + typosquat + maintainer signals
• pipewatch-pro — CI/CD supply-chain auditor — GH Actions / GitLab CI / OWASP CI/CD Top 10
• ossaudit — OSS license compliance auditor — AGPL contamination + NOTICE generation

Explore the suite → 🗂️ all 170+ tools · ⭐ awesome-cognis · 🔗 cognis-sources · 🤖 uncensored-fleet · 🧠 engram

↑ back to top

Contributing

PRs, new rules, and demo scenarios are welcome under the collaboration-pull model — see CONTRIBUTING.md and SECURITY.md.

⭐ If secretsweep saved you time, star it — it genuinely helps others find it.

Interoperability

{} composes with the 300+ tool Cognis suite — JSON in/out and a shared OpenAI-compatible /v1 backbone. See INTEROP.md for the suite map, composition patterns, and reference stacks.

License

Source-available under the Cognis Open Collaboration License (COCL) v1.0 — free for personal, internal-evaluation, research, and educational use; commercial / production use requires a license (licensing@cognis.digital). See LICENSE.

---

_{Cognis Digital · one of 170+ tools in the Cognis Neural Suite · Making Tomorrow Better Today}