@postmate/cli 0.1.0 → 0.1.1

package/README.md

@@ -1 +1,148 @@
-# postmateli
+# 🚀 Postmate CLI
+
+Run Postmate API collections directly from your terminal.
+
+Postmate CLI enables environment-based execution, data-driven testing, JSON reporting, and CI/CD-ready exit codes — all without a GUI.
+
+---
+
+## 📦 Installation
+
+Install globally using npm:
+
+```bash
+npm install -g @postmate/cli
+```
+Verify installation:
+```bash 
+pmc --version
+```
+📁 Project Structure
+
+Postmate CLI works inside a project that contains a .postmate directory.
+
+Example:
+```
+my-project/
+│
+├── .postmate/
+│   ├── collections/
+│   ├── environments/
+│   ├── data/
+│   └── reports/
+│
+└── package.json
+```
+You can run the CLI from:
+- Inside .postmate
+- Or from the project root
+
+The CLI automatically detects the correct project folder.
+
+▶️ Running a Collection
+
+Basic usage:
+```
+pmc run --collection <collectionName> --env <environmentName>
+```
+Example:
+```
+pmc run --collection school --env Dev
+```
+Each row in the data file will execute the collection once.
+
+Variables like:
+```
+{{id}}
+{{username}}
+```
+will resolve per row.
+
+🧪 Execution Output
+
+Example terminal output:
+```
+🚀 Running school
+Env: Dev
+Iterations: 1
+Total Requests: 10
+
+✔ [1] Get Users (200)
+✖ [1] Create User (500)
+
+Finished in 3s 120ms
+Total Requests: 10
+Report saved: .postmate/reports/school-Dev-2026-02-14T15-32-10.json
+```
+📄 Reports
+
+After every run, a JSON report is automatically generated inside:
+```
+.postmate/reports/
+```
+Filename format:
+```
+<collection>-<environment>-<timestamp>.json
+```
+Example:
+```
+school-Dev-2026-02-14T15-32-10.json
+```
+Reports can be:
+- Stored as CI artifacts
+- Parsed for analytics
+- Converted to JUnit
+- Used for dashboards
+
+❌ Exit Codes (CI Ready)
+Postmate CLI returns:
+- 0 → All requests successful (HTTP 2xx)
+- 1 → One or more failures
+
+Example:
+```
+pmc run --collection school --env Dev
+echo $?
+```
+This makes it ready for CI/CD pipelines.
+
+⚙️ Command Reference
+Run Command
+```
+pmc run --collection <name> --env <envName> [--data <dataFile>]
+```
+Options
+```
+| Option         | Description                      |
+| -------------- | -------------------------------- |
+| `--collection` | Collection name                  |
+| `--env`        | Environment name                 |
+| `--data`       | Optional data file for iteration |
+```
+🏗 CI Example (GitHub Actions)
+```
+- name: Run API Tests
+  run: pmc run --collection school --env QA
+```
+If any request fails, the pipeline fails automatically.
+
+💡 Best Practices
+- Keep base URLs inside environment files
+- Use data files for bulk execution
+- Version control your .postmate directory
+- Store reports as CI artifacts
+- Use clear environment names (Dev, QA, Prod)
+
+🔥 Why Postmate CLI?
+- Lightweight
+- Deterministic
+- Scriptable
+- CI-friendly
+- No GUI required
+- Built for automation
+
+📜 License
+
+ISC
+
+Made with ❤️ using Postmate

package/dist/index.js

@@ -3,6 +3,7 @@ import { Command } from 'commander';
 import { findPostmateRoot } from './utils/project.js';
 import { CoreContext } from '@postmate/core';
 import { cliLogger } from "./utils/cliLogger.js";
+import { generateHtmlReport } from "./utils/reportHelper.js";
 import fs from "fs";
 import path from "path";
 const program = new Command();
@@ -83,11 +84,17 @@ const runCommand = program
                 const timestamp = new Date()
                     .toISOString()
                     .replace(/:/g, "-");
