@evident-ai/cli 3.1.1-dev.9ff0701 → 3.1.1-dev.b4e1c75

package/README.md

@@ -72,19 +72,21 @@ delivers any channel messages (e.g. Slack) to your local OpenCode.
 
 ```bash
 # Interactive: connect a specific runner
-evident run --agent <agent-id>
+evident run --runner <runner-id>
 
 # Drive a single conversation
-evident run --agent <agent-id> --conversation <conversation-id>
+evident run --runner <runner-id> --conversation <conversation-id>
 
 # CI: exit after 30s with no work
-evident run --agent <agent-id> --idle-timeout 30
+evident run --runner <runner-id> --idle-timeout 30
 ```
 
 Options:
 
-- `-a, --agent [id]` — Runner ID to connect to. Optional when `EVIDENT_AGENT_KEY`
+- `--runner [id]` — Runner ID to connect to. Optional when `EVIDENT_RUNNER_KEY`
   is set (the runner is then resolved automatically from the key).
+- `-a, --agent [id]` — Deprecated alias for `--runner`. Still supported, but it
+  prints a deprecation warning; `--runner` wins if both are given.
 - `-p, --port <port>` — OpenCode port (default: `4096`).
 - `--log-level <level>` — Log verbosity: `debug | info | warn | error` (default:
   `info`). Env: `EVIDENT_LOG_LEVEL`.
@@ -105,15 +107,20 @@ targets the **production** Evident platform by default.
 
 ## Environment variables
 
-- `EVIDENT_AGENT_KEY` — A runner key. When set, `evident run` authenticates as
-  that runner and resolves the runner ID automatically, so `--agent` is not
-  required. Ideal for CI/CD.
+- `EVIDENT_RUNNER_KEY` — A runner key. When set, `evident run` authenticates as
+  that runner and resolves the runner ID automatically, so `--runner`/`--agent`
+  is not required. Ideal for CI/CD. Preferred name; wins over `EVIDENT_AGENT_KEY`
+  if both are set.
+- `EVIDENT_AGENT_KEY` — Deprecated alias for `EVIDENT_RUNNER_KEY`. Still fully
+  supported, but `evident run` prints a deprecation warning when it is used
+  without `EVIDENT_RUNNER_KEY`.
 - `EVIDENT_TOKEN` — A user token used for authentication (alternative to a
   keychain login from `evident login`).
 - `EVIDENT_API_URL` — Override the API base URL (equivalent to `--endpoint`).
 - `EVIDENT_TUNNEL_URL` — Override the tunnel relay URL (equivalent to `--tunnel`).
 
-Authentication precedence for `run`: `EVIDENT_AGENT_KEY` → `EVIDENT_TOKEN` →
+Authentication precedence for `run`: `EVIDENT_RUNNER_KEY`/`EVIDENT_AGENT_KEY`
+(tied; `EVIDENT_RUNNER_KEY` wins if both are set) → `EVIDENT_TOKEN` →
 credentials stored by `evident login`. For the URL flags, an explicit
 `--endpoint` / `--tunnel` flag wins over the matching environment variable, which
 in turn overrides the production default.
@@ -137,19 +144,22 @@ ID.
 From your project directory, start the runner:
 
 ```bash
-evident run --agent <agent-id>
+evident run --runner <runner-id>
 ```
 
 `evident run` ensures `opencode serve` is running on `127.0.0.1:4096` (starting
 it if needed) and connects the tunnel. Once connected, the web shows the runner as
 online and you can open its chat.
 
-For CI or unattended use, set `EVIDENT_AGENT_KEY` and omit `--agent`:
+For CI or unattended use, set `EVIDENT_RUNNER_KEY` and omit `--runner`:
 
 ```bash
-EVIDENT_AGENT_KEY=<agent-key> evident run --idle-timeout 30
+EVIDENT_RUNNER_KEY=<runner-key> evident run --idle-timeout 30
 ```
 
+(`EVIDENT_AGENT_KEY` is a still-supported deprecated alias for
+`EVIDENT_RUNNER_KEY`.)
+
 ## How it works
 
 ```
@@ -185,7 +195,7 @@ evident logout
 evident login
 ```
 
-In CI, make sure `EVIDENT_AGENT_KEY` (or `EVIDENT_TOKEN`) is set.
+In CI, make sure `EVIDENT_RUNNER_KEY` (or `EVIDENT_TOKEN`) is set.
 
 ### OpenCode isn't reachable