@evident-ai/cli 3.0.1-dev.fffc02d → 3.1.1-dev.186f6ef
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 +25 -17
- package/dist/index.js +1265 -157
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@ Run OpenCode locally and connect it to the [Evident](https://evident.run) platfo
|
|
|
5
5
|
The `evident` CLI starts (or attaches to) `opencode serve` on your machine and
|
|
6
6
|
exposes it to Evident over a secure tunnel. Your code, secrets, and tools stay
|
|
7
7
|
local — only the messages you send travel through Evident. Once connected, you
|
|
8
|
-
can reach your
|
|
8
|
+
can reach your runner from the web and from Slack.
|
|
9
9
|
|
|
10
10
|
## Installation
|
|
11
11
|
|
|
@@ -65,13 +65,13 @@ evident whoami
|
|
|
65
65
|
|
|
66
66
|
### `evident run`
|
|
67
67
|
|
|
68
|
-
Connect to Evident and serve your
|
|
69
|
-
which
|
|
70
|
-
streaming tunnel (which transparently proxies the
|
|
68
|
+
Connect to Evident and serve your runner. `evident run` authenticates, resolves
|
|
69
|
+
which runner to run, ensures `opencode serve` is running on loopback, opens the
|
|
70
|
+
streaming tunnel (which transparently proxies the runner's web surface), and
|
|
71
71
|
delivers any channel messages (e.g. Slack) to your local OpenCode.
|
|
72
72
|
|
|
73
73
|
```bash
|
|
74
|
-
# Interactive: connect a specific
|
|
74
|
+
# Interactive: connect a specific runner
|
|
75
75
|
evident run --agent <agent-id>
|
|
76
76
|
|
|
77
77
|
# Drive a single conversation
|
|
@@ -83,10 +83,13 @@ evident run --agent <agent-id> --idle-timeout 30
|
|
|
83
83
|
|
|
84
84
|
Options:
|
|
85
85
|
|
|
86
|
-
- `-a, --agent [id]` —
|
|
87
|
-
is set (the
|
|
86
|
+
- `-a, --agent [id]` — Runner ID to connect to. Optional when `EVIDENT_AGENT_KEY`
|
|
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
89
|
- `-p, --port <port>` — OpenCode port (default: `4096`).
|
|
89
|
-
-
|
|
90
|
+
- `--log-level <level>` — Log verbosity: `debug | info | warn | error` (default:
|
|
91
|
+
`info`). Env: `EVIDENT_LOG_LEVEL`.
|
|
92
|
+
- `-v, --verbose` — Alias for `--log-level debug` (an explicit `--log-level` wins).
|
|
90
93
|
- `-c, --conversation <id>` — Process only this specific conversation.
|
|
91
94
|
- `--idle-timeout <seconds>` — Exit after N seconds with no pending work (useful
|
|
92
95
|
in CI to avoid polling indefinitely).
|
|
@@ -103,15 +106,18 @@ targets the **production** Evident platform by default.
|
|
|
103
106
|
|
|
104
107
|
## Environment variables
|
|
105
108
|
|
|
106
|
-
- `
|
|
107
|
-
that
|
|
108
|
-
required. Ideal for CI/CD.
|
|
109
|
+
- `EVIDENT_RUNNER_KEY` — A runner key. When set, `evident run` authenticates as
|
|
110
|
+
that runner and resolves the runner ID automatically, so `--runner`/`--agent`
|
|
111
|
+
is not required. Ideal for CI/CD. Preferred name; wins over `EVIDENT_AGENT_KEY`
|
|
112
|
+
if both are set.
|
|
113
|
+
- `EVIDENT_AGENT_KEY` — Alias for `EVIDENT_RUNNER_KEY` (still fully supported).
|
|
109
114
|
- `EVIDENT_TOKEN` — A user token used for authentication (alternative to a
|
|
110
115
|
keychain login from `evident login`).
|
|
111
116
|
- `EVIDENT_API_URL` — Override the API base URL (equivalent to `--endpoint`).
|
|
112
117
|
- `EVIDENT_TUNNEL_URL` — Override the tunnel relay URL (equivalent to `--tunnel`).
|
|
113
118
|
|
|
114
|
-
Authentication precedence for `run`: `EVIDENT_AGENT_KEY`
|
|
119
|
+
Authentication precedence for `run`: `EVIDENT_RUNNER_KEY`/`EVIDENT_AGENT_KEY`
|
|
120
|
+
(tied; `EVIDENT_RUNNER_KEY` wins if both are set) → `EVIDENT_TOKEN` →
|
|
115
121
|
credentials stored by `evident login`. For the URL flags, an explicit
|
|
116
122
|
`--endpoint` / `--tunnel` flag wins over the matching environment variable, which
|
|
117
123
|
in turn overrides the production default.
|
|
@@ -125,21 +131,21 @@ npm install -g @evident-ai/cli
|
|
|
125
131
|
evident login
|
|
126
132
|
```
|
|
127
133
|
|
|
128
|
-
### 2. Create
|
|
134
|
+
### 2. Create a runner
|
|
129
135
|
|
|
130
|
-
In the Evident web app, create
|
|
136
|
+
In the Evident web app, create a runner (it runs in local mode). Note its runner
|
|
131
137
|
ID.
|
|
132
138
|
|
|
133
139
|
### 3. Run it on your machine
|
|
134
140
|
|
|
135
|
-
From your project directory, start the
|
|
141
|
+
From your project directory, start the runner:
|
|
136
142
|
|
|
137
143
|
```bash
|
|
138
144
|
evident run --agent <agent-id>
|
|
139
145
|
```
|
|
140
146
|
|
|
141
147
|
`evident run` ensures `opencode serve` is running on `127.0.0.1:4096` (starting
|
|
142
|
-
it if needed) and connects the tunnel. Once connected, the web shows the
|
|
148
|
+
it if needed) and connects the tunnel. Once connected, the web shows the runner as
|
|
143
149
|
online and you can open its chat.
|
|
144
150
|
|
|
145
151
|
For CI or unattended use, set `EVIDENT_AGENT_KEY` and omit `--agent`:
|
|
@@ -148,6 +154,8 @@ For CI or unattended use, set `EVIDENT_AGENT_KEY` and omit `--agent`:
|
|
|
148
154
|
EVIDENT_AGENT_KEY=<agent-key> evident run --idle-timeout 30
|
|
149
155
|
```
|
|
150
156
|
|
|
157
|
+
(`EVIDENT_RUNNER_KEY` is equivalent and the preferred name — use whichever you like.)
|
|
158
|
+
|
|
151
159
|
## How it works
|
|
152
160
|
|
|
153
161
|
```
|
|
@@ -166,7 +174,7 @@ EVIDENT_AGENT_KEY=<agent-key> evident run --idle-timeout 30
|
|
|
166
174
|
2. It opens an outbound WebSocket to the Evident tunnel relay.
|
|
167
175
|
3. Evident routes web traffic and channel (e.g. Slack) messages through the
|
|
168
176
|
tunnel to your local OpenCode; responses flow back the same way.
|
|
169
|
-
4. Only one running copy of
|
|
177
|
+
4. Only one running copy of a runner is active at a time — starting a second copy
|
|
170
178
|
takes over.
|
|
171
179
|
|
|
172
180
|
See [ADR-0039](../../docs/decisions/0039-reuse-opencode-web-ui.md) and
|