-                const fileName = `${collection}-${env}-${timestamp}.json`;
-                const filePath = path.join(reportsDir, fileName);
+                const fileName = `${collection}-${env}-${timestamp}`;
+                const jsonFilePath = path.join(reportsDir, fileName + '.json');
+                const htmlFilePath = path.join(reportsDir, fileName + '.html');
                 // 3️⃣ Write JSON
-                fs.writeFileSync(filePath, JSON.stringify(info.reportJson, null, 2), "utf-8");
-                console.log(`Report saved: ${filePath}`);
+                fs.writeFileSync(jsonFilePath, JSON.stringify(info.reportJson, null, 2), "utf-8");
+                console.log(`Report saved: ${jsonFilePath}`);
+                //generate html report
+                const htmlReport = generateHtmlReport(info.reportJson, "Collection Name");
+                // 3️⃣ Write JSON
+                fs.writeFileSync(htmlFilePath, htmlReport, "utf-8");
+                console.log(`HTML Report saved: ${htmlFilePath}`);
             },
             onError: (err) => {
                 console.error('Run failed:', err);

package/dist/utils/reportHelper.js

@@ -0,0 +1,245 @@
+export function generateHtmlReport(reportData, collectionName) {
+    const summary = reportData.summary;
+    const requests = reportData.requests || [];
+    const passRate = summary.totalTests
+        ? ((summary.passed / summary.totalTests) * 100).toFixed(1)
+        : "0";
+    return `
+${buildHtmlStart()}
+${buildHeader(collectionName)}
+${buildSummary(summary, passRate)}
+${buildRequests(requests)}
+${buildFooter()}
+${buildScript()}
+</body>
+</html>
+`;
+}
+function buildHtmlStart() {
+    return `
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="UTF-8" />
+<title>Postmate Execution Report</title>
+<style>
+  body {
+    font-family: "Segoe UI", Arial, sans-serif;
+    background-color: #f4f6f9;
+    margin: 0;
+    padding: 20px;
+    color: #2c3e50;
+  }
+
+  .container { max-width: 1100px; margin: auto; }
+
+  .header {
+    background: #1f2937;
+    color: white;
+    padding: 20px;
+    border-radius: 8px;
+  }
+
+  .summary {
+    display: flex;
+    gap: 15px;
+    margin: 20px 0;
+    flex-wrap: wrap;
+  }
+
+  .card {
+    flex: 1;
+    min-width: 160px;
+    background: white;
+    padding: 15px;
+    border-radius: 8px;
+    box-shadow: 0 2px 6px rgba(0,0,0,0.05);
+    text-align: center;
+  }
+
+  .pass { color: #16a34a; }
+  .fail { color: #dc2626; }
+
+  .request {
+    background: white;
+    margin-bottom: 12px;
+    border-radius: 8px;
+    box-shadow: 0 2px 6px rgba(0,0,0,0.05);
+  }
+
+  .request-header {
+    padding: 12px 16px;
+    cursor: pointer;
+    display: flex;
+    justify-content: space-between;
+  }
+
+  .request-details {
+    display: none;
+    padding: 15px;
+    border-top: 1px solid #e5e7eb;
+  }
+
+  .badge-pass {
+    background: #dcfce7;
+    color: #166534;
+    padding: 4px 8px;
+    border-radius: 12px;
+  }
+
+  .badge-fail {
+    background: #fee2e2;
+    color: #991b1b;
+    padding: 4px 8px;
+    border-radius: 12px;
+  }
+  .test-status-pass {
+    color: #16a34a;
+    font-weight: 600;
+  }
+
+  .test-status-fail {
+    color: #dc2626;
+    font-weight: 600;
+  }
+
+</style>
+</head>
+<body>
+<div class="container">
+`;
+}
+function buildHeader(collectionName) {
+    const logoBase64 = "iVBORw0KGgoAAAANSUhEUgAAAIEAAACBCAMAAADQfiliAAABGlBMVEX////+/v4sLqkrLKYlJJosLagKEjctL6oIDzX+myQsLqz+//8FDDP9iR4qKqRAQaf8jB/8kCH8kyL7+/v9/f0sLqX8cxb9lyHe3u0QFzr49/fg4Obk5er7ehju7vIsMU/a2uAfJET09PY1NqLExOH637qtr7oXHT+1tsBhZXtbX3X5ni3Ly9P4xoglKkpMUGlxdIc0OVZFSWO6u8RTV2/p6e/T1Nn41KqEh5dqbYKbnao8QFv4ypr6giKUl6UjHpCkprOgoq74zp95fI6Mj560tNgsKpZaWrB/gpNOTqrExs2/wcnR0eb88eOVlMhycbd/fr2gn8yoqraKisNmZrL3p0z0j0eqqtT0oGH1sXz65tH3tmz2vpD4mi7Yma6uAAANDklEQVR42uybeV/aShfHJ4SEqaSgBtQABggKYpFNQHBBrYi4Y9Xa1vb9v43nnDNJCIper6HP/cefnwLZ5nznbBOWMvah90kSj6j/wHo4LP7ho63/l2n91+rbdBn7O46/3Lj/8oL+jG/eb1z+BdezxOOnt2tDn7oDJLb6BYf+8jaCL7/+AsHG4lsdsLj4aXFr+lkQ3lhcfGZp8ckm7qCnxd2p1oe+dGGy8Ma8sLdo20Bzi2PyHJrfZSx1kZpSs1i6zvWPiWAk9/U86en+efTBTT9625wGQOZ0f3//wSX49Ljxmu7nXR9cwXV3pv8EFASuD+bvL8OvafUPOWXOJrg2meSbgC2d2ASk+0v2JoIwEgxNdw159wKUgkg2rykKczT2n8etV/T1ft4luN2/SgB/0w+CJOnDuyXGrCH44HF2foLm5twXXs1iJt7A8rByegWV7McF0cjJBWMJqMafe7NzaG9ufs4269p7an9udvl3WDJ1FjuG6y1fcbjIBZTTFepIPxcI4Z81O/d5eXkjDGb1h6iinKZ8EEhsJRcKhaLHMSJYXv4M8338+lxbj64XZmdnAWB5FwgSV7lAKBBdej+BhASBUGgm+qCz8Or3ZUQY1YK3JhL3s2gbhR5Y/nEZZtZtaCbknwAHCc3kIKvDvxBhb0I/gKX78p6M49+eDdC8pmuVqRDAw60FCD8QAaOwOybYfnQ88BkBfgLA0p1Cl06DAP5AwyYLX/5YxmSYfUV4ws9EmF2cyKHQ1AhIAWgM4cufywsLgPASBKTAwt5vPQxtwAbwT5Aj80RBjeE3IaAm2N9DgF24QVuJyoEpEEiiFmZcQWMI67t7gLD3eZIIYEtisQcEIHKbQPJDMONR9BiG//oCwizYX/i+KjH9JqcQwMgHfghCgTEEaAzS6veJCGAfAKANXAEAEoR8E4hMVEJeBLsxLDjJMA7w41eYmcO44uQA9KOAf4LAGIHdGATCnjcFFpYXsA+lrr0A0yCgruxVHG57oDEsiEjsCYw99AD1oRM54AEAAnlqBNQaQUrwLuVBIPt7uEF96DQYcBJgmgROYVFSRoLBkwz2pgViQKEDlqkPRfeDMnYv1w9T9oENENw/LUlh6k1omh6hD4X149w+HPUiBPzlgTSBAAEAYajDDdyuME4AW3CudbePBMEIEQgpU4vCKAQIcE3vAqg3kbANiJvqoEAIjDQdAjsLAwIgOLTA2jH0pi2B8B3bwEMK3qfdiRMi0yQI2QQBF6APHQEWX+pN2B6pDzWHcbypbl7bCMrfIFBsAHwTcHEqK/EhNoavv7cSeDsiK5ETQDBdBMpGh8DX6mx3uBnZBrjBxRcAAkr8OmV/rgW3IwFFkXH5toZPvDAVAiwHWQycAwAJ3gTg2hNSTo4hIJKJizEZw/t667YvThUIiuz7/kAMZOdg7gHu2x+iYoKhgJw7ub0ansYFAHghCgj6lY0gUzuI+CXoyzQMuBX+cnB/oD/kZMVx8Ywsy5GIvalg8R/T/YFbEoocyfnsSP0g2hAj0gxvcnLgiRT3WZHRS7EHByEC2ZPzVQvSiu1RZMAoJ65yyiTjzqYSwExhx9Ggq5zPakQCQXGKmX4bcjyuKE9sCwUUbBSwRo0RMH8EAgAWRHH/47H2HAAR4tSyTm2A/hQISHBTAB2PAMYI6EmB3JQVyEraHcdeBT2C7Af3p+SD6yZ2/YgyPl+QTHKeBQL0qiauU9P0AU5q6SQiJq64s1Vk57U8kkBw1qn+NPIg2B/SWhSRRZw9k5XR964zBAhtRdx1aho+EIvhaSQuex0/NmfhDg+BQh/+mEP/1XiRE4vhCgCgXiYYh4vHI6J6+/vRpi8C87QvOgysxoJAnqwn3okjAnWw/rUe9hEFiR1jlwWAuCCIxycY97yOO/bxzOgxdvGV97uAvkqLibfCcY9sE5M84ey1z4ziUurr+zi6OAFrUXySvMaeo5BgkQj7+kKQCJonsMSJmXtnH4cl0xYt0eNyzri2mL+vJMmFqduT6Pt0cmMyv9+Jkhckc+ldSln2AL4RpP/o6rFRfGg6X/X9xwATEJ4dmnz2x28UPvShD33oQx/60Ic+9CGfsvIHpG/58+S//GWjVMrn8y3PUGuw/e9/jJZMq0KGke603nBBrLW5WSLW2LqmqvXRj8/yBoyyOeGS1ObmufXigCki4JzjY+38nwn0hqpWLJfA+Oa6oMJfIDg0jHLrVYJCGZRFhJ3UGwg0rT4i4K4T1gz1JQLOs68S8PVMMplsbaM3uq6h8aTQE7pLwHk9QQRFTR05wWrwMQJp9KvhQ3WMIKY/I+i4ceQNOpo8qDYa1QPHIYnzwXpjvfotCXa22wCabre7FhBQ6CrmyAU2gd46PCoWq9sZOtCGuBWq7XZGjNUurnfEkRFBEd9mSqxZ43wHhkt0a5gYXK0d0lxTxQLXNI2DYdOsaZQ3WjologBG8zQyuMDJxFanrML5XC33YICORqBcXcND62KsdDfxjIAxc4cIEkcGFwTc6IFL9A6MUMgWYE+2ZNY4VQ4nArCR5pzycrOgGhWDCGJVjaNVHACiWtXsYoNDLZgkNwoGPLT15wSlLLg0wb7hVBq9XgOeC8CdKXPeOGuddyvGUSyR34ZBatuHeQsJ+E5bOMHC7NgWBOwsmy128wedAlRXipUOijBQ+wCCajU0tdDZLOUrKi+cewn0WCymtyBcfMDMOlcL6COrB3kB8ysVVLUnOg4mhgS2Kk4/4Ds4KzgJs2A7b0dBP6SGoVchMOeUiWqhZWcauZWl6hysjqoxXQQ1ygAAZXtWUO2DUOC8UEIfqOVqPmM9qwUgqJk98PUa7qw186Na0C2zaW7bSYIEJXgOQ0rspPREIqF3KY6jjsS5iHvhgE5X7QLrQTDzOBWMaLk+KEkTCFI1rjXyBSxkh0Bq9dZ3arU0zEn1Eljg3nKFtKNy2oU/xBwRGPU1qOEudyeCMIeMNatZcUJ2O0YdCbPFJQBOXkhTxG2C2HYZ812jPuslgFRX6QjJOBsR1I6OjgaD7jkV9oEwa/vAwBLSS731WgGuzp5NIEimqTwgVZBgDRMRCrfaPTyoOgTc9QEvFx11Mi4BL3pbFCQeb1hOHmAvQ3N66rxjqNrgeRQYG2DlpZMuwUDj2XNnMl4fYGtIt+xPSu2P/W0C73+7wAXGaMPAZhtMriegP3RNkTFcqwIB1CCYw3jYBBlwAm8z5kShw2k3SxS5S2Ac4Of8WDHrScqUQZK9RMDWIKuM+uCobgi3Q0bXu2eZ1gC2cdmAGlMr1a7kEsCktXKGuT5owxR6TTNTNWwfbMKL9FE1ySzsorXBYbdT5o3UiwR6t+D0xOwhtUR4WcjC2qntJEX3g3yqNd0osGRvkI8RAUeCEpSvUdsp86whCFLYSDUVCi1Tx6Ex9bV0yyZIQt6OEzB9rQ5tU+NGZRNjZXZ3DOrlRoWCqQ8M6LqFMyTQat5fx+e5Rs0/n8bz1cohpCQtGvkyXn+EMFBX+LqwXnKiYH3b3j5/+gGouTYoFtubzujmZq9TLA7W/te+1fM4CgNR0510JWlikG1SbDBCtvkIwiAhIigi6Pj/P+ZmcJLNZfe0Qsppm3WTIWD54RmP3zyZ6zWNTWLiA/GKrlvoQzfRdZ1whk1Mz9i5c5ugl16k7UK3bXZG2nG693OHur3PxNwncvbX9VdfDHne8xOP/Vf7PsB3aMBPyvN3aNA/0vdP++9tR18TYix0FIoJaAFmj13IvhjD8zEHFHn6CgC+4St9IH0E1RTXBVLR8XpzSoLPK1CJY8fZ9ILVSiql7JrUmqgvikWrlBzayy37R+LTXlW0shm2e0G6IEN+dltXo8K1vjaAoHZ338qjrfEzo8baHplM2Fl7Dsks9+UgSFADd2iWdJCXyqkDxjZhE2+bgoB3zA3oEPha+3cEvd4nwwn22XawXDLCynYwmd0VyV4bpNoTPM9zaTkHrzCrpMnLbNg2CyMQ6TEL7whOXN7nADyNzM2XOdyZ1AhDQpSEQKOdFyYgNX6JLE3AzIEb4U9mfm1DcMou2L9Z42CZ5ziB0ukJgYjGMAhC2dKA6zeBK8chSKMU5iDB5SK1DxaGhYi2IeiPi6gqjSJBA4WhUvniPyNIj7yFxvMTmUulSnxn9Y7A4IMmp4d2tdg2L1C959AiJFyNmiEfYLx9mIMaUFYCtScqlhy46zsC6hDYnO7kKnakx00I5uicYssT38XBmoAeECDzpglyRhpDSE4A4g3iT6j+AwJSREPA0mS/BYHvYKMzJoiDW/Y5ZDcEVZQbAXV4NtQ6SwFkMo4teIO13BaAYCI0XzUR21LiN5y3Wd1uQcBMfD2DAsZsbuocrW9L2u+1hJwU1GWJS/5QmFIPmKTmRMdEADp/7NeiDyUCLyhiEfJ6C3u5HuKBsmb3yGQezKvGdJeabgb+eu8cEE8TBRfxm9AxmrcgeN0JBg/zO7dDeRz+JZb+AbqiRQt2hYYvAAAAAElFTkSuQmCC";
+    return `
+<div class="header" style="
+    display:flex;
+    justify-content:space-between;
+    align-items:center;
+">
+  <div style="display:flex;align-items:center;gap:14px;">
+    <img src="data:image/png;base64,${logoBase64}" style="height:50px;" />
+    <div>
+      <h1 style="margin:0;">Execution Report</h1>
+      <div style="font-size:13px;opacity:0.8;">
+        ${collectionName}
+      </div>
+    </div>
+  </div>
+
+  <div style="font-size:12px;opacity:0.7;">
+    ${new Date().toLocaleString()}
+  </div>
+</div>
+
+`;
+}
+function buildSummary(summary, passRate) {
+    return `
+<div class="summary">
+  <div class="card">
+    <div>Total Requests</div>
+    <h2>${summary.totalRequests}</h2>
+  </div>
+
+  <div class="card">
+    <div>Total Tests</div>
+    <h2>${summary.totalTests}</h2>
+  </div>
+
+  <div class="card">
+    <div>Passed</div>
+    <h2 class="pass">${summary.passed}</h2>
+  </div>
+
+  <div class="card">
+    <div>Failed</div>
+    <h2 class="fail">${summary.failed}</h2>
+  </div>
+
+  <div class="card">
+    <div>Pass Rate</div>
+    <h2>${passRate}%</h2>
+  </div>
+</div>
+`;
+}
+function buildRequests(requests) {
+    return requests.map((req, index) => buildRequestCard(req, index)).join("");
+}
+function buildRequestCard(req, index) {
+    const hasFailure = req.tests?.some((t) => t.status === "Failed");
+    const dataLine = req.data
+        ? `
+        <div style="
+            font-size:12px;
+            opacity:0.75;
+            margin-top:4px;
+            font-family: Consolas, monospace;
+            background:#f8fafc;
+            padding:6px;
+            border-radius:4px;
+            overflow-x:auto;
+        ">
+            ${escapeHtml(JSON.stringify(req.data, null, 2))}
+        </div>`
+        : "";
+    return `
+<div class="request">
+  <div class="request-header" onclick="toggle(${index})">
+    <div>
+      <strong>${req.method}</strong> ${req.name}
+      <div style="font-size:12px;opacity:0.7;">${req.url}</div>
+      ${dataLine}
+    </div>
+    <div>
+      ${hasFailure
+        ? `<span class="badge-fail">FAILED</span>`
+        : `<span class="badge-pass">PASSED</span>`}
+    </div>
+  </div>
+
+  <div class="request-details" id="details-${index}">
+    <div style="font-size:13px;margin-bottom:8px;">
+      Status: <strong>${req.status}</strong> |
+      Duration: ${req.durationMs} ms
+    </div>
+
+    ${(req.tests || []).map(buildTestRow).join("")}
+  </div>
+</div>
+`;
+}
+function escapeHtml(str) {
+    return str
+        .replace(/&/g, "&amp;")
+        .replace(/</g, "&lt;")
+        .replace(/>/g, "&gt;");
+}
+function buildTestRow(test) {
+    return `
+<div style="display:flex;justify-content:space-between;font-size:13px;padding:6px 0;">
+  <div>${test.description}</div>
+  <div class="${test.status === "Passed" ? "test-status-pass" : "test-status-fail"}">
+    ${test.status.toUpperCase()}
+  </div>
+</div>
+`;
+}
+function buildFooter() {
+    return `
+<div style="text-align:center;font-size:12px;margin-top:30px;opacity:0.6;">
+  Generated by Postmate CLI
+</div>
+`;
+}
+function buildScript() {
+    return `
+<script>
+function toggle(index) {
+  const el = document.getElementById("details-" + index);
+  el.style.display = el.style.display === "block" ? "none" : "block";
+}
+</script>
+`;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postmate/cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "private": false,
   "type": "module",
   "description": "Postmate CLI - Run API collections from terminal",
@@ -15,7 +15,7 @@
   "author": "Shyam Naryan Yadav",
   "license": "ISC",
   "dependencies": {
-    "@postmate/core": "^0.1.15",
+    "@postmate/core": "^0.1.17",
     "chalk": "^5.6.2",
     "commander": "^14.0.3"
   },