Summary
Two README CLI examples do not run against the current Clikt interface: the custom-options example uses camelCase option names and an unsupported Gradle version, while the unit-test example passes a value to a boolean flag.
Reproducer
./gradlew :cli:fatBinary
./cli/projectGenerator generate-project \
--shape rhombus --modules 50 --layers 4 --language both --type jvm \
--classesModule 10 --classesModuleType random \
--typeOfStringResources large --generateUnitTest \
--gradle gradle_8_9 --develocity --versionsFile ./my_versions.yaml
./cli/projectGenerator generate-project \
--shape triangle --layers 5 --modules 100 \
--generate-unit-test true
Expected behavior
README commands use supported option names and values and can be copied into a shell successfully, assuming any referenced input file exists.
Actual behavior
The first command reports multiple unknown camelCase options and rejects gradle_8_9. The second command rejects true as an unexpected positional argument.
Evidence
- JDK: OpenJDK 23.0.2 (Zulu)
- OS: macOS 26.2
- Generator command: README examples under "Generate a project with custom options" and "Generate Unit Test"
- Generated project command: Not reached because CLI parsing fails
- Error excerpt:
Error: no such option --classesModule. (Possible options: --classes-module, --classes-module-type)
Error: no such option --generateUnitTest. Did you mean --generate-unit-test?
Error: no such option --versionsFile. Did you mean --versions-file?
Error: invalid value for --gradle: Unknown Gradle version: gradle_8_9
Error: got unexpected extra argument (true)
Scope
Affected area:
Suggested fix or test
Change the examples to kebab-case options, use a currently supported Gradle value, remove the true argument from --generate-unit-test, and either provide or avoid referencing my_versions.yaml. Add a lightweight documentation smoke test that invokes maintained CLI examples.
Summary
Two README CLI examples do not run against the current Clikt interface: the custom-options example uses camelCase option names and an unsupported Gradle version, while the unit-test example passes a value to a boolean flag.
Reproducer
./gradlew :cli:fatBinary ./cli/projectGenerator generate-project \ --shape rhombus --modules 50 --layers 4 --language both --type jvm \ --classesModule 10 --classesModuleType random \ --typeOfStringResources large --generateUnitTest \ --gradle gradle_8_9 --develocity --versionsFile ./my_versions.yaml ./cli/projectGenerator generate-project \ --shape triangle --layers 5 --modules 100 \ --generate-unit-test trueExpected behavior
README commands use supported option names and values and can be copied into a shell successfully, assuming any referenced input file exists.
Actual behavior
The first command reports multiple unknown camelCase options and rejects
gradle_8_9. The second command rejectstrueas an unexpected positional argument.Evidence
Scope
Affected area:
Suggested fix or test
Change the examples to kebab-case options, use a currently supported Gradle value, remove the
trueargument from--generate-unit-test, and either provide or avoid referencingmy_versions.yaml. Add a lightweight documentation smoke test that invokes maintained CLI examples.