@evident-ai/cli 3.0.1-dev.fffc02d → 3.1.1-dev.019c4e9

package/README.md

@@ -5,7 +5,7 @@ Run OpenCode locally and connect it to the [Evident](https://evident.run) platfo
 The `evident` CLI starts (or attaches to) `opencode serve` on your machine and
 exposes it to Evident over a secure tunnel. Your code, secrets, and tools stay
 local — only the messages you send travel through Evident. Once connected, you
-can reach your agent from the web and from Slack.
+can reach your runner from the web and from Slack.
 
 ## Installation
 
@@ -65,28 +65,32 @@ evident whoami
 
 ### `evident run`
 
-Connect to Evident and serve your agent. `evident run` authenticates, resolves
-which agent to run, ensures `opencode serve` is running on loopback, opens the
-streaming tunnel (which transparently proxies the agent's web surface), and
+Connect to Evident and serve your runner. `evident run` authenticates, resolves
+which runner to run, ensures `opencode serve` is running on loopback, opens the
+streaming tunnel (which transparently proxies the runner's web surface), and
 delivers any channel messages (e.g. Slack) to your local OpenCode.
 
 ```bash
-# Interactive: connect a specific agent
-evident run --agent <agent-id>
+# Interactive: connect a specific runner
+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]` — Agent ID to connect to. Optional when `EVIDENT_AGENT_KEY`
-  is set (the agent is then resolved automatically from the 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`).
-- `-v, --verbose` — Show detailed request/response information.
+- `--log-level <level>` — Log verbosity: `debug | info | warn | error` (default:
+  `info`). Env: `EVIDENT_LOG_LEVEL`.
+- `-v, --verbose` — Alias for `--log-level debug` (an explicit `--log-level` wins).
 - `-c, --conversation <id>` — Process only this specific conversation.
 - `--idle-timeout <seconds>` — Exit after N seconds with no pending work (useful
   in CI to avoid polling indefinitely).
@@ -103,15 +107,20 @@ targets the **production** Evident platform by default.
 
 ## Environment variables
 
-- `EVIDENT_AGENT_KEY` — An agent key. When set, `evident run` authenticates as
-  that agent and resolves the agent 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.
@@ -125,29 +134,32 @@ npm install -g @evident-ai/cli
 evident login
 ```
 
-### 2. Create an agent
+### 2. Create a runner
 
-In the Evident web app, create an agent (it runs in local mode). Note its agent
+In the Evident web app, create a runner (it runs in local mode). Note its runner
 ID.
 
 ### 3. Run it on your machine
 
-From your project directory, start the agent:
+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 agent as
+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
 
 ```
@@ -166,7 +178,7 @@ EVIDENT_AGENT_KEY=<agent-key> evident run --idle-timeout 30
 2. It opens an outbound WebSocket to the Evident tunnel relay.
 3. Evident routes web traffic and channel (e.g. Slack) messages through the
    tunnel to your local OpenCode; responses flow back the same way.
-4. Only one running copy of an agent is active at a time — starting a second copy
+4. Only one running copy of a runner is active at a time — starting a second copy
    takes over.
 
 See [ADR-0039](../../docs/decisions/0039-reuse-opencode-web-ui.md) and
@@ -183,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