Skip to content

Commit 5f43414

Browse files
committed
feat(cli): Fix casing for some arguments
1 parent 9226d57 commit 5f43414

5 files changed

Lines changed: 12 additions & 12 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,11 @@ docker run --rm -v $(pwd):/workspace dochia/cli test -c /workspace/api.yaml -s h
8585

8686
```bash
8787
# Download latest release for your platform
88-
wget https://github.com/dochia-dev/dochia-cli/releases/latest/dochia-xxx.tar.gz
89-
tar -xzf dochia-xxx.tar.gz
88+
wget https://github.com/dochia-dev/dochia-cli/releases/latest/dochia_platform_version.tar.gz -O dochia.tar.gz
89+
tar -xzf dochia.tar.gz
9090
chmod +x dochia
9191
sudo mv dochia /usr/local/bin/dochia
92-
rm dochia-xxx.tar.gz
92+
rm dochia.tar.gz
9393

9494
# Verify insallation
9595
dochia --version

src/main/java/dev/dochia/cli/core/args/FilesArguments.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ public class FilesArguments {
9494
@Setter
9595
Map<String, Object> refDataArguments;
9696

97-
@CommandLine.Option(names = {"--mutators", "-m"}, paramLabel = "<file>",
98-
description = "A folder containing custom mutators. This argument is taken in consideration only when using the `dochia random` sub-command")
97+
@CommandLine.Option(names = {"--mutators", "-M"}, paramLabel = "<folder>",
98+
description = "A folder containing custom mutators. This argument is taken in consideration only when using the `dochia fuzz` sub-command")
9999
@Getter
100100
@Setter
101101
private File mutatorsFolder;

src/main/java/dev/dochia/cli/core/args/ReportingArguments.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class ReportingArguments {
1919
private final PrettyLogger logger = PrettyLoggerFactory.getLogger(ReportingArguments.class);
2020

2121
@CommandLine.Option(names = {"--execution-stats"},
22-
description = "Print a summary of execution times for each endpoint and HTTP method. By default this will print a summary for each endpoint: max, min and average. Detailed reports can be enabled using @|bold --printDetailedExecutionStatistics|@")
22+
description = "Print a summary of execution times for each endpoint and HTTP method. By default this will print a summary for each endpoint: max, min and average. Detailed reports can be enabled using @|bold --detailed-execution-stats|@")
2323
private boolean printExecutionStatistics;
2424

2525
@CommandLine.Option(names = {"--detailed-execution-stats"},

src/main/java/dev/dochia/cli/core/command/ListCommand.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ static class ListFormats {
310310

311311
static class ListStrategies {
312312
@CommandLine.Option(
313-
names = {"-s", "--fieldsPlaybookStrategies", "fieldsPlaybookStrategies"},
313+
names = {"-s", "--fields-playbookStrategies"},
314314
description = "Display all current registered Fields Fuzzing Strategies",
315315
required = true)
316316
boolean strategies;
@@ -330,7 +330,7 @@ static class ListMutatorsGroup {
330330
boolean mutators;
331331

332332
@CommandLine.Option(
333-
names = {"--cmt", "--customMutatorTypes"},
333+
names = {"--cmt", "--custom-mutator-yypes"},
334334
description = "Display types supported by the Custom Mutator")
335335
boolean customMutatorTypes;
336336
}

src/main/java/dev/dochia/cli/core/command/RandomCommand.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,19 +67,19 @@ public class RandomCommand implements Runnable, CommandLine.IExitCodeGenerator {
6767
@CommandLine.ArgGroup(heading = "%n@|bold,underline Stop Options:|@%n", exclusive = false, multiplicity = "1")
6868
StopArguments stopArguments;
6969

70-
@CommandLine.Option(names = {"--httpMethod", "-X"}, required = true,
70+
@CommandLine.Option(names = {"--http-method", "-X"}, paramLabel = "<method>", required = true,
7171
description = "The HTTP method. Default: @|bold,underline ${DEFAULT-VALUE}|@")
7272
HttpMethod httpMethod = HttpMethod.POST;
7373

74-
@CommandLine.Option(names = {"--contentType"},
74+
@CommandLine.Option(names = {"--content-type"}, paramLabel = "<content-ype>",
7575
description = "A custom mime type if the OpenAPI contract/spec uses content type negotiation versioning")
7676
private String contentType;
77-
@CommandLine.Option(names = {"--oneOfSelection", "--anyOfSelection"},
77+
@CommandLine.Option(names = {"--schema-discriminator"}, paramLabel = "<name=value>",
7878
description = "A @|bold name:value|@ list of discriminator names and values that can be used to filter request payloads when objects use oneOf or anyOf definitions" +
7979
" which result in multiple payloads for a single endpoint and http method")
8080
Map<String, String> xxxOfSelections;
8181

82-
@CommandLine.Option(names = {"--path", "-p"}, required = true,
82+
@CommandLine.Option(names = {"--path", "-p"}, paramLabel = "<path>", required = true,
8383
description = "An API path for continuous fuzzing")
8484
String path;
8585

0 commit comments

Comments
 (0)