Metadata-Version: 2.4
Name: truffle-scan
Version: 0.1.1
Summary: Deterministic security scanner for AI-generated projects. Scan any project, get a prioritized action plan — so you review 3 files instead of 300.
Project-URL: Homepage, https://trufflekit.com
Project-URL: Source, https://github.com/trufflekit/truffle
Project-URL: Documentation, https://github.com/trufflekit/truffle/tree/main/cli/rules
Author: TruffleKit
License: MIT
Keywords: ai,audit,code-review,security,static-analysis
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Utilities
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# TruffleKit CLI

**Deterministic security scanner for AI-generated projects.**

Scan any codebase, get a prioritized action plan — so you review 3 files instead of 300.

```bash
pip install truffle-scan
truffle scan . --plan
```

---

## Quick Start

```bash
# Scan your project
cd your-ai-project
truffle scan .

# Get an action plan
truffle scan . --plan

# Learn about a rule
truffle explain SEC-001

# Mark issues as fixed
truffle fix .
```

## Why TruffleKit?

- **22 deterministic rules** — no AI, no hallucinations, no black box
- **OWASP-referenced** — every rule links to industry standards
- **Action plan mode** — tells you exactly what to fix, in what order
- **Fix tracking** — mark issues as fixed, track progress over time
- **Zero false positives** — prefer false negatives over false alarms
- **Open source rules** — all rules are auditable in `cli/rules/`

## Documentation

- [CLI Reference](cli/README.md)
- [Rule Library](cli/rules/README.md) — all 22 rules documented
- [Publishing Guide](cli/PUBLISH.md)

## License

MIT
