Skip to content

Commit

Permalink
docs: Add missing arguments in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
en-milie committed Jan 24, 2025
1 parent ad4ed35 commit 5cf7c22
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 2 additions & 0 deletions docs/commands-and-arguments/arguments.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,8 @@ You can get the full list of arguments by running `cats -h`. Below is a short de
- `--stopAfterErrors=<stopAfterErrors>` Number of errors after which the continuous fuzzing will stop running. Errors are defined as conditions matching the given match arguments. Only available in `cats random` sub-command.
- `--stopAfterMutations=<stopAfterMutations>` Number of mutations (test cases) after which the continuous fuzzing will stop running. Only available in `cats random` sub-command.
- `--stopAfterTimeInSec=<stopAfterTimeInSec>` Amount of time in seconds for how long the continuous fuzzing will run before stopping. Only available in `cats random` sub-command.
- `--pathsRunOrder=<pathsOrderFile>` A file with the order in which the paths will be executed. The paths are on each line. The order from file will drive the execution order
- `--errorLeaksKeywords=<errorLeaksKeywords>` A properties file with error leaks keywords that will be used when processing responses to detect potential error leaks. If one of these keyword is found, the test case will be marked as error

:::tip
When you want to skip fuzzing entirely for a specific JSON object or specific fields you must prefix the field name from the `--skipFields` argument with `!`.
Expand Down
3 changes: 2 additions & 1 deletion docs/commands-and-arguments/sub-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ All available subcommands are listed below:

- `cats replay "test1,test2"` will replay the given tests `test1` and `test2`

- `cats fuzz` will fuzz based on a given request template, rather than an OpenAPI contract
- `cats template` will fuzz based on a given request template, rather than an OpenAPI contract

- `cats run` will run functional and targeted security tests written in the CATS YAML format

Expand All @@ -41,6 +41,7 @@ All available subcommands are listed below:

- `cats random` does continuous fuzzing based on mutators until a certain stop condition is hit


:::tip
Each sub-command has its own help. You can run `cats sub-command -h` to check all available arguments: `cats fuzz -h`.
:::

0 comments on commit 5cf7c22

Please sign in to comment.