Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 56 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,20 @@
</br>
</br>

---

## 🎬 Live Demo

**Automatic Error Monitoring (`errlens run test.js`):**

![ErrLens Run Demo](assets/errlens-run.gif)

**Manual Error Analysis (`errlens analyze "..."`):**

![ErrLens Analyze Demo](assets/errlens-analyze.gif)

---

## 🌟 Key Features

- 🚀 **Instant Diagnostics** – No more context-switching to Google or StackOverflow.
Expand All @@ -55,7 +69,6 @@ npm install -g errlens
---

## ⚡ Quick Start

```bash
# Analyze an error message
errlens analyze "TypeError: Cannot read property 'name' of undefined"
Expand All @@ -65,6 +78,12 @@ errlens run your-script.js

# Get JSON output for CI/CD pipelines
errlens analyze "is not a function" --json

# Analyze an error in Hindi
errlens analyze "Cannot read properties of undefined" --lang hi

# Run a script with output in Spanish
errlens run app.js --lang es
```

---
Expand Down Expand Up @@ -155,6 +174,42 @@ Exit codes (useful for CI):

This follows Unix conventions where `0` means success and non-zero means failure. If you prefer success-on-detection in CI, invert the check in your pipeline logic (for example, treat exit code `1` from `analyze <errorString>` as a pass condition).

---
---

### 4️⃣ Multilingual Support

ErrLens supports error explanations in multiple languages using the `--lang` flag.

**Default behavior:** English (`en`) is used when `--lang` is not specified.
```bash
# Run a file and get explanation in Hindi
errlens run app.js --lang hi

# Analyze an error string in Spanish
errlens analyze "Cannot read properties of undefined" --lang es

# Run a file and get explanation in Japanese
errlens run app.js --lang ja
```

#### 🌍 Supported Languages

| Language | Code |
|------------|------|
| English | `en` |
| Hindi | `hi` |
| Spanish | `es` |
| French | `fr` |
| German | `de` |
| Chinese | `zh` |
| Japanese | `ja` |
| Portuguese | `pt` |

> 💡 **Tip:** Combine with `--json` for multilingual CI/CD pipeline output:
> ```bash
> errlens analyze "is not a function" --lang fr --json
---
---

## 🧠 System Architecture
Expand Down
Binary file added assets/errlens-analyze.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/errlens-run.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading