Skip to content

docs: add protos flags #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 5, 2025
Merged

docs: add protos flags #717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions versioned_docs/version-1.0.0/java/quickstart/spring-sql.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,8 +209,7 @@ _NOTE: You will be required to set the `javaagent` again in your test profile ju
</plugin>
```

{'<'}/details{'>'}
2. If you want coverage report also add Jacoco plugin to your _pom.xml_.
{'<'}/details{'>'} 2. If you want coverage report also add Jacoco plugin to your _pom.xml_.

{'<'}details{'>'}{'<'}summary{'>'}
Add plugin
Expand Down Expand Up @@ -253,8 +252,7 @@ _NOTE: You will be required to set the `javaagent` again in your test profile ju
</plugin>
```

{'<'}/details{'>'}
3. Run your tests using command : `mvn test`.
{'<'}/details{'>'} 3. Run your tests using command : `mvn test`.

It will create .html files as test-reports which can be found in your target folder !!

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-2.0.0/running-keploy/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ keploy [command] [flags]

You can use `--help, -h` flag for all the commands to see available flag options and their purpose.

## Modes and Flags
## Commands and Flags

Here are some examples of how to use some common flags:

| Mode | Flags Available |
| Command | 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` |
Expand Down
42 changes: 31 additions & 11 deletions versioned_docs/version-3.0.0/running-keploy/cli-commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,20 +19,20 @@

You can use `--help, -h` flag for all the commands to see available flag options and their purpose.

## Modes and Flags
## Commands and Flags

Here are some examples of how to use some common flags:

| Mode | Flags Available |
| ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `record` | `-c, --command`, `--config-path`, `--containerName`, `-d, --delay`, `--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` |
| `gen` | `--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`, `-d, --delay`, `--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` | `--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` |

## [record](#record)

Expand All @@ -54,7 +54,7 @@

In the command above, `node src/app.js` is the command which starts the user application.

- `--config-path string` - Path to the Keploy configuration file. The default is ".".

Check failure on line 57 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L57 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 57, "column": 82}}}, "severity": "ERROR"}

```bash
keploy record -c "node src/app.js" --config-path "./config-dir/"
Expand Down Expand Up @@ -121,7 +121,7 @@

## [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.

Check failure on line 124 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L124 

[Vale.Spelling] Did you really mean 'yaml'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'yaml'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 124, "column": 200}}}, "severity": "ERROR"}

<b> Usage: </b>

Expand All @@ -145,7 +145,7 @@

In the command above, `node src/app.js` is the command which starts the user application.

- `--config-path string` - Path to the Keploy configuration file. The default is ".".

Check failure on line 148 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L148 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 148, "column": 82}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --config-path "./config-dir/"
Expand All @@ -165,7 +165,7 @@
keploy test -c "node src/app.js" --delay 10
```

- `--mongo-password string` - Authentication password for mocking MongoDB connection. The default password is "default123".

Check failure on line 168 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L168 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 168, "column": 111}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --mongo-password "my-password"
Expand Down Expand Up @@ -233,6 +233,26 @@

- `--jacoco-agent-path` - Only applicable for test coverage for Java projects. You can override the jacoco agent jar by providing its path

- `--proto-dir string` - Path of the directory where all protos of a service are located. Used for GRPC test cases to enable better deterministic and proper comparison of protobuf responses.

Check failure on line 236 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L236 

[Vale.Spelling] Did you really mean 'protos'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'protos'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 236, "column": 58}}}, "severity": "ERROR"}

Check failure on line 236 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L236 

[Vale.Spelling] Did you really mean 'protobuf'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'protobuf'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 236, "column": 172}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --proto-dir "./protos"
```

- `--proto-file string` - Path of main proto file. Used for GRPC test cases to enable better deterministic and proper comparison of protobuf responses. Either `--proto-file` or `--proto-dir` must be provided for GRPC tests.

Check failure on line 242 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L242 

[Vale.Spelling] Did you really mean 'proto'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 242, "column": 40}}}, "severity": "ERROR"}

Check failure on line 242 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L242 

