Metadata-Version: 2.4
Name: errxplain
Version: 0.1.0
Summary: Pipe any error → get an instant AI explanation. Just type 'why'.
Project-URL: Homepage, https://github.com/EliaGambalunga/Errxplain
Project-URL: Repository, https://github.com/EliaGambalunga/Errxplain
License: MIT
Keywords: AI,cli,debugging,developer-tools,errors,terminal
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Debuggers
Requires-Python: >=3.10
Requires-Dist: anthropic>=0.25.0
Requires-Dist: groq>=0.9.0
Requires-Dist: openai>=1.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.12.0
Description-Content-Type: text/markdown

# errxplain 🔍

> Pipe any error. Get an instant, human explanation.

```bash
npm run build 2>&1 | errxplain
```

No more googling cryptic stack traces. `errxplain` reads your error and tells you exactly what went wrong, why, and how to fix it — in plain English.

## Demo

![errxplain demo](assets/demo.gif)

## Installation

```bash
pip install errxplain
```

## Usage

Works with any language or tool:

```bash
# Python
python app.py 2>&1 | errxplain

# Node / npm
npm run build 2>&1 | errxplain

# Rust
cargo build 2>&1 | errxplain

# Any command
<your-command> 2>&1 | errxplain
```

Show the original error alongside the explanation:

```bash
python app.py 2>&1 | errxplain --verbose
```

## Setup

```bash
pip install errxplain
export GROQ_API_KEY=your_key_here  # Free at console.groq.com
```

Add the export to your `~/.zshrc` or `~/.bashrc` to make it permanent.

## How it works

`errxplain` reads from stdin, sends the error to an LLM (via [Groq](https://groq.com) — fast and free), and formats the response into a clean, readable breakdown.

## Contributing

PRs welcome! Open an issue first to discuss major changes.

## License

MIT
