Home

Welcome to the Keploy Wiki

What is Keploy?

🧑‍🏫 Keploy is a 100% open source platform that contributes towards making E2E testing easy for developers by eliminating the need for writing test-cases and data mocks. It record test cases by capturing all network calls for an API request and replaying them later during testing. Mocks are automatically generated with the actual request/responses.

Quick Installation 🚀

Integrate Keploy by installing the agent locally. No code-changes required.

curl --silent -O -L https://keploy.io/install.sh && source install.sh

Recording Testcases 🎬

Start your app wit Keploy to convert API calls as Tests and Mocks/Stubs.

keploy record -c "CMD_TO_RUN_APP" 

For example, if you're using a simple Python app the CMD_TO_RUN_APP would resemble to python main.py, for Golang go run main.go, for java java -jar xyz.jar, for node npm start..

keploy record -c "python main.py"

Running Tests 🧪

Shut down the databases, redis, kafka or any other services your application uses. Keploy doesn't need those during test.

keploy test -c "CMD_TO_RUN_APP" --delay 10

Test Coverage Integration ✅

To integrate with your unit-testing library and see combine test coverage, follow this test-coverage guide.

Languages Supported

🤝 Keploy currently supports and works well with the following languages:

👨🏻‍💻 Let's Build Together! 👩🏻‍💻

Whether you're a newbie coder or a wizard 🧙‍♀️, your perspective is golden. Take a peek at our:

📜 Contribution Guidelines

❤️ Code of Conduct

Tried Keploy and have doubts or faced problems?

🫶 Join the community and ask for help or share your experience.

Resources!

🤔 FAQs

🕵️‍️ Why Keploy

⚙️ Installation Guide

📖 Contribution Guide