feat: Update CLI and configuration documentation for new flags and parameters

[officialasishkumar]

What has changed?

This pull request updates the Keploy CLI documentation and configuration file to introduce new replay target selection features, clarify the replay logic, and align flag and config names for consistency. The most important changes are grouped below:

CLI Flag and Behavior Updates

• Updated the test command flags to include new options: --host, --port, --grpc-port, and --base-path. Several existing flags were renamed for consistency (e.g., --apiTimeout → --api-timeout, --containerName → --container-name). Deprecated or replaced flags such as --generateTestReport, --coverage, and --goCoverage were removed or replaced.
• Added documentation for new flags: --host, --port, --grpc-port, and --base-path, including usage examples and explanations for each.

Replay Target Resolution Logic

• Documented the detailed order in which Keploy resolves the replay target for HTTP and gRPC testcases, including how --base-path, replaceWith, --host, and port overrides interact. Added notes on how replaceWith rules are matched and the precedence of test-set-specific over global rules. [1] [2]

Configuration File Enhancements

• Added new fields to the test section of the configuration file: replaceWith, host, port, grpcPort, basePath, mocking, and disableMockUpload. Provided detailed documentation and YAML examples for the new fields, especially for replaceWith and replay target resolution. [1] [2]

Naming and Defaults Consistency

• Renamed coverage to skipCoverage for clarity and updated the documentation to reflect this change. Updated the default container name from keploy-v2 to keploy-v3. [1] [2]

These changes improve the flexibility and clarity of Keploy's replay target configuration, making it easier for users to control and understand how testcases are replayed.

This PR Resolves #(issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue).
• New feature (non-breaking change which adds functionality).
• Breaking change (fix or feature that would cause existing functionality to not work as expected).
• Documentation update (if none of the other choices apply).

How Has This Been Tested?

Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.

Checklist:

• My code follows the style guidelines of this project.
• I have performed a self-review of my own code.

[kilo-code-bot]

Kilo Code Review could not run — your account is out of credits.

Add credits at app.kilo.ai to enable reviews on this change.

[Copilot]

Pull request overview

Updates the Keploy v3 configuration-file documentation to reflect new replay target selection options and revised test configuration fields, aiming to align docs with the updated CLI/config behavior.

Changes:

• Extends the sample keploy.yaml with new test fields (e.g., ignoredTests, replaceWith, host/port/grpcPort, basePath, mocking, disableMockUpload) and updates the default keployContainer name.
• Adds detailed documentation for replaceWith and a step-by-step “Replay Target Resolution Order”.
• Renames/clarifies coverage configuration documentation (skipCoverage) and fixes formatting around bypassRules.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.