From d97279096a65302c2c39fa30ba99e3788cc2a2c9 Mon Sep 17 00:00:00 2001 From: steve1337 <22643375+steve1337@users.noreply.github.com> Date: Thu, 30 Apr 2026 02:38:10 +0800 Subject: [PATCH] Updates README.md 1. Corrects Configuration path 2. Adds missing information for setup command See: https://github.com/karatelabs/karate-cli/issues/2 --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 50f1625..e2f8f39 100644 --- a/README.md +++ b/README.md @@ -46,18 +46,22 @@ karate doctor | `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 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 the pinned version from the configuration 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: ```bash 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 ``` @@ -65,7 +69,7 @@ karate mock server.js # Start mock server ## Configuration Global config: `~/.karate/karate-cli.json` -Project config: `.karate/karate.json` +Project config: `.karate/karate-cli.json` ```json {