[Vale.Spelling] Did you really mean 'protobuf'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'protobuf'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 242, "column": 133}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --proto-file "./protos/main.proto"
```

- `--proto-include stringArray` - Path of directories to be included while parsing import statements in proto files. This is optional and used for GRPC test cases when proto files have import dependencies.

Check failure on line 248 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L248 

[Vale.Spelling] Did you really mean 'proto'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 248, "column": 105}}}, "severity": "ERROR"}

```bash
keploy test -c "node src/app.js" --proto-file "./protos/main.proto" --proto-include "./protos/common,./protos/shared"
```

> **Note for GRPC Tests:** When running GRPC test cases, it's recommended to provide proto information using either `--proto-file` or `--proto-dir` flags. If proto information is not provided, Keploy will use basic canonical matching of the protoscopic textual format of GRPC response body, which may be less accurate than proto-based comparison.

Check failure on line 254 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L254 

[Vale.Spelling] Did you really mean 'proto'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 254, "column": 88}}}, "severity": "ERROR"}

Check failure on line 254 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L254 

[Vale.Spelling] Did you really mean 'proto'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'proto'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 254, "column": 161}}}, "severity": "ERROR"}

Check failure on line 254 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L254 

[Vale.Spelling] Did you really mean 'protoscopic'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'protoscopic'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 254, "column": 244}}}, "severity": "ERROR"}

## [gen](#gen)

The `gen` cmd in Keploy allows user to generate unit tests using LLM Models.
Expand Down Expand Up @@ -261,11 +281,11 @@

- `testDir` - Directory where tests will be written.

- `llmBaseUrl` - Base url of the llm.

Check failure on line 284 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L284 

[Vale.Spelling] Did you really mean 'llm'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'llm'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 284, "column": 34}}}, "severity": "ERROR"}

- `model` - Specifies the AI model to use by default it uses "gpt-4o" model.

- `llmApiVersion` - API version of the llm if any.

Check failure on line 288 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L288 

[Vale.Spelling] Did you really mean 'llm'?
Raw output 
{"message": "[Vale.Spelling] Did you really mean 'llm'?", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 288, "column": 40}}}, "severity": "ERROR"}

## [normalize](#normalize)

Expand Down Expand Up @@ -309,7 +329,7 @@

## [rerecord](#rerecord)

The `rerecord` command allows users to record new Keploy test cases and mocks from existing test cases for the given testset(s).

Check failure on line 332 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L332 

[Google.OptionalPlurals] Don't use plurals in parentheses such as in 'testset(s)'.
Raw output 
{"message": "[Google.OptionalPlurals] Don't use plurals in parentheses such as in 'testset(s)'.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 332, "column": 118}}}, "severity": "ERROR"}

**Usage:**

Expand Down Expand Up @@ -351,7 +371,7 @@
keploy report -t "test-set-1"
```

- `-p, --path string` - Path to the local directory where generated testcases/mocks are stored. Default is ".".

Check failure on line 374 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L374 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 374, "column": 108}}}, "severity": "ERROR"}

```bash
keploy report -p "./keploy-tests"
Expand All @@ -369,7 +389,7 @@
keploy report -t "test-set-1" --full
```

- `--summary` - Print only a summarized view (grand totals and per–test-set table with time taken). Useful for a quick dashboard-style overview. Can be combined with `-t/--test-sets` and `--report-path`.

Check failure on line 392 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L392 

[Google.EnDash] Use an em dash ('—') instead of '–'.
Raw output 
{"message": "[Google.EnDash] Use an em dash ('—') instead of '–'.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 392, "column": 67}}}, "severity": "ERROR"}

```bash
keploy report --summary
Expand All @@ -385,7 +405,7 @@
>
> - By default, `report` shows only **failed** tests with a compact, human-readable diff (status, headers—including trailers/content-length where applicable—and body changes).
> - Use `--full` to see the complete expected vs actual bodies (with JSON colorization).
> - `--summary` prints just the totals and a per–test-set table, optionally restricted with `-t/--test-sets`.

Check failure on line 408 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L408 

[Google.EnDash] Use an em dash ('—') instead of '–'.
Raw output 
{"message": "[Google.EnDash] Use an em dash ('—') instead of '–'.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 408, "column": 49}}}, "severity": "ERROR"}
> - When `--report-path` is provided, Keploy reads that file directly. Legacy files that contain only a `tests` list are supported.

## [templatize](#templatize)
Expand Down Expand Up @@ -416,7 +436,7 @@
keploy config --generate
```

- `-p, --path string` - Path to the local directory where the Keploy Configuration File will be stored. The default is ".".

Check failure on line 439 in versioned_docs/version-3.0.0/running-keploy/cli-commands.md

View workflow job for this annotation

GitHub Actions / vale

[vale] versioned_docs/version-3.0.0/running-keploy/cli-commands.md#L439 

[Google.Quotes] Commas and periods go inside quotation marks.
Raw output 
{"message": "[Google.Quotes] Commas and periods go inside quotation marks.", "location": {"path": "versioned_docs/version-3.0.0/running-keploy/cli-commands.md", "range": {"start": {"line": 439, "column": 120}}}, "severity": "ERROR"}

```bash
keploy config --generate --path "./config-dir/"
Expand Down
Loading