From d9d7ee9968e743bb5518da27e2094b3919345b26 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Wed, 21 Oct 2026 02:43:03 +0530 Subject: [PATCH 1/3] docs: drop --delay from the keploy record examples `keploy record` has had no --delay flag since the v2 CLI refactor (keploy/keploy#1684 kept it on `keploy test` only, the one command that waits for the application before it sends requests). Record starts the application and captures the calls that reach it; it sends none of its own, so it has nothing to wait for. The first record command on the Linux, macOS and Windows server installation pages, and in the StartKeployDocker component, still passed `--delay 10`, so a new user following them got `Error: unknown flag: --delay` and exit code 8 before anything was recorded. The CLI reference also listed `-d, --delay` among record's flags, with a record example using it. Remove --delay from those record commands and from record's flag list in the CLI reference. `keploy test --delay` is unchanged. Signed-off-by: slayerjain --- src/components/StartKeployDocker.js | 2 +- .../version-4.0.0/running-keploy/cli-commands.md | 8 +------- versioned_docs/version-4.0.0/server/linux/installation.md | 2 +- versioned_docs/version-4.0.0/server/macos/installation.md | 2 +- .../version-4.0.0/server/windows/installation.md | 2 +- 5 files changed, 5 insertions(+), 11 deletions(-) diff --git a/src/components/StartKeployDocker.js b/src/components/StartKeployDocker.js index 916f7c8b63..7a153daceb 100644 --- a/src/components/StartKeployDocker.js +++ b/src/components/StartKeployDocker.js @@ -25,7 +25,7 @@ export default function StartKeploy() { Record the test cases

- {`keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" --delay 10`} + {`keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName ""`}

diff --git a/versioned_docs/version-4.0.0/running-keploy/cli-commands.md b/versioned_docs/version-4.0.0/running-keploy/cli-commands.md index edada8f290..d00fe0c5b1 100755 --- a/versioned_docs/version-4.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-4.0.0/running-keploy/cli-commands.md @@ -29,7 +29,7 @@ Here are some examples of how to use some common flags: | Command | Flags Available | | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `record` | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--metadata`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug` | +| `record` | `-c, --command`, `--config-path`, `--containerName`, `--metadata`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug` | | `test` | `--apiTimeout`, `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--mongoPassword`, `-n, --net, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `-t, --testsets`, `--debug`, `-g, --generateTestReport`, `--removeUnusedMocks`, `--coverage`, `--goCoverage`, `--ignoreOrdering`, `--skip-preview`, `--proto-dir`, `--proto-file`, `--proto-include` | | `gen` (Deprecated) | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | | `normalize` | `-p, --path`, `--test-run`, `--tests` | @@ -74,12 +74,6 @@ keploy record -c "docker compose up" --container-name "my-app-container" > **Podman:** on Linux, with the Keploy that `install.sh` installs (v3.8.60 or later), an application started in rootful Podman with `podman run` or `podman compose` works the same way: `keploy record -c "podman compose up" --container-name "my-app-container"`. See [Platform requirements](/docs/concepts/platform-requirements/#podman) for what `podman compose` needs. -- `-d, --delay uint` - Delay in seconds to run user application. The default is 5 seconds. - -```bash -keploy record -c "node src/app.js" -d 10 -``` - - `--metadata string` - Key-value pairs to be added as metadata in the config.yaml file. If a `name` key is provided, it will be used as the test set name. ```bash diff --git a/versioned_docs/version-4.0.0/server/linux/installation.md b/versioned_docs/version-4.0.0/server/linux/installation.md index d3825f48b4..83c2eb90fd 100644 --- a/versioned_docs/version-4.0.0/server/linux/installation.md +++ b/versioned_docs/version-4.0.0/server/linux/installation.md @@ -93,7 +93,7 @@ docker network create keploy-network Now, we will record the testcases. ```shell -keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" --delay 10 +keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" ``` #### Run the Testcases diff --git a/versioned_docs/version-4.0.0/server/macos/installation.md b/versioned_docs/version-4.0.0/server/macos/installation.md index 93554f878a..921f4100c1 100644 --- a/versioned_docs/version-4.0.0/server/macos/installation.md +++ b/versioned_docs/version-4.0.0/server/macos/installation.md @@ -153,7 +153,7 @@ Here are few points to consider before recording! Utilize keploy to capture testcases. **Execute** the following command within your application's **root directory**. ```shell -keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" --delay 10 +keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" ``` Make API Calls using Postman, or cURL commands. diff --git a/versioned_docs/version-4.0.0/server/windows/installation.md b/versioned_docs/version-4.0.0/server/windows/installation.md index 196a9373e3..e705e7f3bc 100644 --- a/versioned_docs/version-4.0.0/server/windows/installation.md +++ b/versioned_docs/version-4.0.0/server/windows/installation.md @@ -145,7 +145,7 @@ docker network create keploy-network Now, we record the testcases. ```shell -keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" --delay 10 +keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" ``` #### Run the Test Mode From 0d3dbedbde996861f9dbfcca894a6852423bed59 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Wed, 21 Oct 2026 08:31:09 +0530 Subject: [PATCH 2/3] docs: drop --delay from the 2.0.0 keploy record examples too The 2.0.0 docs are still built and served (marked unmaintained, not indexed), and they had the same first record command: keploy record -c "docker run ..." --containerName "" --delay 10 Every v2 CLI from v2.1.0-alpha1 on refuses it with `unknown flag: --delay`, because keploy/keploy#1684 registered --delay on `keploy test` only. The v2.0.x CLIs accepted the flag on record but never read it, so dropping it is right for every v2 release. - The Linux, macOS and Windows server installation pages: --delay is removed from the record command. - The CLI reference: `-d, --delay` is removed from record's flags, with the record `-d 10` example under it. - The echo quickstart's "Run the captured testcases" step ran `keploy record ... --delay 10`. It now runs `keploy test`, as the 3.0.0 and 4.0.0 pages of that quickstart do. --delay 10 stays: it is a flag of test. Signed-off-by: slayerjain --- versioned_docs/version-2.0.0/quickstart/samples-echo.md | 2 +- .../version-2.0.0/running-keploy/cli-commands.md | 8 +------- versioned_docs/version-2.0.0/server/linux/installation.md | 2 +- versioned_docs/version-2.0.0/server/macos/installation.md | 2 +- .../version-2.0.0/server/windows/installation.md | 2 +- 5 files changed, 5 insertions(+), 11 deletions(-) diff --git a/versioned_docs/version-2.0.0/quickstart/samples-echo.md b/versioned_docs/version-2.0.0/quickstart/samples-echo.md index ea923135fe..0a8f4dbaea 100644 --- a/versioned_docs/version-2.0.0/quickstart/samples-echo.md +++ b/versioned_docs/version-2.0.0/quickstart/samples-echo.md @@ -211,7 +211,7 @@ Now both these API calls were captured as a testcase and should be visible on th Now that we have our testcase captured, run the test file. ```shell -sudo -E PATH=$PATH keploy record -c "./echo-psql-url-shortener" --delay 10 +sudo -E PATH=$PATH keploy test -c "./echo-psql-url-shortener" --delay 10 ``` So no need to setup dependencies like mongoDB, web-go locally or write mocks for your testing. diff --git a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md index 117f8aaf96..9c58f35a2e 100755 --- a/versioned_docs/version-2.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-2.0.0/running-keploy/cli-commands.md @@ -25,7 +25,7 @@ Here are some examples of how to use some common flags: | Command | Flags Available | | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `record` | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug` | +| `record` | `-c, --command`, `--config-path`, `--containerName`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug` | | `test` | `--apiTimeout`, `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--mongoPassword`, `-n, --net, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `-t, --testsets`, `--debug`, `-g, --generateTestReport`, `--removeUnusedMocks`, `--coverage`, `--goCoverage`, `--ignoreOrdering`, `--skip-preview` | | `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | | `normailze` | `-p, --path`, `--test-run`, `--tests` | @@ -66,12 +66,6 @@ keploy record [flags] keploy record -c "docker compose up" --container-name "my-app-container" ``` -- `-d, --delay uint` - Delay in seconds to run user application. The default is 5 seconds. - - ```bash - keploy record -c "node src/app.js" -d 10 - ``` - - `- n, --network-name string` - Name of the docker network in which the user application is running. ```bash diff --git a/versioned_docs/version-2.0.0/server/linux/installation.md b/versioned_docs/version-2.0.0/server/linux/installation.md index 2903eab365..7f6dddc8e9 100644 --- a/versioned_docs/version-2.0.0/server/linux/installation.md +++ b/versioned_docs/version-2.0.0/server/linux/installation.md @@ -102,7 +102,7 @@ docker network create keploy-network Now, we will record the testcases. ```shell -keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" --delay 10 +keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" ``` #### Run the Testcases diff --git a/versioned_docs/version-2.0.0/server/macos/installation.md b/versioned_docs/version-2.0.0/server/macos/installation.md index c339cc0012..7b92856a6e 100644 --- a/versioned_docs/version-2.0.0/server/macos/installation.md +++ b/versioned_docs/version-2.0.0/server/macos/installation.md @@ -101,7 +101,7 @@ Here are few points to consider before recording! Utilize keploy to capture testcases. **Execute** the following command within your application's **root directory**. ```shell -keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" --delay 10 +keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" ``` Make API Calls using Postman , or cURL commands. diff --git a/versioned_docs/version-2.0.0/server/windows/installation.md b/versioned_docs/version-2.0.0/server/windows/installation.md index c6691c9415..67e5f9f066 100644 --- a/versioned_docs/version-2.0.0/server/windows/installation.md +++ b/versioned_docs/version-2.0.0/server/windows/installation.md @@ -121,7 +121,7 @@ docker network create keploy-network Now, we record the testcases. ```shell -keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" --delay 10 +keploy record -c "docker run -p : --name --network keploy-network --rm " --containerName "" ``` #### Run the Test Mode From 21abfc82433cdad7327c20ef65a567f51d1582b4 Mon Sep 17 00:00:00 2001 From: slayerjain Date: Wed, 21 Oct 2026 15:47:35 +0530 Subject: [PATCH 3/3] docs: fix the record and test flags the CLI reference lists but keploy refuses The 4.0.0 CLI reference listed flags that both the open-source and the enterprise keploy binaries refuse with `unknown flag` (exit 8). Each listed flag and each command line on the page was checked by running it with --help under both binaries. - record row: `--proxyport` is now `--proxy-port`. - test row: - `--proxyport` is now `--proxy-port`. - `--net` is dropped from `-n, --net, --networkName`. - `-g, --generateTestReport` is dropped. Neither binary has it; the report is always written. - `--coverage` and `--goCoverage` are replaced by `--skip-coverage`. Coverage is computed by default; that flag turns it off. - `--skip-preview` is now `--disable-line-coverage`, the flag keploy/keploy#2170 added for that preview. - The test section's `-g=false` example is removed, and its `--skip-preview` example now uses `--disable-line-coverage`. - record's `--rerecord "test-set-0"` example, the `rerecord` table row and the `rerecord` section are removed. keploy/keploy#4127 removed the rerecord command from the open-source CLI, and the enterprise CLI has no rerecord command or --rerecord flag either, so `keploy rerecord ... --delay 10` ended in `unknown command "rerecord"`. After this change, every flag in the record and test rows, and every keploy command line on the page, is accepted by both binaries. The two exceptions are the `keploy [command] [flags]` and `keploy gen [flags]` syntax lines, which are not commands. Signed-off-by: slayerjain --- .../running-keploy/cli-commands.md | 61 ++++--------------- 1 file changed, 11 insertions(+), 50 deletions(-) diff --git a/versioned_docs/version-4.0.0/running-keploy/cli-commands.md b/versioned_docs/version-4.0.0/running-keploy/cli-commands.md index d00fe0c5b1..d3ca1ea77b 100755 --- a/versioned_docs/version-4.0.0/running-keploy/cli-commands.md +++ b/versioned_docs/version-4.0.0/running-keploy/cli-commands.md @@ -27,16 +27,15 @@ You can use `--help, -h` flag for all the commands to see available flag options Here are some examples of how to use some common flags: -| Command | Flags Available | -| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `record` | `-c, --command`, `--config-path`, `--containerName`, `--metadata`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `--debug` | -| `test` | `--apiTimeout`, `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--mongoPassword`, `-n, --net, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxyport`, `-t, --testsets`, `--debug`, `-g, --generateTestReport`, `--removeUnusedMocks`, `--coverage`, `--goCoverage`, `--ignoreOrdering`, `--skip-preview`, `--proto-dir`, `--proto-file`, `--proto-include` | -| `gen` (Deprecated) | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | -| `normalize` | `-p, --path`, `--test-run`, `--tests` | -| `rerecord` | `--test-sets`, `-t` | -| `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--body` | -| `sanitize` | `--test-sets, -t`, `-p, --path` | -| `config` | `--generate`,`-p, --path` | +| Command | Flags Available | +| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `record` | `-c, --command`, `--config-path`, `--containerName`, `--metadata`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxy-port`, `--debug` | +| `test` | `--apiTimeout`, `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--mongoPassword`, `-n, --networkName`, `--passThroughPorts`, `-p, --path`, `--proxy-port`, `-t, --testsets`, `--debug`, `--removeUnusedMocks`, `--skip-coverage`, `--ignoreOrdering`, `--disable-line-coverage`, `--proto-dir`, `--proto-file`, `--proto-include` | +| `gen` (Deprecated) | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | +| `normalize` | `-p, --path`, `--test-run`, `--tests` | +| `report` | `--test-sets, -t`, `-p, --path`, `--report-path, -r`, `--body` | +| `sanitize` | `--test-sets, -t`, `-p, --path` | +| `config` | `--generate`,`-p, --path` | ## [record](#record) @@ -113,12 +112,6 @@ keploy record -c "node src/app.js" --proxy-port 8080 keploy record -c "node src/app.js" --debug ``` -- `rerecord` - Record certain test-sets again - -```bash -keploy record -c "node src/app.js" --rerecord "test-set-0" -``` - ## [test](#test) The `test` mode in Keploy allows the user to run the recoded testcases from the API calls and execute assertion. A detailed report is produced after the tests are executed and it's then saved in the yaml format in `keploy/reports` directory in the current working directory. @@ -205,12 +198,6 @@ keploy test -c "node src/app.js" -t "test-set-1,test-set-3" --delay 10 keploy test -c "node src/app.js" --delay 10 --debug ``` -- `-g, --generate-test-report` - To generate the test report. The default is true. - -```bash -keploy test -c "node src/app.js" --delay 10 -g=false -``` - - `--remove-unused-mocks` - To remove unused mocks from mock file. The default is false. ```bash @@ -225,10 +212,10 @@ keploy test -c "node src/app.js" --delay 10 --ignore-ordering - `--skip-coverage` - skip code coverage computation while running the test cases -- `--skip-preview` - skip line by line code coverage preview but display the total coverage. +- `--disable-line-coverage` - skip the line by line code coverage preview of a JavaScript application, but display the total coverage. ```bash -keploy test -c "node src/app.js" --delay 10 --skip-preview +keploy test -c "node src/app.js" --delay 10 --disable-line-coverage ``` - `--jacoco-agent-path` - Only applicable for test coverage for Java projects. You can override the jacoco agent jar by providing its path @@ -329,32 +316,6 @@ keploy normalize -p "./tests" --test-run "test-run-10" --tests "test-set-1:test- keploy normalize --allow-high-risk ``` -## [rerecord](#rerecord) - -The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testset(s). - -**Usage:** - -```bash -keploy rerecord -c "node src/app.js" -t "test-set-0" -``` - -**Docker Example:** - -To re-record test cases for an application running inside a Docker container, use the Docker run command as the value for the `-c` flag: - -```bash -keploy rerecord -c "sudo docker run -p 5000:5000 --name flask-jwt-app --network keploy-network flask-jwt-app" -t "test-set-0" --delay 10 -``` - -**`--delay` flag:** - -The `--delay` flag specifies the number of seconds Keploy should wait after starting your application before replaying requests to re-record. -This is useful if your application takes some time to start (for example, when running inside a Docker container or a heavy framework). - -- Adjust the delay to match your app's startup time. -- For example, use `--delay 10` to wait for 10 seconds. - ## [report](#report) The `report` command in Keploy is used to display a detailed summary of test results. It can show a compact table-style diff or full body diffs (with colorized JSON), and it can read from the latest test run or a specific report file.