Skip to content

Commit ff7011d

Browse files
committed
fix: use scoped npx @copilotkit/aimock in all docs and scripts
npx aimock resolves to a different, unrelated package on npm (aimock@0.2.9). Our package is @copilotkit/aimock, so all CLI examples must use the scoped name. Updated README, docs site HTML, CHANGELOG, and converter scripts. Closes #112
1 parent 687a493 commit ff7011d

26 files changed

Lines changed: 74 additions & 72 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
### Minor Changes
66

77
- Add GitHub Action for one-line CI setup — `uses: CopilotKit/aimock@v1` with fixtures, config, port, args, and health check (#102)
8-
- Wire fixture converters into CLI — `npx aimock convert vidaimock` and `npx aimock convert mockllm` as first-class subcommands (#102)
8+
- Wire fixture converters into CLI — `npx @copilotkit/aimock convert vidaimock` and `npx @copilotkit/aimock convert mockllm` as first-class subcommands (#102)
99
- Add 30 npm keywords for search discoverability (#102)
1010
- Add fixture gallery with 11 examples covering all mock types, plus browsable docs page at /examples (#102)
1111
- Add vitest and jest plugins for zero-config testing — `import { useAimock } from "@copilotkit/aimock/vitest"` (#102)

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ aimock mocks everything your AI app talks to:
3737
| **VectorMock** | Pinecone, Qdrant, ChromaDB compatible endpoints | [Vector](https://aimock.copilotkit.dev/vector-mock) |
3838
| **Services** | Tavily search, Cohere rerank, OpenAI moderation | [Services](https://aimock.copilotkit.dev/services) |
3939

40-
Run them all on one port with `npx aimock --config aimock.json`, or use the programmatic API to compose exactly what you need.
40+
Run them all on one port with `npx @copilotkit/aimock --config aimock.json`, or use the programmatic API to compose exactly what you need.
4141

4242
## Features
4343

@@ -72,17 +72,17 @@ See the [GitHub Action docs](https://aimock.copilotkit.dev/github-action) for al
7272
7373
```bash
7474
# LLM mocking only
75-
npx aimock -p 4010 -f ./fixtures
75+
npx @copilotkit/aimock -p 4010 -f ./fixtures
7676

7777
# Full suite from config
78-
npx aimock --config aimock.json
78+
npx @copilotkit/aimock --config aimock.json
7979

8080
# Record mode: proxy to real APIs, save fixtures
81-
npx aimock --record --provider-openai https://api.openai.com
81+
npx @copilotkit/aimock --record --provider-openai https://api.openai.com
8282

8383
# Convert fixtures from other tools
84-
npx aimock convert vidaimock ./templates/ ./fixtures/
85-
npx aimock convert mockllm ./config.yaml ./fixtures/
84+
npx @copilotkit/aimock convert vidaimock ./templates/ ./fixtures/
85+
npx @copilotkit/aimock convert mockllm ./config.yaml ./fixtures/
8686

8787
# Docker
8888
docker run -d -p 4010:4010 -v ./fixtures:/fixtures ghcr.io/copilotkit/aimock -f /fixtures

docs/agui-mock/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,7 @@ <h2>Record &amp; Replay</h2>
241241
<h2>CLI Usage</h2>
242242
<div class="code-block">
243243
<div class="code-block-header">CLI flags <span class="lang-tag">shell</span></div>
244-
<pre><code>npx aimock --fixtures ./fixtures \
244+
<pre><code>npx @copilotkit/aimock --fixtures ./fixtures \
245245
--agui-record \
246246
--agui-upstream http://localhost:8000/agent</code></pre>
247247
</div>

docs/aimock-cli/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ <h2>Quick Start</h2>
5959
<div class="tab-cli">
6060
<div class="code-block">
6161
<div class="code-block-header">Run aimock <span class="lang-tag">shell</span></div>
62-
<pre><code>$ npx aimock --config aimock.json --port 4010</code></pre>
62+
<pre><code>$ npx @copilotkit/aimock --config aimock.json --port 4010</code></pre>
6363
</div>
6464
</div>
6565
<div class="tab-docker">
@@ -69,7 +69,7 @@ <h2>Quick Start</h2>
6969
-v ./aimock.json:/config.json \
7070
-v ./fixtures:/fixtures \
7171
ghcr.io/copilotkit/aimock \
72-
npx aimock --config /config.json --port 4010</code></pre>
72+
npx @copilotkit/aimock --config /config.json --port 4010</code></pre>
7373
</div>
7474
</div>
7575
</div>
@@ -228,7 +228,7 @@ <h2>Docker Usage</h2>
228228
<div class="code-block-header">
229229
Run with config <span class="lang-tag">shell</span>
230230
</div>
231-
<pre><code>$ npx aimock --config aimock.json --host 0.0.0.0</code></pre>
231+
<pre><code>$ npx @copilotkit/aimock --config aimock.json --host 0.0.0.0</code></pre>
232232
</div>
233233
</div>
234234
<div class="tab-docker">
@@ -241,7 +241,7 @@ <h2>Docker Usage</h2>
241241
-v ./aimock.json:/config.json \
242242
-v ./fixtures:/fixtures \
243243
ghcr.io/copilotkit/aimock \
244-
npx aimock --config /config.json --host 0.0.0.0</code></pre>
244+
npx @copilotkit/aimock --config /config.json --host 0.0.0.0</code></pre>
245245
</div>
246246
</div>
247247
</div>
@@ -252,7 +252,7 @@ <h2>Fixture Converters</h2>
252252
<h3>Usage</h3>
253253
<div class="code-block">
254254
<div class="code-block-header">Convert fixtures <span class="lang-tag">shell</span></div>
255-
<pre><code>npx aimock convert &lt;format&gt; &lt;input&gt; [output]</code></pre>
255+
<pre><code>npx @copilotkit/aimock convert &lt;format&gt; &lt;input&gt; [output]</code></pre>
256256
</div>
257257

258258
<h3>Supported Formats</h3>
@@ -290,13 +290,13 @@ <h3>Examples</h3>
290290
Converter examples <span class="lang-tag">shell</span>
291291
</div>
292292
<pre><code><span class="cm"># Convert a directory of VidaiMock templates</span>
293-
$ npx aimock convert vidaimock ./templates/ ./fixtures/converted.json
293+
$ npx @copilotkit/aimock convert vidaimock ./templates/ ./fixtures/converted.json
294294

295295
<span class="cm"># Convert a mock-llm YAML config</span>
296-
$ npx aimock convert mockllm ./config.yaml ./fixtures/converted.json
296+
$ npx @copilotkit/aimock convert mockllm ./config.yaml ./fixtures/converted.json
297297

298298
<span class="cm"># Print to stdout (omit output path)</span>
299-
$ npx aimock convert vidaimock ./templates/</code></pre>
299+
$ npx @copilotkit/aimock convert vidaimock ./templates/</code></pre>
300300
</div>
301301

302302
<h2>Docker Compose</h2>

docs/chaos-testing/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h2>CLI Flags</h2>
217217
<div class="code-block-header">
218218
CLI chaos flags <span class="lang-tag">shell</span>
219219
</div>
220-
<pre><code>$ npx aimock --fixtures ./fixtures \
220+
<pre><code>$ npx @copilotkit/aimock --fixtures ./fixtures \
221221
--chaos-drop 0.1 \
222222
--chaos-malformed 0.05 \
223223
--chaos-disconnect 0.02</code></pre>
@@ -231,7 +231,7 @@ <h2>CLI Flags</h2>
231231
<pre><code>$ docker run -d -p 4010:4010 \
232232
-v ./fixtures:/fixtures \
233233
ghcr.io/copilotkit/aimock \
234-
npx aimock --fixtures /fixtures \
234+
npx @copilotkit/aimock --fixtures /fixtures \
235235
--chaos-drop 0.1 \
236236
--chaos-malformed 0.05 \
237237
--chaos-disconnect 0.02</code></pre>

docs/docker/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,10 @@ <h3>Run with local fixtures</h3>
6666
<div class="tab-cli">
6767
<div class="code-block">
6868
<div class="code-block-header">Run <span class="lang-tag">shell</span></div>
69-
<pre><code>$ npx aimock --fixtures ./fixtures
69+
<pre><code>$ npx @copilotkit/aimock --fixtures ./fixtures
7070

7171
<span class="cm"># Custom port</span>
72-
$ npx aimock --fixtures ./fixtures --port 5555</code></pre>
72+
$ npx @copilotkit/aimock --fixtures ./fixtures --port 5555</code></pre>
7373
</div>
7474
</div>
7575
<div class="tab-docker">
@@ -84,7 +84,7 @@ <h3>Run with local fixtures</h3>
8484
$ docker run -p 5555:5555 \
8585
-v ./fixtures:/fixtures \
8686
ghcr.io/copilotkit/aimock \
87-
npx aimock --fixtures /fixtures --port 5555
87+
--fixtures /fixtures --port 5555
8888

8989
<span class="cm"># Pull from GitHub Container Registry</span>
9090
$ docker pull ghcr.io/copilotkit/aimock:latest

docs/images/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,7 @@ <h2>Record &amp; Replay</h2>
264264

265265
<div class="code-block">
266266
<div class="code-block-header">CLI <span class="lang-tag">sh</span></div>
267-
<pre><code>npx aimock --record --provider-openai https://api.openai.com</code></pre>
267+
<pre><code>npx @copilotkit/aimock --record --provider-openai https://api.openai.com</code></pre>
268268
</div>
269269
</main>
270270
<aside class="page-toc" id="page-toc"></aside>

docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1225,7 +1225,7 @@ <h3>Replay</h3>
12251225
<span class="title">terminal</span>
12261226
</div>
12271227
<div class="demo-body">
1228-
<pre><span class="t-green">$</span> npx aimock --record --provider-openai https://api.openai.com
1228+
<pre><span class="t-green">$</span> npx @copilotkit/aimock --record --provider-openai https://api.openai.com
12291229

12301230
<span class="t-blue">&#9889;</span> Listening on http://localhost:4010
12311231

@@ -1329,7 +1329,7 @@ <h2 class="fade-in">
13291329
<span class="title">terminal</span>
13301330
</div>
13311331
<div class="demo-body">
1332-
<pre><span class="t-green">$</span> npx aimock --config aimock.json
1332+
<pre><span class="t-green">$</span> npx @copilotkit/aimock --config aimock.json
13331333

13341334
<span class="t-blue">&#9889;</span> aimock v1.0.0
13351335

@@ -1875,7 +1875,7 @@ <h2 class="fade-in">Built for production</h2>
18751875
// ── Terminal demo animation ──────────────────────────────────────
18761876
var termSteps = [
18771877
// Step 1: User types command
1878-
{ type: "prompt", text: "npx aimock -p 4010 -f ./fixture.json", delay: 600 },
1878+
{ type: "prompt", text: "npx @copilotkit/aimock -p 4010 -f ./fixture.json", delay: 600 },
18791879
// Step 2: Server starts
18801880
{
18811881
type: "line",

docs/integrate-adk/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ <h2>Quick Start</h2>
7878
</p>
7979
<div class="code-block">
8080
<div class="code-block-header">Start aimock <span class="lang-tag">shell</span></div>
81-
<pre><code>npx aimock --fixtures fixtures/examples/adk/gemini-agent.json</code></pre>
81+
<pre><code>npx @copilotkit/aimock --fixtures fixtures/examples/adk/gemini-agent.json</code></pre>
8282
</div>
8383

8484
<h2>Gemini API Format</h2>

docs/integrate-crewai/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ <h2>Quick Start</h2>
7272
<span class="lang-tag">shell</span>
7373
</div>
7474
<pre><code><span class="cm"># Terminal 1 &mdash; start the mock server</span>
75-
npx aimock --fixtures ./fixtures
75+
npx @copilotkit/aimock --fixtures ./fixtures
7676

7777
<span class="cm"># Terminal 2 &mdash; run your CrewAI script</span>
7878
<span class="kw">export</span> OPENAI_BASE_URL=http://localhost:4010/v1
@@ -333,7 +333,7 @@ <h2>Record &amp; Replay</h2>
333333
<div class="code-block">
334334
<div class="code-block-header">Record a crew run <span class="lang-tag">shell</span></div>
335335
<pre><code><span class="cm"># Start aimock in record mode &mdash; unmatched requests go to OpenAI</span>
336-
npx aimock --fixtures ./fixtures \
336+
npx @copilotkit/aimock --fixtures ./fixtures \
337337
--record \
338338
--provider-openai https://api.openai.com
339339

0 commit comments

Comments
 (0)