ruleset-id-extractor/README.md

CLI tool to extract and convert Jumio ruleset IDs and names to CSV

# Jumio Ruleset ID Extractor

**Jumio Ruleset ID Extractor** is an interactive and lightweight CLI tool that converts Jumio ruleset JSON files into well-structured CSV files — perfect for audits, reviews, and analysis.

---

## 🚀 Quick Start (No Installation Needed)

You can run the tool instantly using `npx`:

```bash
npx jumio-extractor
```

---

## 📦 Installation (Optional)

If you prefer to install it globally:

```bash
npm install -g jumio-ruleset-extractor
```

Then run it from anywhere:

```bash
jumio-extractor
```

---

## 🛠 How It Works

When you run the tool, you'll be prompted with two simple questions:

1. **How do you want to provide your ruleset JSON?**

   - **Upload from file**: Drag & drop the `.json` file into the terminal, or manually type the full file path.
   - **Paste JSON directly**: Paste raw JSON content into the prompt (validated before processing).

2. **Output File Name**
   - Provide the name for your output file (e.g., `name-rules-v4`)
   - A `.csv` file will be generated in your current working directory

---

## 📁 Example Input JSON

```json
{
  "rules": [
    {
      "id": "12345",
      "name": "ID Match",
      "description": "Checks if ID matches the provided data."
    },
    {
      "id": "67890",
      "name": "DOB Check",
      "description": "Verifies if Date of Birth matches."
    }
  ]
}
```

---

## 📤 Output CSV

```csv
Order Serial,Rule Name,Rule ID,Description
1,ID Match,12345,"Checks if ID matches the provided data."
2,DOB Check,67890,"Verifies if Date of Birth matches."
```

---

## 🎯 Features

- ✅ Drag-and-drop or path-based file selection
- ✅ Paste JSON directly into the terminal
- ✅ `.csv` file auto-naming and validation
- ✅ Cleanly formatted, ready-to-use output
- ❌ No internet access required — runs entirely offline

---

## 🖥 Requirements

- Node.js v16 or higher

To check your version:

```bash
node -v
```

---

## 🧾 Project Structure

```
jumio-ruleset-extractor/
├── bin/
│   └── cli.js              # CLI logic & prompts
├── src/
│   └── convert.js          # CSV generation logic
├── package.json
└── README.md
```

---

## 👨‍💼 Author

Made with ❤️ by **William Christopher (Jumio)**  
🔗 [LinkedIn](https://www.linkedin.com/in/sirwillchris)

---

## 🔐 Disclaimer

This CLI tool runs 100% locally. Your data never leaves your machine, and no information is transmitted online.