From fcbecd82aa5546247be67a765ad8af8f1678e73e Mon Sep 17 00:00:00 2001 From: Debayan Ghosh <66942246+debayangg@users.noreply.github.com> Date: Thu, 8 Aug 2024 13:33:31 +0530 Subject: [PATCH] added keploy doc changes for flag --skip-preview (#432) Signed-off-by: Debayan Ghosh Signed-off-by: Animesh Pathak Co-authored-by: Animesh Pathak --- .../running-keploy/cli-commands.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) 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 150fe121..fa14f96a 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 @@ -23,14 +23,14 @@ 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: -| Mode | Flags Available | -| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `record` | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `-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`, `--disable-line-coverage` | -| `gen` | `--sourceFilePath`, `--testFilePath`,`--coverageReportPath`,`--testCommand`,`--coverageFormat`,`--expectedCoverage`,`--maxIterations`,`--testDir`,`--llmBaseUrl`,`--model`,`--llmApiVersion` | -| `normailze` | `-p, --path`, `--test-run`, `--tests` | -| `rerecord` | `--test-sets`, `-t` | -| `config` | `--generate`,`-p, --path` | +| Mode | Flags Available | +| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `record` | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `-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` | +| `rerecord` | `--test-sets`, `-t` | +| `config` | `--generate`,`-p, --path` | ## [record](#record) @@ -211,10 +211,10 @@ keploy test [flags] - `--skip-coverage` - skip code coverage computation while running the test cases -- `--disable-line-coverage` - skip line by line code coverage but display the total coverage. +- `--skip-preview` - skip line by line code coverage preview but display the total coverage. ```bash - keploy test -c "node src/app.js" --delay 10 --disable-line-coverage + keploy test -c "node src/app.js" --delay 10 --skip-preview ``` - `--jacoco-agent-path` - Only applicable for test coverage for Java projects. You can override the jacoco agent jar by providing its path