@nyex/nyex 0.1.3-beta.1 → 1.0.3

package/README.md

@@ -1,80 +1,155 @@
-# NYEX — AI Engineering Platform (Windows-first)
+# NYEX
 
-NYEX is a Windows-first AI Engineering CLI/TUI designed for serious builders who want **role-aware model routing**, **governed workflows**, and **local-first memory**—without turning your dev environment into a SaaS dependency.
+NYEX is a terminal-first AI workspace for real developer workflows: identity-gated access, deterministic multi-provider routing, and guardrails designed to keep teams shipping with confidence.
 
-This repo is currently in **private beta** (release line: `0.1.3-beta.1`).
+> **Defaults (v1.0.2+)**
+> - **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)
 
-## Why NYEX exists
+---
+
+## 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?"
+```
+
+---
 
-Most “AI coding tools” optimize for a single chat loop. NYEX is different: it treats AI like a **multi-role engineering team** (primary, intent, planner, tool_exec, summarizer) and gives you **control** over identity, routing, cost, and memory.
+## Providers and roles
 
-## Key capabilities
-
-- **NYEX-first auth gate**  
-  First run starts with NYEX sign-in, then provider setup.
-- **Production auth default**  
-  Device login and polling default to `https://auth.nyex.ai` out of the box.
-- **NYEX auth-gate UX polish**  
-  NYEX header/logo and polling spinner are shown during onboarding login.
-- **Multi-provider, role-aware routing**  
-  Assign provider+model per role (Primary, Planner, Tool Exec, Summarizer).
-- **Memory OS (local-first, inspectable)**  
-  Automatic memory preflight, pinned constraints, decisions, experiences, and active checkpoints.
-- **Grounding + checkpoints workflow**  
-  Store repo-aware grounding snapshots and checkpoint progress with deterministic state.
-- **Memory inspection commands**  
-  Use `nyex memory ...` and `nyex checkpoint ...` to inspect, search, pin/unpin, and resume context.
-- **Doctor / status diagnostics**  
-  Shows auth endpoint resolution, memory telemetry, and session health.
-- **Security posture**  
-  Rate-limited health endpoint, minimized public metadata, no secret leaks in logs, bypass hardened (release ignores bypass).
+NYEX routes work across **roles** (primary, planner, tool_exec, summarizer, validator, etc.). Each role can use its own provider/model, deterministically.
 
-## Install (private beta)
+Common providers:
+- OpenAI (ChatGPT / API)
+- Gemini (API key)
+- Claude (API key)
+- Ollama (Local Mode)
 
-You’ll receive the installer/package via private distribution. Public install instructions are intentionally omitted.
+You can change models/providers via:
+- **TUI**: `/settings` and `/models`
+- **CLI config overrides** (examples below)
 
-## First run (mental model)
+---
+
+## 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.
 
-NYEX has **two different auth layers**:
+### Local Mode (opt-in)
 
-1. **NYEX account** (platform identity and access control)
-2. **Provider access** (ChatGPT / API keys / Claude / Gemini) for the model provider you choose
-
-NYEX will first ask you to **sign in / create a NYEX account**, then guide you to provider setup and role mapping.
+Local Mode enables the local bridge + responses proxy (used for Ollama translations). It is OFF by default.
 
-## Configuration
+Enable Local Mode in `/settings` (recommended), or via CLI config override:
 
-NYEX uses `NYEX_HOME` as the only home directory.
+```bash
+nyex -c runtime_modes.local_mode_enabled=true exec "hello"
+```
 
-- **Windows default**: `%USERPROFILE%\.nyex`
-- You can override via env: `NYEX_HOME=E:\Nyex\_home`
+When Local Mode is enabled, you may see:
 
-Auth URL precedence (highest wins):
+```
+responses-api-proxy listening on 127.0.0.1:8788
+```
 
-1. `--nyex-auth-url` CLI flag
-2. `NYEX_AUTH_URL` env var
-3. `NYEX_HOME\config.toml` (`[nyex_auth].url`)
-4. Build-time default (`NYEX_DEFAULT_AUTH_URL`)
-5. Fallback: `https://auth.nyex.ai`
+That should **only** appear when you opt in.
 
-## Legal
+---
+
+## Useful commands
 
-- **Terms of Use**: see `TERMS_OF_USE.md`
-- **License**: see `LICENSE`
+- `/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
 
-## Security disclosure
+---
 
-If you find a security issue, please report it privately (do not open a public issue). Contact details will be provided to testers.
+## Troubleshooting
 
-## Repo structure (high level)
+### 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`
 
-- `core-rs/` — Rust CLI + TUI
-- `auth-server/` — NYEX auth backend
+### I’m blocked by “NYEX login required”
+Run:
 
-## Contributing
+```bash
+nyex auth login
+```
 
-This is a private beta repo. Contributions are by invitation only. If you’re an approved tester and want to contribute, ask for access/branching rules.
+Then retry.
+
+### Auth endpoint shows unreachable
+Check `/doctor` and confirm:
+- `Auth endpoint reachable`
+- Your network allows `https://auth.nyex.ai`
 
 ---
 
-AIC Pty Ltd (ACN 082 378 256) © NYEX AI Platform. All rights reserved.
+## 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
+
+---
+
+## License
+
+See repository license.
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nyex/nyex",
-  "version": "0.1.3-beta.1",
+  "version": "1.0.3",
   "description": "Nyex CLI (private beta)",
   "license": "SEE LICENSE IN LICENSE",
   "homepage": "https://nyex.ai",
@@ -18,7 +18,7 @@
     "nyex": "bin/nyex.js"
   },
   "optionalDependencies": {
-    "@nyex/nyex-win32-x64-msvc": "0.1.3-beta.1"
+    "@nyex/nyex-win32-x64-msvc": "1.0.3"
   },
   "engines": {
     "node": ">=18"