Metadata-Version: 2.4
Name: kalibur
Version: 0.1.0
Summary: AI whitebox pentest assistant
Author-email: Scapin Ltd <contact@scapin.co.uk>
License: MIT
Project-URL: Homepage, https://kalibur.ai
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: certifi>=2024.0.0

# kalibur

AI-powered whitebox security scanner. Run `kalibur scan` against any local codebase.

## Requirements

- Python 3.9 or later
- A Kalibur API key (get one at kalibur.ai)

## Installation

**macOS**
```bash
brew install kalibur
```

**Linux / Windows**
```bash
pip install kalibur
```

## Usage

```bash
export KALIBUR_API_KEY=your_api_key

# Scan current directory
kalibur scan

# Scan a specific directory
kalibur scan -t /path/to/project
```

## Configuration

| Flag | Env var | Description |
|------|---------|-------------|
| `-k KEY` | `KALIBUR_API_KEY` | API key (required) |
| `-t PATH` | | Directory to scan (default: `.`) |

## Output

Results are written to a timestamped subfolder inside a `kalibur/` directory in the scanned project:

```
<target>/kalibur/
  2026-05-03_14-23-45/
    report.md
```

Nothing is written if no findings are detected.

Add `kalibur/` to your `.gitignore` to keep scan output out of version control.

## Generating a PDF report

After reviewing and triaging findings in `report.md`, generate a branded PDF:

```bash
kalibur report \
  -r ~/project/kalibur/2026-05-03_14-23-45/report.md \
  -f "Your Firm" \
  -c "Client Name" \
  -a "Your Name" \
  -l ./logo.png \
  -v "1.0"
```

| Flag | Description |
|------|-------------|
| `-r FILE` | Path to `report.md` (required) |
| `-f NAME` | Assessor firm name (required) |
| `-c NAME` | Client name (required) |
| `-a NAME` | Assessor name (required) |
| `-l FILE` | Logo file, `.png` or `.jpg` (required) |
| `-v VER` | Report version, e.g. `1.0` (required) |

The PDF is saved as `report.pdf` alongside `report.md`. Valid triage statuses in `report.md` are `Open` and `Resolved`.
