Document osb shorthand command

[drtootsie]

Addresses #744

Changes

Add documentation for the osb shorthand command that can be used as an alias for opensearch-benchmark.

Documentation Added

• Example showing both full and shorthand commands
• Updated help command reference to include osb --help

Example

# Full command
opensearch-benchmark execute-test --workload=geonames

# Shorthand equivalent
osb execute-test --workload=geonames

This makes it easier and faster for users to invoke OpenSearch Benchmark.

[coderabbitai]

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Updated README.md to document the shorthand command "osb" for opensearch-benchmark. Added a new "Shorthand Command" section in Quick Start with usage examples and updated the Quick Help reference to include both the full and shorthand command syntax.

Changes

Cohort / File(s)	Summary
Documentation README.md	Added "Shorthand Command" section in Quick Start demonstrating osb as shorthand for opensearch-benchmark, including code examples. Updated Quick Help reference to mention both full and shorthand command availability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and accurately summarizes the main change: documenting the osb shorthand command in the README.
Description check	✅ Passed	The description is directly related to the changeset, providing clear context about documenting the osb shorthand command and referencing the related issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection	✅ Passed	✅ No merge conflicts detected when merging into main

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[OVI3D0]

In OSB 2.0, we replaced execute-test and test-execution with run and test-run respectively. Can you just update execute-test to run here?

[OVI3D0]

thanks @drtootsie ! Just left one comment :)

[github-actions]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🧪 No relevant tests

🔒 No security concerns identified

✅ No TODO sections

🔀 No multiple PR themes

⚡ Recommended focus areas for review Numbering Gap After adding step 5, the next item jumps to step 6, which may indicate a missing step or a numbering inconsistency in the release checklist. Verify that no step was accidentally skipped between the original step 5 and the new step 5. 5. Run `opensearch-benchmark list workloads` (or `osb list workloads`) 6. Run a basic workload on Linux and MacOS: `opensearch-benchmark run --workload pmc --test-mode`

[OVI3D0]

hey @drtootsie , looks like this line and line 41 still say execute-test :p