Skip to content

Commit

Permalink
added keploy doc changes for flag --skip-preview (#432)
Browse files Browse the repository at this point in the history 
Signed-off-by: Debayan Ghosh <debayanghosh2406@gmail.com>
Signed-off-by: Animesh Pathak <kurosakiichigo.songoku@gmail.com>
Co-authored-by: Animesh Pathak <kurosakiichigo.songoku@gmail.com>
  • Loading branch information
@debayangg @Sonichigo @actions-user
2 people authored and actions-user committed Aug 8, 2024
1 parent 526e4d1 commit fcbecd8
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions versioned_docs/version-2.0.0/running-keploy/cli-commands.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit fcbecd8

Please sign in to comment.