Documenation has some incorrect and missing information

[steve1337]

Problem

Some information in the https://github.com/karatelabs/karate-cli/blob/main/README.md is not correct

Issues

1. Configuration

❌ It says

Global config: ~/.karate/karate-cli.json
Project config: .karate/karate.json

✅ But should be

Global config: ~/.karate/karate-cli.json
Project config: .karate/karate-cli.json

2. Commands

❌ It is

Command	Description
karate setup	Interactive setup wizard
karate setup --all	Non-interactive setup (JAR + JRE)
karate setup --item jar	Install JAR only (use system JRE)
karate setup --item jre	Install JRE only
karate update	Check for and install updates
karate update --all	Update all components non-interactively
karate doctor	System diagnostics
karate doctor --json	JSON output (for CI/scripts)
karate version	Show version info

To update the CLI itself, re-run the install command.

All other commands pass through to Karate:

karate test.feature           # Run tests
karate -t @smoke test.feature # Run with tags
karate mock server.js         # Start mock server

✅ But IMO should include

Command	Description
karate setup	Interactive setup wizard
karate setup --all	Non-interactive setup (JAR + JRE)
karate setup --item jar	Install JAR only (use system JRE)
karate setup --item jre	Install JRE only
karate update	Check for and install updates to LATEST version
karate update --all	Update all components non-interactively to LATEST version
karate doctor	System diagnostics
karate doctor --json	JSON output (for CI/scripts)
karate version	Show version info

The setup command will install pinned version in the config file or LATEST if not specified.
The setup command has an additional option --force to force a re-download of JAR and / or JRE.

To update the CLI itself, re-run the install command.

All other commands pass through to Karate:

karate test.feature           # Run tests
karate ./tests                # Run all tests in directory
karate -t @smoke test.feature # Run with tags
karate mock server.js         # Start mock server

[steve1337]

The additional information would have saved me more than 1 hour of my time.

I only manged to figure this out by trial and error (the config file name) as well as asking cursor to read the files from the repo and explain the missing information about the commands (e.g. how to make sure to actually use the pinned version from the config)