# PyShield CLI

PyShield is a Python-only deterministic security governance CLI designed to scan a Python repository for security vulnerabilities and code complexity, evaluate risk, and output structured reports entirely offline.

## Installation

You can install PyShield CLI using `pip` from the local directory:

```bash
cd pyshield
pip install -e .
```

## Usage

```bash
pyshield scan <path> [OPTIONS]
```

### Options

*   `<path>`: Path to the Python project directory.
*   `--format`: Output format. Allowed values are `terminal`, `yaml`, `markdown`. Default is `terminal`.
*   `--output` or `-o`: File path to save the generated report. If not provided, output defaults to `stdout`.

### Examples

```bash
# Scan current directory and print styled output to terminal
pyshield scan .

# Scan the "src" directory and output report to a YAML file
pyshield scan ./src --format yaml --output report.yaml

# Scan and generate a Markdown report
pyshield scan ./src --format markdown --output final_report.md
```
