Skip to content

Commit 0966ee4

Browse files
committed
Added Linux Docker Compose note under Quick Start for Issue keploy#3421
Signed-off-by: Sanika1356 <[email protected]>
1 parent 48ab301 commit 0966ee4

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,10 @@
3232
</a>
3333
</p>
3434

35-
3635
[Keploy](https://keploy.io) is a **developer‑centric API and integration testing tool** that auto‑generates **tests and data‑mocks** faster than unit tests.
3736

3837
It records API calls, database queries, and streaming events — then replays them as tests. Under the hood, Keploy **uses eBPF to capture traffic at the network layer,** but for you it’s completely **code‑less** and **language‑agnostic**.
3938

40-
4139
<img align="center" src="https://raw.githubusercontent.com/keploy/docs/main/static/gif/record-replay.gif" width="100%" alt="Convert API calls to API tests test cases and Data Mocks using AI"/>
4240

4341
> 🐰 **Fun fact:** Keploy uses itself for testing! Check out our swanky coverage badge: [![Coverage Status](https://coveralls.io/repos/github/keploy/keploy/badge.svg?branch=main&kill_cache=1)](https://coveralls.io/github/keploy/keploy?branch=main&kill_cache=1) &nbsp;
@@ -87,7 +85,6 @@ This helps expand API Schema, Statement, and Branch Coverage.
8785

8886
<img src="https://keploy-devrel.s3.us-west-2.amazonaws.com/ai+test+case+generation+that+works.png" width="100%" alt="ai test gen for api statement schema and branch coverage"/>
8987

90-
9188
### Other Capabilities
9289

9390
- 🌐 **CI/CD Integration:** Run tests with mocks anywhere you like—locally on the CLI, in your CI pipeline (Jenkins, Github Actions..) , or even across a Kubernetes cluster. [Read more](https://keploy.io/docs/running-keploy/api-testing-cicd/)
@@ -105,6 +102,16 @@ This helps expand API Schema, Statement, and Branch Coverage.
105102

106103
### 1. Install Keploy Agent
107104

105+
### ⚠️ Linux (Ubuntu/Debian) – Docker Compose Note
106+
107+
On Ubuntu/Debian systems, installing Docker using the default `docker.io`
108+
package may not include Docker Compose v2. This can cause
109+
Keploy Docker Compose–based samples to fail.
110+
111+
To avoid this issue, install Docker Engine and Docker Compose
112+
from Docker’s official repository so that the `docker compose`
113+
command works correctly.
114+
108115
```bash
109116
curl --silent -O -L https://keploy.io/install.sh && source install.sh
110117
```

0 commit comments

Comments
 (0)