@evident-ai/cli 3.1.1-dev.8d786ea → 3.1.1-dev.8dd11a1

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`.
@@ -110,7 +111,9 @@ targets the **production** Evident platform by default.
110
111
  that runner and resolves the runner ID automatically, so `--runner`/`--agent`
111
112
  is not required. Ideal for CI/CD. Preferred name; wins over `EVIDENT_AGENT_KEY`
112
113
  if both are set.
113
- - `EVIDENT_AGENT_KEY` — Alias for `EVIDENT_RUNNER_KEY` (still fully supported).
114
+ - `EVIDENT_AGENT_KEY` — Deprecated alias for `EVIDENT_RUNNER_KEY`. Still fully
115
+ supported, but `evident run` prints a deprecation warning when it is used
116
+ without `EVIDENT_RUNNER_KEY`.
114
117
  - `EVIDENT_TOKEN` — A user token used for authentication (alternative to a
115
118
  keychain login from `evident login`).
116
119
  - `EVIDENT_API_URL` — Override the API base URL (equivalent to `--endpoint`).
@@ -141,20 +144,21 @@ ID.
141
144
  From your project directory, start the runner:
142
145
 
143
146
  ```bash
144
- evident run --agent <agent-id>
147
+ evident run --runner <runner-id>
145
148
  ```
146
149
 
147
150
  `evident run` ensures `opencode serve` is running on `127.0.0.1:4096` (starting
148
151
  it if needed) and connects the tunnel. Once connected, the web shows the runner as
149
152
  online and you can open its chat.
150
153
 
151
- For CI or unattended use, set `EVIDENT_AGENT_KEY` and omit `--agent`:
154
+ For CI or unattended use, set `EVIDENT_RUNNER_KEY` and omit `--runner`:
152
155
 
153
156
  ```bash
154
- EVIDENT_AGENT_KEY=<agent-key> evident run --idle-timeout 30
157
+ EVIDENT_RUNNER_KEY=<runner-key> evident run --idle-timeout 30
155
158
  ```
156
159
 
157
- (`EVIDENT_RUNNER_KEY` is equivalent and the preferred name — use whichever you like.)
160
+ (`EVIDENT_AGENT_KEY` is a still-supported deprecated alias for
161
+ `EVIDENT_RUNNER_KEY`.)
158
162
 
159
163
  ## How it works
160
164
 
@@ -191,7 +195,7 @@ evident logout
191
195
  evident login
192
196
  ```
193
197
 
194
- In CI, make sure `EVIDENT_AGENT_KEY` (or `EVIDENT_TOKEN`) is set.
198
+ In CI, make sure `EVIDENT_RUNNER_KEY` (or `EVIDENT_TOKEN`) is set.
195
199
 
196
200
  ### OpenCode isn't reachable
197
201