@nyex/nyex
v1.4.1
Published
Nyex CLI
Downloads
528
Readme
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.4.1)
- 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)
- Context Distillation shadow telemetry: ON by default
- Prompt replacement: OFF (the model still receives the normal prompt)
- Context Distillation enforcement: OFF by default
- Context Distillation telemetry: ON by default
Install
npm i -g @nyex/nyexVerify:
nyex --versionQuick Start
1) Launch NYEX
nyex2) 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:
primaryplannertool_execsummarizervalidator
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:
/providersto connect/manage provider auth/modelsto inspect and set model mappings/settingsto tune runtime behavior and modes
If provider auth or entitlement is missing, onboarding and diagnostics make this explicit.
Context Distillation (v1.4.1)
Context Distillation shadow telemetry and evidence signals are ON by default in non-enforcing mode.
Functionality default:
runtime_modes.context_distillation_phase2_enabled=trueEnforcement default:
runtime_modes.context_distillation_phase2_enforcement_enabled=falseTelemetry default:
features.context_distillation_telemetry=true
What this means:
- Runtime behavior stays passthrough while enforcement is OFF.
- No blocking/retry/discard is introduced by default.
- You can view Context Distillation state and recent counters in
/statusand/doctor. - You can toggle telemetry from
/settingswithout disabling core functionality. - Detailed runtime contract:
docs/CONTEXT_DISTILLATION.mdin the NYEX repository. - Trace-only lifecycle events are recorded in canonical trace; they are additive and do not imply a plugin bus.
What's New in 1.4.1
NYEX 1.4.1 focuses on behavioral stabilization: direct task fulfillment, safer quoted-reference handling, and quieter default governance behavior.
- PR5 release guardrails: strict leak scanning, packaging checks, and version sync validation.
- PR1 capability discovery: compact descriptors first, lazy hydration for selected tools/capabilities, eager fallback preserved.
- PR3 lifecycle tracing: trace-only typed lifecycle visibility (
PrePlan..OnFailure) with no planner/tool semantic change. - 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
- Capability discovery is compact-descriptor-first with lazy hydration of selected tool/capability schemas
- Trace-only lifecycle events cover
PrePlan,PostPlan,PreTool,PostTool,PreFinal,PostFinal,OnPolicyViolation,OnMemoryCommit,OnTraceFlush, andOnFailure
Version:
@nyex/[email protected]@nyex/[email protected]
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
- Compact capability discovery descriptors with lazy hydration and eager fallback compatibility
- 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:
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/toolsand/tools show <tool_id>- tool visibility and contracts
Troubleshooting
I see localhost/127.0.0.1 calls unexpectedly
- Check
/statusand verify local mode is disabled - Confirm proxy is disabled
- Disable Local Mode in
/settingsif needed
I am blocked by login or onboarding state
- Launch
nyex - Complete onboarding (sign-in, entitlement/plan, provider, model)
- Re-check
/statusand/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:
npm uninstall -g @nyex/nyex @nyex/nyex-win32-x64-msvc
npm cache clean --force
npm i -g @nyex/nyexIf 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, version sync, 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)
