Metadata-Version: 2.4
Name: tryclear
Version: 2.0.0
Summary: TryClear — Semantic image threat evaluation from the command line
Project-URL: Homepage, https://tryclear.io
Project-URL: Documentation, https://tryclear.io/docs
Author-email: Try Clear <support@tryclear.io>
License: MIT
License-File: LICENSE
Keywords: brand-impersonation,cli,image-security,phishing,qr-phishing,security,threat-detection,visual-threat-intelligence
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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
Requires-Python: >=3.9
Requires-Dist: requests>=2.28.0
Requires-Dist: rich>=13.0.0
Provides-Extra: dev
Requires-Dist: pytest-mock>=3.10.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Requires-Dist: responses>=0.23.0; extra == 'dev'
Description-Content-Type: text/markdown

# TryClear CLI

> A picture is worth a thousand words. Attackers know that. Your security tools don't.

TryClear evaluates images for semantic threats — phishing, brand impersonation, QR code attacks, hidden page techniques, and visual prompt injection.

## Setup

```bash
# 1. Install
pip install tryclear

# 2. Authenticate (grab your API key from tryclear.io/settings)
tryclear auth

# 3. Evaluate
tryclear eval suspicious-screenshot.png
```

That's it. Forensic verdict in your terminal.

## Commands

| Command | Description |
|---------|-------------|
| `tryclear auth` | Store your API key |
| `tryclear eval <file>` | Evaluate an image, get a forensic verdict |
| `tryclear eval --json <file>` | Structured JSON output for scripting |
| `tryclear status <id>` | Check evaluation status |
| `tryclear report <id>` | Fetch full forensic report |

## Supported Formats

PNG, JPG, JPEG, BMP, TIFF, SVG, WebP, HEIC/HEIF

## Example

```
$ tryclear eval bank-document.tiff

  ◆ TryClear v2.0.0

  bank-document.tiff · 269 KB · image/tiff

  ╭──────────────────────────────────────────────────╮
  │   MALICIOUS · High Risk                          │
  ╰──────────────────────────────────────────────────╯

  Page 1 appeared clean, but hidden content on Page 2
  revealed the threat. This 'Hidden Page' technique is
  used to evade security scanners. The attack
  impersonates Bank of America.

    ⚠ Bank of America impersonation detected
    ⚠ QR code → hxxps://mail[.]google[.]com/mail/u/0/
    ⚠ Threat concealed on Page 2 of 2

  Full report → https://tryclear.io/report/ana_demo
```

## CI/CD Integration

```bash
tryclear eval ./assets/ --fail-on malicious --exit-code 1
```

| Exit Code | Meaning |
|-----------|---------|
| 0 | CLEAR |
| 1 | SUSPICIOUS |
| 2 | MALICIOUS |
| 3 | Error |

## Auth

The CLI resolves your API key in this order:

1. `TRYCLEAR_API_KEY` environment variable
2. `~/.config/tryclear/config.json`
3. `~/.config/clear/config.json`

## Learn More

[tryclear.io](https://tryclear.io)
