@nyex/nyex 1.3.1 → 1.3.3
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.
- package/README.md +228 -228
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,228 +1,228 @@
|
|
|
1
|
-
# NYEX
|
|
2
|
-
|
|
3
|
-
**NYEX is a terminal-first agent runtime for production software work.**
|
|
4
|
-
It provides deterministic role-based execution, policy-aware control, and traceable runtime behavior across providers and models.
|
|
5
|
-
|
|
6
|
-
> **Defaults (v1.3.
|
|
7
|
-
> - **Strict Cloud Mode: ON** (cloud failures do not silently fall back to local)
|
|
8
|
-
> - **Local Mode: OFF** (local proxy is disabled unless explicitly enabled)
|
|
9
|
-
> - **Capability Apps: OFF by default** (install + explicit enable required)
|
|
10
|
-
> - **Context Distillation shadow telemetry:
|
|
11
|
-
> - **Prompt replacement: OFF** (the model still receives the normal prompt)
|
|
12
|
-
> - **Context Distillation enforcement: OFF by default**
|
|
13
|
-
> - **Context Distillation telemetry:
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## Install
|
|
18
|
-
|
|
19
|
-
```bash
|
|
20
|
-
npm i -g @nyex/nyex
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
Verify:
|
|
24
|
-
|
|
25
|
-
```bash
|
|
26
|
-
nyex --version
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
---
|
|
30
|
-
|
|
31
|
-
## Quick Start
|
|
32
|
-
|
|
33
|
-
### 1) Launch NYEX
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
nyex
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
### 2) Follow in-app onboarding
|
|
40
|
-
|
|
41
|
-
- NYEX account sign-in
|
|
42
|
-
- entitlement/plan selection
|
|
43
|
-
- provider connection
|
|
44
|
-
- model selection
|
|
45
|
-
|
|
46
|
-
### 3) Validate runtime state in NYEX TUI
|
|
47
|
-
|
|
48
|
-
Run these inside NYEX:
|
|
49
|
-
|
|
50
|
-
- `/status`
|
|
51
|
-
- `/doctor`
|
|
52
|
-
|
|
53
|
-
---
|
|
54
|
-
|
|
55
|
-
## Providers, Roles, Models
|
|
56
|
-
|
|
57
|
-
NYEX executes through deterministic runtime roles. Typical roles include:
|
|
58
|
-
|
|
59
|
-
- `primary`
|
|
60
|
-
- `planner`
|
|
61
|
-
- `tool_exec`
|
|
62
|
-
- `summarizer`
|
|
63
|
-
- `validator`
|
|
64
|
-
|
|
65
|
-
Role routing is provider/model mapped per role.
|
|
66
|
-
In runtime config, the primary route maps to the core chat role; in routing traces this is surfaced as `primary`.
|
|
67
|
-
|
|
68
|
-
Configure from inside NYEX:
|
|
69
|
-
|
|
70
|
-
- `/providers` to connect/manage provider auth
|
|
71
|
-
- `/models` to inspect and set model mappings
|
|
72
|
-
- `/settings` to tune runtime behavior and modes
|
|
73
|
-
|
|
74
|
-
If provider auth or entitlement is missing, onboarding and diagnostics make this explicit.
|
|
75
|
-
|
|
76
|
-
---
|
|
77
|
-
|
|
78
|
-
## Context Distillation (v1.3.
|
|
79
|
-
|
|
80
|
-
Context Distillation is enabled by default for runtime functionality in non-enforcing mode.
|
|
81
|
-
|
|
82
|
-
- Functionality default: `runtime_modes.context_distillation_phase2_enabled=
|
|
83
|
-
- Enforcement default: `runtime_modes.context_distillation_phase2_enforcement_enabled=false`
|
|
84
|
-
- Telemetry default: `features.context_distillation_telemetry=
|
|
85
|
-
|
|
86
|
-
What this means:
|
|
87
|
-
|
|
88
|
-
- Runtime behavior stays passthrough while enforcement is OFF.
|
|
89
|
-
- No blocking/retry/discard is introduced by default.
|
|
90
|
-
- You can view Context Distillation state and recent counters in `/status` and `/doctor`.
|
|
91
|
-
- You can toggle telemetry from `/settings` without disabling core functionality.
|
|
92
|
-
- Detailed runtime contract: `docs/CONTEXT_DISTILLATION.md` in the NYEX repository.
|
|
93
|
-
|
|
94
|
-
## What's New in 1.3.
|
|
95
|
-
|
|
96
|
-
NYEX 1.3.
|
|
97
|
-
|
|
98
|
-
- Capability Apps are separate installable app releases (`.nyexpack`)
|
|
99
|
-
- Capability Apps are not bundled into NYEX Core payload
|
|
100
|
-
- Runtime surfaces include install/list/show/enable lifecycle and supervisor controls
|
|
101
|
-
- Deterministic non-TTY capability operations are supported
|
|
102
|
-
|
|
103
|
-
Version:
|
|
104
|
-
|
|
105
|
-
- `@nyex/nyex@1.3.
|
|
106
|
-
- `@nyex/nyex-win32-x64-msvc@1.3.
|
|
107
|
-
|
|
108
|
-
Release prep:
|
|
109
|
-
|
|
110
|
-
- Fresh Windows release binary is built from `codex-rs/target-release-npm/release/nyex.exe`.
|
|
111
|
-
|
|
112
|
-
---
|
|
113
|
-
|
|
114
|
-
## Core Runtime Capabilities
|
|
115
|
-
|
|
116
|
-
- Deterministic multi-role orchestration
|
|
117
|
-
- Planner-first decomposition for long or multi-step tasks
|
|
118
|
-
- Structured planner artifact handoff contract
|
|
119
|
-
- Trace-first diagnostics (`/status`, `/doctor`, `/trace`, `/signals explain`)
|
|
120
|
-
- Validator invariants (pre-final, no-tools)
|
|
121
|
-
- Canonical tool descriptors and lifecycle-normalized outcomes
|
|
122
|
-
- Descriptor-driven permission enforcement with explicit denial reasons
|
|
123
|
-
- Session continuity and resume flows
|
|
124
|
-
- Strict-cloud default posture with explicit local-mode opt-in
|
|
125
|
-
- Entitlement-first access gating for productive runtime use
|
|
126
|
-
- Capability App runtime host/operator controls
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
## Runtime Modes
|
|
131
|
-
|
|
132
|
-
### Strict Cloud Mode (default)
|
|
133
|
-
|
|
134
|
-
When primary execution is cloud-backed and fails (auth/rate/network), NYEX does not silently switch to local providers.
|
|
135
|
-
|
|
136
|
-
### Local Mode (opt-in)
|
|
137
|
-
|
|
138
|
-
Local bridge/proxy is disabled by default and only activates when explicitly enabled.
|
|
139
|
-
|
|
140
|
-
Enable via `/settings` (recommended), or CLI override:
|
|
141
|
-
|
|
142
|
-
```bash
|
|
143
|
-
nyex -c runtime_modes.local_mode_enabled=true exec "hello"
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
---
|
|
147
|
-
|
|
148
|
-
## Useful Commands (inside NYEX)
|
|
149
|
-
|
|
150
|
-
- `/settings` - runtime mode and behavior controls
|
|
151
|
-
- `/providers` - connect/manage providers
|
|
152
|
-
- `/models` - discover and assign models per role
|
|
153
|
-
- `/status` - auth/routing/runtime visibility
|
|
154
|
-
- `/doctor` - diagnostics and readiness checks
|
|
155
|
-
- `/signals explain` - routing and decision explanation
|
|
156
|
-
- `/tools` and `/tools show <tool_id>` - tool visibility and contracts
|
|
157
|
-
|
|
158
|
-
---
|
|
159
|
-
|
|
160
|
-
## Troubleshooting
|
|
161
|
-
|
|
162
|
-
### I see localhost/127.0.0.1 calls unexpectedly
|
|
163
|
-
|
|
164
|
-
- Check `/status` and verify local mode is disabled
|
|
165
|
-
- Confirm proxy is disabled
|
|
166
|
-
- Disable Local Mode in `/settings` if needed
|
|
167
|
-
|
|
168
|
-
### I am blocked by login or onboarding state
|
|
169
|
-
|
|
170
|
-
- Launch `nyex`
|
|
171
|
-
- Complete onboarding (sign-in, entitlement/plan, provider, model)
|
|
172
|
-
- Re-check `/status` and `/doctor`
|
|
173
|
-
|
|
174
|
-
### Provider not connected
|
|
175
|
-
|
|
176
|
-
Use `/providers` to complete provider auth, then verify with `/status`.
|
|
177
|
-
|
|
178
|
-
### Auth endpoint unreachable
|
|
179
|
-
|
|
180
|
-
Use `/doctor` and confirm network access to:
|
|
181
|
-
|
|
182
|
-
- `https://auth.nyex.ai`
|
|
183
|
-
|
|
184
|
-
### Windows install fails with EPERM/TAR_ENTRY_ERROR on nyex.exe
|
|
185
|
-
|
|
186
|
-
This is usually antivirus lock/quarantine during npm extraction.
|
|
187
|
-
|
|
188
|
-
Recommended recovery:
|
|
189
|
-
|
|
190
|
-
```powershell
|
|
191
|
-
npm uninstall -g @nyex/nyex @nyex/nyex-win32-x64-msvc
|
|
192
|
-
npm cache clean --force
|
|
193
|
-
npm i -g @nyex/nyex
|
|
194
|
-
```
|
|
195
|
-
|
|
196
|
-
If it persists:
|
|
197
|
-
|
|
198
|
-
- restore file from AV quarantine
|
|
199
|
-
- add allow rules for npm global directory and `nyex.exe`
|
|
200
|
-
- retry install and verify with `nyex --version`
|
|
201
|
-
|
|
202
|
-
---
|
|
203
|
-
|
|
204
|
-
## Security and Guardrails
|
|
205
|
-
|
|
206
|
-
NYEX emphasizes runtime truth and controlled execution:
|
|
207
|
-
|
|
208
|
-
- deterministic routing traces
|
|
209
|
-
- explicit diagnostics surfaces
|
|
210
|
-
- policy/approval boundaries
|
|
211
|
-
- leak-scan and release hardening discipline
|
|
212
|
-
|
|
213
|
-
---
|
|
214
|
-
|
|
215
|
-
## Links
|
|
216
|
-
|
|
217
|
-
- Install: https://www.npmjs.com/package/@nyex/nyex
|
|
218
|
-
- Auth: https://auth.nyex.ai
|
|
219
|
-
- Health: https://auth.nyex.ai/health
|
|
220
|
-
- Website: https://nyex.ai
|
|
221
|
-
|
|
222
|
-
---
|
|
223
|
-
|
|
224
|
-
## License
|
|
225
|
-
|
|
226
|
-
See repository license.
|
|
227
|
-
|
|
228
|
-
Digilabs Company Australia © NYEX AI Platform. All rights reserved. AIC Pty Ltd (ACN 082 378 256)
|
|
1
|
+
# NYEX
|
|
2
|
+
|
|
3
|
+
**NYEX is a terminal-first agent runtime for production software work.**
|
|
4
|
+
It provides deterministic role-based execution, policy-aware control, and traceable runtime behavior across providers and models.
|
|
5
|
+
|
|
6
|
+
> **Defaults (v1.3.3)**
|
|
7
|
+
> - **Strict Cloud Mode: ON** (cloud failures do not silently fall back to local)
|
|
8
|
+
> - **Local Mode: OFF** (local proxy is disabled unless explicitly enabled)
|
|
9
|
+
> - **Capability Apps: OFF by default** (install + explicit enable required)
|
|
10
|
+
> - **Context Distillation shadow telemetry: OFF by default**
|
|
11
|
+
> - **Prompt replacement: OFF** (the model still receives the normal prompt)
|
|
12
|
+
> - **Context Distillation enforcement: OFF by default**
|
|
13
|
+
> - **Context Distillation telemetry: OFF by default**
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## Install
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npm i -g @nyex/nyex
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Verify:
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
nyex --version
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Quick Start
|
|
32
|
+
|
|
33
|
+
### 1) Launch NYEX
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
nyex
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### 2) Follow in-app onboarding
|
|
40
|
+
|
|
41
|
+
- NYEX account sign-in
|
|
42
|
+
- entitlement/plan selection
|
|
43
|
+
- provider connection
|
|
44
|
+
- model selection
|
|
45
|
+
|
|
46
|
+
### 3) Validate runtime state in NYEX TUI
|
|
47
|
+
|
|
48
|
+
Run these inside NYEX:
|
|
49
|
+
|
|
50
|
+
- `/status`
|
|
51
|
+
- `/doctor`
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Providers, Roles, Models
|
|
56
|
+
|
|
57
|
+
NYEX executes through deterministic runtime roles. Typical roles include:
|
|
58
|
+
|
|
59
|
+
- `primary`
|
|
60
|
+
- `planner`
|
|
61
|
+
- `tool_exec`
|
|
62
|
+
- `summarizer`
|
|
63
|
+
- `validator`
|
|
64
|
+
|
|
65
|
+
Role routing is provider/model mapped per role.
|
|
66
|
+
In runtime config, the primary route maps to the core chat role; in routing traces this is surfaced as `primary`.
|
|
67
|
+
|
|
68
|
+
Configure from inside NYEX:
|
|
69
|
+
|
|
70
|
+
- `/providers` to connect/manage provider auth
|
|
71
|
+
- `/models` to inspect and set model mappings
|
|
72
|
+
- `/settings` to tune runtime behavior and modes
|
|
73
|
+
|
|
74
|
+
If provider auth or entitlement is missing, onboarding and diagnostics make this explicit.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## Context Distillation (v1.3.3)
|
|
79
|
+
|
|
80
|
+
Context Distillation is enabled by default for runtime functionality in non-enforcing mode.
|
|
81
|
+
|
|
82
|
+
- Functionality default: `runtime_modes.context_distillation_phase2_enabled=false`
|
|
83
|
+
- Enforcement default: `runtime_modes.context_distillation_phase2_enforcement_enabled=false`
|
|
84
|
+
- Telemetry default: `features.context_distillation_telemetry=false`
|
|
85
|
+
|
|
86
|
+
What this means:
|
|
87
|
+
|
|
88
|
+
- Runtime behavior stays passthrough while enforcement is OFF.
|
|
89
|
+
- No blocking/retry/discard is introduced by default.
|
|
90
|
+
- You can view Context Distillation state and recent counters in `/status` and `/doctor`.
|
|
91
|
+
- You can toggle telemetry from `/settings` without disabling core functionality.
|
|
92
|
+
- Detailed runtime contract: `docs/CONTEXT_DISTILLATION.md` in the NYEX repository.
|
|
93
|
+
|
|
94
|
+
## What's New in 1.3.3
|
|
95
|
+
|
|
96
|
+
NYEX 1.3.3 focuses on behavioral stabilization: direct task fulfillment, safer quoted-reference handling, and quieter default governance behavior.
|
|
97
|
+
|
|
98
|
+
- Capability Apps are separate installable app releases (`.nyexpack`)
|
|
99
|
+
- Capability Apps are not bundled into NYEX Core payload
|
|
100
|
+
- Runtime surfaces include install/list/show/enable lifecycle and supervisor controls
|
|
101
|
+
- Deterministic non-TTY capability operations are supported
|
|
102
|
+
|
|
103
|
+
Version:
|
|
104
|
+
|
|
105
|
+
- `@nyex/nyex@1.3.3`
|
|
106
|
+
- `@nyex/nyex-win32-x64-msvc@1.3.3`
|
|
107
|
+
|
|
108
|
+
Release prep:
|
|
109
|
+
|
|
110
|
+
- Fresh Windows release binary is built from `codex-rs/target-release-npm/release/nyex.exe`.
|
|
111
|
+
|
|
112
|
+
---
|
|
113
|
+
|
|
114
|
+
## Core Runtime Capabilities
|
|
115
|
+
|
|
116
|
+
- Deterministic multi-role orchestration
|
|
117
|
+
- Planner-first decomposition for long or multi-step tasks
|
|
118
|
+
- Structured planner artifact handoff contract
|
|
119
|
+
- Trace-first diagnostics (`/status`, `/doctor`, `/trace`, `/signals explain`)
|
|
120
|
+
- Validator invariants (pre-final, no-tools)
|
|
121
|
+
- Canonical tool descriptors and lifecycle-normalized outcomes
|
|
122
|
+
- Descriptor-driven permission enforcement with explicit denial reasons
|
|
123
|
+
- Session continuity and resume flows
|
|
124
|
+
- Strict-cloud default posture with explicit local-mode opt-in
|
|
125
|
+
- Entitlement-first access gating for productive runtime use
|
|
126
|
+
- Capability App runtime host/operator controls
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## Runtime Modes
|
|
131
|
+
|
|
132
|
+
### Strict Cloud Mode (default)
|
|
133
|
+
|
|
134
|
+
When primary execution is cloud-backed and fails (auth/rate/network), NYEX does not silently switch to local providers.
|
|
135
|
+
|
|
136
|
+
### Local Mode (opt-in)
|
|
137
|
+
|
|
138
|
+
Local bridge/proxy is disabled by default and only activates when explicitly enabled.
|
|
139
|
+
|
|
140
|
+
Enable via `/settings` (recommended), or CLI override:
|
|
141
|
+
|
|
142
|
+
```bash
|
|
143
|
+
nyex -c runtime_modes.local_mode_enabled=true exec "hello"
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## Useful Commands (inside NYEX)
|
|
149
|
+
|
|
150
|
+
- `/settings` - runtime mode and behavior controls
|
|
151
|
+
- `/providers` - connect/manage providers
|
|
152
|
+
- `/models` - discover and assign models per role
|
|
153
|
+
- `/status` - auth/routing/runtime visibility
|
|
154
|
+
- `/doctor` - diagnostics and readiness checks
|
|
155
|
+
- `/signals explain` - routing and decision explanation
|
|
156
|
+
- `/tools` and `/tools show <tool_id>` - tool visibility and contracts
|
|
157
|
+
|
|
158
|
+
---
|
|
159
|
+
|
|
160
|
+
## Troubleshooting
|
|
161
|
+
|
|
162
|
+
### I see localhost/127.0.0.1 calls unexpectedly
|
|
163
|
+
|
|
164
|
+
- Check `/status` and verify local mode is disabled
|
|
165
|
+
- Confirm proxy is disabled
|
|
166
|
+
- Disable Local Mode in `/settings` if needed
|
|
167
|
+
|
|
168
|
+
### I am blocked by login or onboarding state
|
|
169
|
+
|
|
170
|
+
- Launch `nyex`
|
|
171
|
+
- Complete onboarding (sign-in, entitlement/plan, provider, model)
|
|
172
|
+
- Re-check `/status` and `/doctor`
|
|
173
|
+
|
|
174
|
+
### Provider not connected
|
|
175
|
+
|
|
176
|
+
Use `/providers` to complete provider auth, then verify with `/status`.
|
|
177
|
+
|
|
178
|
+
### Auth endpoint unreachable
|
|
179
|
+
|
|
180
|
+
Use `/doctor` and confirm network access to:
|
|
181
|
+
|
|
182
|
+
- `https://auth.nyex.ai`
|
|
183
|
+
|
|
184
|
+
### Windows install fails with EPERM/TAR_ENTRY_ERROR on nyex.exe
|
|
185
|
+
|
|
186
|
+
This is usually antivirus lock/quarantine during npm extraction.
|
|
187
|
+
|
|
188
|
+
Recommended recovery:
|
|
189
|
+
|
|
190
|
+
```powershell
|
|
191
|
+
npm uninstall -g @nyex/nyex @nyex/nyex-win32-x64-msvc
|
|
192
|
+
npm cache clean --force
|
|
193
|
+
npm i -g @nyex/nyex
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
If it persists:
|
|
197
|
+
|
|
198
|
+
- restore file from AV quarantine
|
|
199
|
+
- add allow rules for npm global directory and `nyex.exe`
|
|
200
|
+
- retry install and verify with `nyex --version`
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## Security and Guardrails
|
|
205
|
+
|
|
206
|
+
NYEX emphasizes runtime truth and controlled execution:
|
|
207
|
+
|
|
208
|
+
- deterministic routing traces
|
|
209
|
+
- explicit diagnostics surfaces
|
|
210
|
+
- policy/approval boundaries
|
|
211
|
+
- leak-scan and release hardening discipline
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
|
|
215
|
+
## Links
|
|
216
|
+
|
|
217
|
+
- Install: https://www.npmjs.com/package/@nyex/nyex
|
|
218
|
+
- Auth: https://auth.nyex.ai
|
|
219
|
+
- Health: https://auth.nyex.ai/health
|
|
220
|
+
- Website: https://nyex.ai
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
## License
|
|
225
|
+
|
|
226
|
+
See repository license.
|
|
227
|
+
|
|
228
|
+
Digilabs Company Australia © NYEX AI Platform. All rights reserved. AIC Pty Ltd (ACN 082 378 256)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nyex/nyex",
|
|
3
|
-
"version": "1.3.
|
|
4
|
-
"description": "Nyex CLI",
|
|
3
|
+
"version": "1.3.3",
|
|
4
|
+
"description": "Nyex CLI",
|
|
5
5
|
"license": "SEE LICENSE IN LICENSE",
|
|
6
6
|
"homepage": "https://www.npmjs.com/package/@nyex/nyex",
|
|
7
7
|
"repository": {
|
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
"nyex": "bin/nyex.js"
|
|
19
19
|
},
|
|
20
20
|
"optionalDependencies": {
|
|
21
|
-
"@nyex/nyex-win32-x64-msvc": "1.3.
|
|
21
|
+
"@nyex/nyex-win32-x64-msvc": "1.3.3"
|
|
22
22
|
},
|
|
23
23
|
"engines": {
|
|
24
24
|
"node": "\u003e=18"
|