@zatsepin/jigor 0.1.3 → 0.1.4

package/README.md

@@ -1,27 +1,33 @@
-# jigor-cli — the `jigor` binary (CLI + HTTP gateway)
+# @zatsepin/jigor — System One decision gateway
 
-Ask System One decision models from the terminal or over HTTP. `von` and
-`laya` run locally as ONNX; `jev` runs remote on OpenRouter Decisions — one
-wire protocol across all of them: `noul`/`choice`/`score` questions in,
-typed answers out.
+Installs the `jigor` binary: a CLI and an HTTP gateway over one System One
+wire — `noul`/`choice`/`score` questions in, typed JSON answers out. `von`
+and `laya` run locally as ONNX (no API key); `jev` runs remote on OpenRouter
+Decisions.
+
+Node ≥ 18 is needed once, at install time, to pick the platform package —
+the installed `jigor` is a standalone binary with no Node runtime.
+
+## Install
 
 ```bash
-cargo install jigor-cli      # or: npm install --global @zatsepin/jigor  /  pip install jigor
-jigor serve --host 127.0.0.1 --port 8000   # HTTP gateway: POST /v1/systemone, GET /healthz
-jigor ask [--model <id>] [--provider <p>]  # the same wire over stdin, no HTTP layer
-jigor models                               # provider x model pairs
+npm install --global @zatsepin/jigor
+jigor --help
 ```
 
-The installed command is `jigor`. `cargo install` builds against the ONNX
-Runtime prebuilts, available for linux x64/arm64, macOS Apple Silicon and
-Windows x64; on Intel Macs use the prebuilt universal binary instead
-(`uvx jigor`, `pip install jigor` or `npm install --global @zatsepin/jigor`).
+One-off, no install:
+
+```bash
+npx @zatsepin/jigor models
+```
 
-Model aliases: `von`, `laya`, `jev`, `jev-latest`. The local ONNX models
-download to `~/.cache/huggingface` on first use; set `OPENROUTER_API_KEY`
-for the remote `jev` backend.
+The binary comes from an optional dependency matched to your OS and CPU —
+`@zatsepin/jigor-linux-x64-gnu`, `@zatsepin/jigor-linux-arm64-gnu`,
+`@zatsepin/jigor-darwin` (universal2: Apple Silicon + Intel) or
+`@zatsepin/jigor-win32-x64-msvc` — installed automatically, never a
+source build.
 
-## Example
+## Quick start
 
 ```bash
 jigor ask --model von <<'JSON'
@@ -35,14 +41,64 @@ jigor ask --model von <<'JSON'
   }
 }
 JSON
-# {"model":"von-1.0.0","backend":"local","answers":{"requires_intervention":{"type":"noul","noul":0.2739}}}
+{"answers":{"requires_intervention":{"noul":0.7822,"type":"noul"}},"backend":"local","model":"von-1.0.0"}
+```
+
+Every question carries `instructions` plus an optional `criteria` (object or
+list) that spells out how to judge the state. Answer shapes are the same on
+every backend:
+
+- `noul` → `{"type":"noul","noul":0.7822}` — probability of **yes** in `[0, 1]`
+- `choice` → `{"type":"choice","choice":"refund","confidence":0.91,"probabilities":{...}}`
+- `score` → `{"type":"score","score":1.0,"confidence":0.7,"probabilities":{...},"legend":{...}}`
+
+```json
+{
+  "state": "Invoice charged twice for order #4471.",
+  "questions": {
+    "domain": {
+      "type": "choice",
+      "instructions": "Classify the root cause domain.",
+      "criteria": { "billing": "Invoices, payments, refunds", "infrastructure": "Database, network, hardware" }
+    },
+    "severity": {
+      "type": "score",
+      "instructions": "Assess degradation level.",
+      "criteria": ["Nominal operation", "Degraded performance", "Critical risk"]
+    }
+  }
+}
 ```
 
-## The jigor Rust library
+## HTTP gateway
+
+```bash
+jigor serve --host 127.0.0.1 --port 8000
+
+curl -X POST http://127.0.0.1:8000/v1/systemone \
+  -H "Content-Type: application/json" \
+  -d '{
+    "model": "von-1.0.0",
+    "state": { "error": "Disk volume /var/log at 98% capacity." },
+    "questions": {
+      "requires_intervention": {
+        "type": "noul",
+        "instructions": "Does this disk space condition require operational intervention?"
+      }
+    }
+  }'
+# {"answers":{"requires_intervention":{"noul":0.7822,"type":"noul"}},"backend":"local","model":"von-1.0.0"}
+```
+
+`GET /healthz` returns `{"status":"ok"}`; `POST /v1/systemone` takes the same
+body as `jigor ask`.
+
+## Models
+
+`--model` takes an alias (`von`, `laya`, `jev`, `jev-latest`) or a full id
+(`von-1.0.0`, `typesafe/jev-1.13`); `jigor models` lists every provider ×
+model pair. The local ONNX models download from Hugging Face to
+`~/.cache/huggingface` on first use and are cached afterwards; the remote
+`jev` backend needs `OPENROUTER_API_KEY`.
 
-This binary is a thin shell over the
-[`jigor`](https://crates.io/crates/jigor) crate — local ONNX backends in
-`von`/`laya`, remote `jev` via OpenRouter Decisions, and one `answers()`
-call for all three. Use the library directly when you want decisions inside
-a Rust program: [crate docs](https://docs.rs/jigor) ·
-[full project README](https://github.com/Partysun/jigor#readme).
+Source, Rust crates and the pip package: https://github.com/Partysun/jigor

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zatsepin/jigor",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "System One decision gateway CLI + server — von/laya local ONNX backends, jev on OpenRouter Decisions. One wire protocol: noul/choice/score questions in, typed answers out.",
   "homepage": "https://github.com/Partysun/jigor",
   "repository": "https://github.com/Partysun/jigor",
@@ -26,10 +26,10 @@
     "postinstall": "node postinstall.js"
   },
   "optionalDependencies": {
-    "@zatsepin/jigor-darwin": "0.1.3",
-    "@zatsepin/jigor-linux-arm64-gnu": "0.1.3",
-    "@zatsepin/jigor-linux-x64-gnu": "0.1.3",
-    "@zatsepin/jigor-win32-x64-msvc": "0.1.3"
+    "@zatsepin/jigor-darwin": "0.1.4",
+    "@zatsepin/jigor-linux-arm64-gnu": "0.1.4",
+    "@zatsepin/jigor-linux-x64-gnu": "0.1.4",
+    "@zatsepin/jigor-win32-x64-msvc": "0.1.4"
   },
   "bin": {
     "jigor": "jigor"