npm - @nyex/nyex - Versions diffs - 1.2.5 → 1.3.0 - Mend

@nyex/nyex 1.2.5 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2) hide show

package/README.md +204 -239
package/package.json +2 -2

package/README.md CHANGED Viewed

@@ -1,239 +1,204 @@
-# NYEX
-NYEX is a terminal-first Agentic-AI execution runtime built for real software delivery. It enforces identity-gated access, routes work deterministically across roles and providers, and keeps execution observable through trace-first diagnostics and safety guardrails so teams can ship faster without losing control of runtime behavior.
-> **Defaults (v1.2.5)**
-> - **Strict Cloud Mode: ON** (cloud failures do **not** silently fall back to local)
-> - **Local Mode: OFF** (the local proxy never starts unless you explicitly enable it)
-> - **Capability packs: OFF by default** (install + explicit /capabilities enable <id> required)
----
-## Install
-```bash
-npm i -g @nyex/nyex
-```
-Verify:
-```bash
-nyex --version
-```
----
-## Quick start
-### 1) Login (NYEX account)
-NYEX requires an account session before execution.
-```bash
-nyex auth login
-```
-This opens the device login page and binds your session locally.
-### 2) Check status
-```bash
-nyex /status
-nyex /doctor
-```
-What to look for:
-- `strict_cloud_mode: true`
-- `local_mode_enabled: false`
-- `Proxy: disabled`
-- Auth endpoint should be `https://auth.nyex.ai`
-### 3) Ask something
-```bash
-nyex exec "what is 1+1?"
-```
----
-## Providers and roles
-NYEX routes work across **roles** (primary, planner, tool_exec, summarizer, validator, etc.). Each role can use its own provider/model, deterministically.
-Common providers:
-- OpenAI (ChatGPT / API)
-- Gemini (API key or OAuth)
-- Claude (API key)
-- xAI / Grok (BYOC API key)
-- Ollama (Local Mode)
-You can change models/providers via:
-- **TUI**: `/settings` and `/models`
-- **CLI config overrides** (examples below)
-If no providers are connected after NYEX login, the onboarding flow will prompt you to connect one.
-### NYEX 1.2.5
-NYEX 1.2.5 is a release correction with hard auth-gate enforcement and default capability-off posture:
-- plain `nyex` startup stays TUI-first with in-app auth gate flow
-- live layout/render compaction and transcript/live fidelity fixes in the main conversation surface
-- runtime tool-call integrity hardening to prevent orphan `call_id` output failures
-- footer planner/tool telemetry now reflects live execution truth
-- default final surface is canonical raw result followed by evaluator output
-- release-prep validation evidence is generated locally via:
-  - `scripts/qa/tui-validation-harness.ps1`
-  - `artifacts/tui-validation/report.md`
-Mainline updates after 1.2.5 (current `origin/main` pre-release line):
-- live command output rendering is append-only (history-first) to reduce blank-space artifacts in `Ran ...` cards
-- main completed view stays raw-result-first and no longer shows evaluator headline rows
-- evaluator evidence remains available in transcript/debug surfaces
-### Version
-- Package: `@nyex/nyex@1.2.5`
-### Core Features
-- Deterministic multi-role orchestration (`primary`, `planner`, `tool_exec`, `summarizer`, `validator`).
-- Planner-first decomposition for long/multi-step prompts before compaction fallback.
-- Structured planner artifact checklist contract for execution-ready handoff.
-- Attempt-based observability with trace-first diagnostics (`/trace`, `/status`, `/doctor`, `/signals explain`).
-- Validator safety invariants: pre-final only and no-tools.
-- Canonical tool descriptors and lifecycle-normalized tool execution outcomes.
-- Descriptor-driven tool permission enforcement with explicit denial reasons.
-- Tool discovery and clarity surfaces (`/tools`, `/tools show <tool_id>`).
-- Tool outcome UX clarity with normalized success/failure/denial surfaces.
-- Multi-provider routing with explicit auth/connect guidance.
-- Local persistent memory support with session-aware context continuity.
-- Session persistence and explicit resume flows (`nyex resume <session-id>`) with clearer invalid-id handling.
-- Refresh-token-backed auth/session reliability with silent refresh on startup/resume.
-- Strict Cloud Mode defaults with deterministic fallback behavior and explicit local-mode opt-in.
-- Entitlement-first access gate: productive use requires `active_entitlement`; blocked access states stay diagnostics-only until resolved.
-### Recent updates
-- post-1.2.5 mainline (unreleased):
-  - planner-first decomposition strengthened over compaction-first behavior
-  - planner artifact contract/checklist schema enforced for structured planning output
-- 1.2.5 runtime/product hardening pass:
-  - plain startup now remains in TUI with in-app auth gate behavior
-  - raw result + evaluator finalization replaces summary-first finalization default
-  - footer planner/tool counters now track live visible execution events
-- 1.0.9 foundation:
-  - canonical tool descriptors + normalized lifecycle/result/error contracts
-  - descriptor-driven permission tightening and clear `permission_denied` outcomes
-  - tool discovery (`/tools`, `/tools show <tool_id>`) and clearer tool outcome rendering
----
-## Strict Cloud Mode and Local Mode
-### Strict Cloud Mode (default)
-If your **primary** is a cloud provider and it fails (auth/rate limit/network), NYEX will **not** fall back to local models.
-This prevents surprise calls to localhost and keeps routing predictable.
-### Local Mode (opt-in)
-Local Mode enables the local bridge + responses proxy (used for Ollama translations). It is OFF by default.
-Enable Local Mode in `/settings` (recommended), or via CLI config override:
-```bash
-nyex -c runtime_modes.local_mode_enabled=true exec "hello"
-```
-When Local Mode is enabled, you may see:
-```
-responses-api-proxy listening on 127.0.0.1:8788
-```
-That should **only** appear when you opt in.
----
-## Useful commands
-- `/settings` — configure strict/local modes, defaults, role mappings
-- `/models` — explore models, refresh cache, set primary, set per-role
-- `/status` — auth + routing + strict/local/proxy visibility
-- `/doctor` — diagnostics: home dir, endpoints, reachability
-- `/signals explain` — why NYEX routed a role/model a certain way
----
-## Troubleshooting
-### I see localhost/127.0.0.1 being called
-- Ensure `local_mode_enabled` is **false**
-- Verify `/status` shows `Proxy: disabled`
-- If Local Mode is enabled, disable it via `/settings`
-### I’m blocked by “NYEX login required”
-Run:
-```bash
-nyex auth login
-```
-Then retry.
-### Windows install fails with `EPERM` / `TAR_ENTRY_ERROR` on `nyex.exe`
-This usually means antivirus (Norton/Defender) quarantined or locked the binary during npm extraction.
-Recommended recovery:
-```powershell
-npm uninstall -g @nyex/nyex @nyex/nyex-win32-x64-msvc
-npm cache clean --force
-npm i -g @nyex/nyex
-```
-If the error repeats:
-- add allow rules for your npm global install directory and `nyex.exe`
-- rerun install after restoring the file from AV quarantine
-- verify with `nyex --version`
-Verify Windows signature:
-```powershell
-$nyex = (Get-Command nyex).Source
-Get-AuthenticodeSignature -LiteralPath $nyex | Format-List Status,SignerCertificate,TimeStamperCertificate
-```
-Release trust note:
-- public NYEX Windows packages are staged from CA-issued, RFC3161-timestamped Authenticode signatures only.
-### Provider not connected
-Use `/providers` to connect (OpenAI/Gemini/Claude). NYEX won’t dispatch to a disconnected provider.
-### Auth endpoint shows unreachable
-Check `/doctor` and confirm:
-- `Auth endpoint reachable`
-- Your network allows `https://auth.nyex.ai`
----
-## Security and guardrails
-NYEX is built with “keep main green” discipline:
-- leak-scan strict mode
-- deterministic routing traces
-- clear status/doctor reporting
----
-## Links
-- Install: https://www.npmjs.com/package/@nyex/nyex
-- Auth: https://auth.nyex.ai
-- Status: https://auth.nyex.ai/health
-- Website: https://nyex.ai
----
-## License
-See repository license.
-Digilabs Company Australia © NYEX AI Platform. All rights reserved. AIC Pty Ltd (ACN 082 378 256)
+# NYEX
+**NYEX is a terminal-first agent runtime for production software work.**
+It provides deterministic role-based execution, policy-aware control, and traceable runtime behavior across providers and models.
+> **Defaults (v1.3.0)**
+> - **Strict Cloud Mode: ON** (cloud failures do not silently fall back to local)
+> - **Local Mode: OFF** (local proxy is disabled unless explicitly enabled)
+> - **Capability Apps: OFF by default** (install + explicit enable required)
+---
+## Install
+```bash
+npm i -g @nyex/nyex
+```
+Verify:
+```bash
+nyex --version
+```
+---
+## Quick Start
+### 1) Launch NYEX
+```bash
+nyex
+```
+### 2) Follow in-app onboarding
+- NYEX account sign-in
+- entitlement/plan selection
+- provider connection
+- model selection
+### 3) Validate runtime state in NYEX TUI
+Run these inside NYEX:
+- `/status`
+- `/doctor`
+---
+## Providers, Roles, Models
+NYEX executes through deterministic runtime roles. Typical roles include:
+- `primary`
+- `planner`
+- `tool_exec`
+- `summarizer`
+- `validator`
+Role routing is provider/model mapped per role.
+In runtime config, the primary route maps to the core chat role; in routing traces this is surfaced as `primary`.
+Configure from inside NYEX:
+- `/providers` to connect/manage provider auth
+- `/models` to inspect and set model mappings
+- `/settings` to tune runtime behavior and modes
+If provider auth or entitlement is missing, onboarding and diagnostics make this explicit.
+---
+## What's New in 1.3.0
+NYEX 1.3.0 formalizes the Capability App runtime slice in NYEX Core.
+- Capability Apps are separate installable app releases (`.nyexpack`)
+- Capability Apps are not bundled into NYEX Core payload
+- Runtime surfaces include install/list/show/enable lifecycle and supervisor controls
+- Deterministic non-TTY capability operations are supported
+Version:
+- `@nyex/nyex@1.3.0`
+- `@nyex/nyex-win32-x64-msvc@1.3.0`
+---
+## Core Runtime Capabilities
+- Deterministic multi-role orchestration
+- Planner-first decomposition for long or multi-step tasks
+- Structured planner artifact handoff contract
+- Trace-first diagnostics (`/status`, `/doctor`, `/trace`, `/signals explain`)
+- Validator invariants (pre-final, no-tools)
+- Canonical tool descriptors and lifecycle-normalized outcomes
+- Descriptor-driven permission enforcement with explicit denial reasons
+- Session continuity and resume flows
+- Strict-cloud default posture with explicit local-mode opt-in
+- Entitlement-first access gating for productive runtime use
+- Capability App runtime host/operator controls
+---
+## Runtime Modes
+### Strict Cloud Mode (default)
+When primary execution is cloud-backed and fails (auth/rate/network), NYEX does not silently switch to local providers.
+### Local Mode (opt-in)
+Local bridge/proxy is disabled by default and only activates when explicitly enabled.
+Enable via `/settings` (recommended), or CLI override:
+```bash
+nyex -c runtime_modes.local_mode_enabled=true exec "hello"
+```
+---
+## Useful Commands (inside NYEX)
+- `/settings` - runtime mode and behavior controls
+- `/providers` - connect/manage providers
+- `/models` - discover and assign models per role
+- `/status` - auth/routing/runtime visibility
+- `/doctor` - diagnostics and readiness checks
+- `/signals explain` - routing and decision explanation
+- `/tools` and `/tools show <tool_id>` - tool visibility and contracts
+---
+## Troubleshooting
+### I see localhost/127.0.0.1 calls unexpectedly
+- Check `/status` and verify local mode is disabled
+- Confirm proxy is disabled
+- Disable Local Mode in `/settings` if needed
+### I am blocked by login or onboarding state
+- Launch `nyex`
+- Complete onboarding (sign-in, entitlement/plan, provider, model)
+- Re-check `/status` and `/doctor`
+### Provider not connected
+Use `/providers` to complete provider auth, then verify with `/status`.
+### Auth endpoint unreachable
+Use `/doctor` and confirm network access to:
+- `https://auth.nyex.ai`
+### Windows install fails with EPERM/TAR_ENTRY_ERROR on nyex.exe
+This is usually antivirus lock/quarantine during npm extraction.
+Recommended recovery:
+```powershell
+npm uninstall -g @nyex/nyex @nyex/nyex-win32-x64-msvc
+npm cache clean --force
+npm i -g @nyex/nyex
+```
+If it persists:
+- restore file from AV quarantine
+- add allow rules for npm global directory and `nyex.exe`
+- retry install and verify with `nyex --version`
+---
+## Security and Guardrails
+NYEX emphasizes runtime truth and controlled execution:
+- deterministic routing traces
+- explicit diagnostics surfaces
+- policy/approval boundaries
+- leak-scan and release hardening discipline
+---
+## Links
+- Install: https://www.npmjs.com/package/@nyex/nyex
+- Auth: https://auth.nyex.ai
+- Health: https://auth.nyex.ai/health
+- Website: https://nyex.ai
+---
+## License
+See repository license.
+Digilabs Company Australia © NYEX AI Platform. All rights reserved. AIC Pty Ltd (ACN 082 378 256)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name":  "@nyex/nyex",
-    "version":  "1.2.5",
+    "version":  "1.3.0",
     "description":  "Nyex CLI (private beta)",
     "license":  "SEE LICENSE IN LICENSE",
     "homepage":  "https://www.npmjs.com/package/@nyex/nyex",
@@ -18,7 +18,7 @@
                 "nyex":  "bin/nyex.js"
             },
     "optionalDependencies":  {
-                                 "@nyex/nyex-win32-x64-msvc":  "1.2.5"
+                                 "@nyex/nyex-win32-x64-msvc":  "1.3.0"
                              },
     "engines":  {
                     "node":  "\u003e=18"