@evident-ai/cli 3.1.1-dev.993411a → 3.1.1-dev.9e90301

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 CHANGED
@@ -72,20 +72,21 @@ delivers any channel messages (e.g. Slack) to your local OpenCode.
72
72
 
73
73
  ```bash
74
74
  # Interactive: connect a specific runner
75
- evident run --agent <agent-id>
75
+ evident run --runner <runner-id>
76
76
 
77
77
  # Drive a single conversation
78
- evident run --agent <agent-id> --conversation <conversation-id>
78
+ evident run --runner <runner-id> --conversation <conversation-id>
79
79
 
80
80
  # CI: exit after 30s with no work
81
- evident run --agent <agent-id> --idle-timeout 30
81
+ evident run --runner <runner-id> --idle-timeout 30
82
82
  ```
83
83
 
84
84
  Options:
85
85
 
86
- - `-a, --agent [id]` — Runner ID to connect to. Optional when `EVIDENT_AGENT_KEY`
86
+ - `--runner [id]` — Runner ID to connect to. Optional when `EVIDENT_RUNNER_KEY`
87
87
  is set (the runner is then resolved automatically from the key).
88
- - `--runner [id]` — Alias for `--agent` (preferred name; wins if both are given).
88
+ - `-a, --agent [id]` — Deprecated alias for `--runner`. Still supported, but it
89
+ prints a deprecation warning; `--runner` wins if both are given.
89
90
  - `-p, --port <port>` — OpenCode port (default: `4096`).
90
91
  - `--log-level <level>` — Log verbosity: `debug | info | warn | error` (default:
91
92
  `info`). Env: `EVIDENT_LOG_LEVEL`.
@@ -93,6 +94,17 @@ Options:
93
94
  - `-c, --conversation <id>` — Process only this specific conversation.
94
95
  - `--idle-timeout <seconds>` — Exit after N seconds with no pending work (useful
95
96
  in CI to avoid polling indefinitely).
97
+ - `--opencode-start-timeout <seconds>` — How long to wait for OpenCode to become
98
+ healthy when the runner starts it itself (default: `180`). On expiry the runner
99
+ warns and comes online anyway rather than failing. Env:
100
+ `EVIDENT_OPENCODE_START_TIMEOUT` (seconds).
101
+ - `--claude-usage-reporting <mode>` — Whether to report the local Claude Code
102
+ subscription's rate-limit usage to Evident, so it shows on the runner page:
103
+ `auto` (default) reports it when a usable Claude Code login is found on this
104
+ machine and stays silent otherwise; `on` forces reporting and warns loudly (and
105
+ keeps retrying) if no usable login is found; `off` disables it entirely — no
106
+ Claude credential is ever read. An unrecognized value falls back to `auto` with
107
+ a warning. Env: `EVIDENT_CLAUDE_USAGE_REPORTING`.
96
108
  - `--json` — Output in JSON format (forces non-interactive mode).
97
109
 
98
110
  ## Global flags
@@ -110,11 +122,15 @@ targets the **production** Evident platform by default.
110
122
  that runner and resolves the runner ID automatically, so `--runner`/`--agent`
111
123
  is not required. Ideal for CI/CD. Preferred name; wins over `EVIDENT_AGENT_KEY`
112
124
  if both are set.
113
- - `EVIDENT_AGENT_KEY` — Alias for `EVIDENT_RUNNER_KEY` (still fully supported).
125
+ - `EVIDENT_AGENT_KEY` — Deprecated alias for `EVIDENT_RUNNER_KEY`. Still fully
126
+ supported, but `evident run` prints a deprecation warning when it is used
127
+ without `EVIDENT_RUNNER_KEY`.
114
128
  - `EVIDENT_TOKEN` — A user token used for authentication (alternative to a
115
129
  keychain login from `evident login`).
116
130
  - `EVIDENT_API_URL` — Override the API base URL (equivalent to `--endpoint`).
117
131
  - `EVIDENT_TUNNEL_URL` — Override the tunnel relay URL (equivalent to `--tunnel`).
132
+ - `EVIDENT_CLAUDE_USAGE_REPORTING` — Equivalent to `--claude-usage-reporting`; the
133
+ flag wins if both are set.
118
134
 
119
135
  Authentication precedence for `run`: `EVIDENT_RUNNER_KEY`/`EVIDENT_AGENT_KEY`
120
136
  (tied; `EVIDENT_RUNNER_KEY` wins if both are set) → `EVIDENT_TOKEN` →
@@ -141,20 +157,21 @@ ID.
141
157
  From your project directory, start the runner:
142
158
 
143
159
  ```bash
144
- evident run --agent <agent-id>
160
+ evident run --runner <runner-id>
145
161
  ```
146
162
 
147
163
  `evident run` ensures `opencode serve` is running on `127.0.0.1:4096` (starting
148
164
  it if needed) and connects the tunnel. Once connected, the web shows the runner as
149
165
  online and you can open its chat.
150
166
 
151
- For CI or unattended use, set `EVIDENT_AGENT_KEY` and omit `--agent`:
167
+ For CI or unattended use, set `EVIDENT_RUNNER_KEY` and omit `--runner`:
152
168
 
153
169
  ```bash
154
- EVIDENT_AGENT_KEY=<agent-key> evident run --idle-timeout 30
170
+ EVIDENT_RUNNER_KEY=<runner-key> evident run --idle-timeout 30
155
171
  ```
156
172
 
157
- (`EVIDENT_RUNNER_KEY` is equivalent and the preferred name — use whichever you like.)
173
+ (`EVIDENT_AGENT_KEY` is a still-supported deprecated alias for
174
+ `EVIDENT_RUNNER_KEY`.)
158
175
 
159
176
  ## How it works
160
177
 
@@ -191,7 +208,7 @@ evident logout
191
208
  evident login
192
209
  ```
193
210
 
194
- In CI, make sure `EVIDENT_AGENT_KEY` (or `EVIDENT_TOKEN`) is set.
211
+ In CI, make sure `EVIDENT_RUNNER_KEY` (or `EVIDENT_TOKEN`) is set.
195
212
 
196
213
  ### OpenCode isn't reachable
197
214