help: using aimock in terminal

[janiussyafiq]

Currently I want to have a mock LLM endpoint that I can call to test my API gateway, but running any of these doesn't seem to work (no output):

# LLM mocking only
npx aimock -p 4010 -f ./fixtures

# Full suite from config
npx aimock --config aimock.json

# Record mode: proxy to real APIs, save fixtures
npx aimock --record --provider-openai https://api.openai.com

# Convert fixtures from other tools
npx aimock convert vidaimock ./templates/ ./fixtures/
npx aimock convert mockllm ./config.yaml ./fixtures/

Is there any additional set up I need to do? Thanks!

[jpr5]

Thanks for the report, @janiussyafiq — this is a documentation bug on our side.

The npm package is @copilotkit/aimock, but our README and docs show npx aimock (without the scope). There's also a separate, unrelated aimock package on npm (v0.2.9, "An OpenAI api simulator"), so npx aimock silently downloads and runs the wrong tool.

Fix — use the scoped package name:

# LLM mocking only
npx @copilotkit/aimock -p 4010 -f ./fixtures

# Full suite from config
npx @copilotkit/aimock --config aimock.json

# Record mode
npx @copilotkit/aimock --record --provider-openai https://api.openai.com

# Convert fixtures
npx @copilotkit/aimock convert vidaimock ./templates/ ./fixtures/
npx @copilotkit/aimock convert mockllm ./config.yaml ./fixtures/

Or install locally and the aimock bin name works:

npm install @copilotkit/aimock
npx aimock -p 4010 -f ./fixtures  # works after local install

We're fixing the docs now — PR incoming.