-
Notifications
You must be signed in to change notification settings - Fork 44
Expand file tree
/
Copy pathindex.html
More file actions
382 lines (357 loc) · 15.1 KB
/
Copy pathindex.html
File metadata and controls
382 lines (357 loc) · 15.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Migrate from VidaiMock — aimock</title>
<meta
name="description"
content="Switching from VidaiMock to aimock — a conversion guide covering CLI, fixtures, and feature comparison."
/>
<link rel="icon" type="image/svg+xml" href="../favicon.svg" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link
href="https://fonts.googleapis.com/css2?family=JetBrains+Mono:ital,wght@0,300;0,400;0,500;0,600;0,700;1,400&family=Instrument+Sans:wght@400;500;600;700&display=swap"
rel="stylesheet"
/>
<link rel="stylesheet" href="../style.css" />
<script src="/pixels.js" defer></script>
</head>
<body>
<nav class="top-nav">
<div class="nav-inner">
<div style="display: flex; align-items: center; gap: 1rem">
<button
class="sidebar-toggle"
onclick="document.querySelector('.sidebar').classList.toggle('open')"
aria-label="Toggle sidebar"
>
☰
</button>
<a href="/" class="nav-brand"> <span class="prompt">$</span> aimock </a>
</div>
<ul class="nav-links">
<li><a href="/">Home</a></li>
<li><a href="/docs" style="color: var(--accent)">Docs</a></li>
<li>
<a href="https://github.com/CopilotKit/aimock" class="gh-link" target="_blank"
><svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor">
<path
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
/>
</svg>
GitHub</a
>
</li>
</ul>
</div>
</nav>
<div class="docs-layout">
<aside class="sidebar" id="sidebar"></aside>
<main class="docs-content">
<h1>Switching from VidaiMock to aimock</h1>
<p class="lead">
VidaiMock is a capable Rust binary with broad provider support. aimock matches that
coverage and adds what VidaiMock can’t — a programmatic TypeScript API,
WebSocket support, fixture files, request journal, and MCP/A2A/AG-UI/Vector mocking.
</p>
<!-- ═══ The quick switch ══════════════════════════════════════ -->
<h2>The quick switch</h2>
<p>The CLI flags map directly. Swap the binary name, adjust the flag names, and go:</p>
<div class="code-block">
<div class="code-block-header">
VidaiMock
<span class="lang-tag">shell</span>
</div>
<pre><code>vidaimock --port 4010 --template-dir ./templates</code></pre>
</div>
<div class="cli-docker-tabs">
<div class="tab-cli">
<div class="code-block">
<div class="code-block-header">
aimock (equivalent)
<span class="lang-tag">shell</span>
</div>
<pre><code>npx -p @copilotkit/aimock llmock -p 4010 -f ./fixtures</code></pre>
</div>
</div>
<div class="tab-docker">
<div class="code-block">
<div class="code-block-header">
aimock (equivalent)
<span class="lang-tag">shell</span>
</div>
<pre><code>docker run -d -p 4010:4010 \
-v ./fixtures:/fixtures \
ghcr.io/copilotkit/aimock \
-p 4010 -f /fixtures -h 0.0.0.0</code></pre>
</div>
</div>
</div>
<h3>Fixture format comparison</h3>
<p>
VidaiMock uses Tera templates (<code>.tera</code>) to build responses dynamically. aimock
uses plain JSON fixture files — no template language, no compilation step.
</p>
<div class="code-block">
<div class="code-block-header">
VidaiMock — Tera template
<span class="lang-tag">tera</span>
</div>
<pre><code>{
<span class="prop">"model"</span>: <span class="str">"{{ model }}"</span>,
<span class="prop">"choices"</span>: [{
<span class="prop">"message"</span>: {
<span class="prop">"role"</span>: <span class="str">"assistant"</span>,
<span class="prop">"content"</span>: <span class="str">"Hello from VidaiMock"</span>
}
}]
}</code></pre>
</div>
<div class="code-block">
<div class="code-block-header">
aimock — JSON fixture
<span class="lang-tag">json</span>
</div>
<pre><code>{
<span class="prop">"match"</span>: { <span class="prop">"userMessage"</span>: <span class="str">"hello"</span> },
<span class="prop">"response"</span>: { <span class="prop">"content"</span>: <span class="str">"Hello from aimock"</span> }
}</code></pre>
</div>
<p>
aimock fixtures are declarative: you specify <em>what to match</em> and
<em>what to return</em>. The server handles model names, streaming format, and
provider-specific envelope generation automatically.
</p>
<!-- ═══ What you gain ═════════════════════════════════════════ -->
<h2>What you gain</h2>
<div class="feature-grid">
<div class="feature-link">
<span class="badge badge-green">API</span>
<h3>Programmatic API</h3>
<p>
Import <code>LLMock</code> in TypeScript/JavaScript and configure fixtures,
assertions, and lifecycle in code — no process spawning needed.
</p>
</div>
<div class="feature-link">
<span class="badge badge-blue">Transport</span>
<h3>WebSocket APIs</h3>
<p>
Built-in support for OpenAI Realtime, OpenAI Responses WS, and Gemini Live —
three WebSocket protocols out of the box.
</p>
</div>
<div class="feature-link">
<span class="badge badge-purple">Testing</span>
<h3>Request journal</h3>
<p>
Every request is recorded with full headers, body, matched fixture, and timing.
<code>getRequests()</code> lets you assert on what your app actually sent.
</p>
</div>
<div class="feature-link">
<span class="badge badge-amber">Protocols</span>
<h3>MCP / A2A / AG-UI / Vector</h3>
<p>Mock your entire AI stack — LLM, MCP, A2A, AG-UI, vector — on one port.</p>
</div>
<div class="feature-link">
<span class="badge badge-purple">Capture</span>
<h3>Record & replay</h3>
<p>
Proxy to real APIs, capture responses as fixtures, then replay deterministically in
CI. No manual fixture authoring required.
</p>
</div>
<div class="feature-link">
<span class="badge badge-red">CI</span>
<h3>Drift detection</h3>
<p>
Automated three-way conformance testing against live provider APIs. Catch breaking
changes before your users do.
</p>
</div>
<div class="feature-link">
<span class="badge badge-amber">Format</span>
<h3>Structured output</h3>
<p>
JSON mode and <code>response_format</code> matching for structured responses —
match on schema, return typed JSON.
</p>
</div>
<div class="feature-link">
<span class="badge badge-green">Stateful</span>
<h3>Sequential responses</h3>
<p>
Return different responses on successive calls to the same endpoint. Model multi-turn
conversations and retry scenarios.
</p>
</div>
</div>
<!-- ═══ Comparison table ══════════════════════════════════════ -->
<h2>Comparison table</h2>
<table class="endpoint-table">
<thead>
<tr>
<th>Capability</th>
<th>VidaiMock</th>
<th>aimock</th>
</tr>
</thead>
<tbody>
<tr>
<td>Programmatic API</td>
<td>No (binary only)</td>
<td>Yes (TypeScript/JS)</td>
</tr>
<tr>
<td>WebSocket APIs</td>
<td>No</td>
<td>Built-in (3 protocols)</td>
</tr>
<tr>
<td>Request journal</td>
<td>No</td>
<td>Built-in</td>
</tr>
<tr>
<td>MCP / A2A / AG-UI / Vector</td>
<td>No</td>
<td>Built-in</td>
</tr>
<tr>
<td>Record & replay</td>
<td>No</td>
<td>Built-in</td>
</tr>
<tr>
<td>Drift detection</td>
<td>No</td>
<td>Automated CI</td>
</tr>
<tr>
<td>LLM providers</td>
<td>11+</td>
<td>11+</td>
</tr>
<tr>
<td>Prometheus metrics</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Chaos testing</td>
<td>Partial</td>
<td>Built-in (3 modes)</td>
</tr>
<tr>
<td>Docker</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr>
<td>Streaming physics</td>
<td>Yes</td>
<td>Built-in (ttft/tps/jitter)</td>
</tr>
<tr>
<td>Dependencies</td>
<td>Zero (Rust)</td>
<td>Zero (Node.js builtins)</td>
</tr>
</tbody>
</table>
<!-- ═══ CLI / Docker quick start ══════════════════════════════ -->
<h2>CLI / Docker quick start</h2>
<div class="cli-docker-tabs">
<div class="tab-cli active">
<div class="code-block">
<div class="code-block-header">
Install & run
<span class="lang-tag">shell</span>
</div>
<pre><code><span class="cm"># Run the mock server (flag-driven llmock bin)</span>
npx -p @copilotkit/aimock llmock -p 4010 -f ./fixtures
<span class="cm"># Point your app at it</span>
<span class="kw">export</span> OPENAI_BASE_URL=http://localhost:4010/v1
<span class="kw">export</span> OPENAI_API_KEY=mock-key</code></pre>
</div>
<div class="code-block">
<div class="code-block-header">
With a config file
<span class="lang-tag">shell</span>
</div>
<pre><code><span class="cm"># Full config-driven setup (LLM + MCP + A2A + AG-UI on one port)</span>
npx @copilotkit/aimock --config aimock.json --port 4010</code></pre>
</div>
</div>
<div class="tab-docker">
<div class="code-block">
<div class="code-block-header">
Docker run
<span class="lang-tag">shell</span>
</div>
<pre><code><span class="cm"># Pull and run from GitHub Container Registry</span>
docker pull ghcr.io/copilotkit/aimock:latest
docker run -p 4010:4010 \
-v $(pwd)/fixtures:/fixtures \
ghcr.io/copilotkit/aimock -f /fixtures -h 0.0.0.0</code></pre>
</div>
<p style="color: var(--text-dim); font-size: 0.9em; margin-top: 0.75em">
<strong>Note:</strong> <code>--config</code> (and the <code>convert</code> subcommand)
are only available through the <code>npx @copilotkit/aimock</code> entrypoint or a
local install. The published Docker image at
<code>ghcr.io/copilotkit/aimock</code> runs the narrower flag-driven
<code>llmock</code> CLI — for config-driven mode, run aimock on your host via
npx, or install <code>@copilotkit/aimock</code> inside your own container.
</p>
<div class="code-block">
<div class="code-block-header">
Config-driven (local / npx)
<span class="lang-tag">shell</span>
</div>
<pre><code><span class="cm"># Full config-driven setup (LLM + MCP + A2A + AG-UI on one port)</span>
npx @copilotkit/aimock --config aimock.json --port 4010</code></pre>
</div>
<div class="code-block">
<div class="code-block-header">
docker-compose.yml
<span class="lang-tag">yaml</span>
</div>
<pre><code><span class="prop">services</span>:
<span class="prop">aimock</span>:
<span class="prop">image</span>: <span class="str">ghcr.io/copilotkit/aimock:latest</span>
<span class="prop">command</span>: <span class="str">["-f", "/app/fixtures", "-h", "0.0.0.0"]</span>
<span class="prop">ports</span>:
- <span class="str">"4010:4010"</span>
<span class="prop">volumes</span>:
- <span class="str">./fixtures:/app/fixtures:ro</span>
<span class="prop">app</span>:
<span class="prop">build</span>: <span class="str">.</span>
<span class="prop">environment</span>:
<span class="prop">OPENAI_BASE_URL</span>: <span class="str">http://aimock:4010/v1</span>
<span class="prop">OPENAI_API_KEY</span>: <span class="str">mock-key</span>
<span class="prop">depends_on</span>:
- <span class="str">aimock</span></code></pre>
</div>
</div>
</div>
</main>
<aside class="page-toc" id="page-toc"></aside>
</div>
<footer class="docs-footer">
<div class="footer-inner">
<div class="footer-left"><span>$</span> aimock · MIT License</div>
<ul class="footer-links">
<li><a href="https://github.com/CopilotKit/aimock" target="_blank">GitHub</a></li>
<li>
<a href="https://www.npmjs.com/package/@copilotkit/aimock" target="_blank">npm</a>
</li>
</ul>
</div>
</footer>
<script src="../sidebar.js"></script>
<script src="../cli-tabs.js"></script>
</body>
</html>